メールフォルダ名変更

    指定したメールフォルダの名前を変更します。

    注意

    • システムフォルダ(folderSNが100以下のフォルダ)は名前を変更できません。
    • 階層化されている下位フォルダの名前変更を行う場合には、階層構造を維持するために上位フォルダを含めて名前を指定してください。
    • 例) 以下のようなフォルダ構造で下位フォルダを ChildFolder2 に変更する場合、folderName を "ParentFolder/ChildFolder2" のように指定します。
      ParentFolder
       ChildFolder
      

    API の種類

    サービス API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/mail/v2/modifyFolder

    HTTP Method

    PUT(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)

    Request

    パラメータ タイプ 必須 説明
    folderSN String Y メールフォルダのシリアルナンバー
    folderName String Y 変更後のフォルダ名
    最大20文字。20文字を超えた部分は無視されます。

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/modifyFolder?folderSN=1004&folderName=sample
    

    Response

    呼び出しに成功すると HTTP Status コード 200 のみを返します。レスポンス内容は含みません。

    Error

    呼び出しに失敗すると、HTTP Status と以下のエラー情報を返します。

    プロパティ タイプ 説明
    code String Error Code
    message String Error Message
    Http Status Error Code 説明
    400 INVALID_PARAMETER リクエスト値が不適切
    403 SYSTEM_FOLDER システムメールフォルダは変更不可
    404 NOT_EXIST_FOLDERSN FOLDERSN が存在しない
    409 DUPLICATE_FOLDERNAME 同じメールフォルダ名が存在する
    500 SYSTEM_ERROR 内部サーバーエラー
    Error Example
    {
        "code": "SYSTEM_FOLDER",
        "domain": "mail",
        "message": "System folders cannot be changed."
    }