メールフォルダ削除

指定したメールフォルダを削除します。

注意

削除されたフォルダ内にあるメールは、環境設定の設定値にあわせて即時削除もしくはゴミ箱に移動されます。

フォルダが階層化されている場合、上位のメールフォルダを削除すると下位メールフォルダも同時に削除されます。

システムメールフォルダ(folderSN が 100 以下のフォルダ)は削除できません。

削除するメールフォルダが存在しない場合も成功 (200) が返ります。

API の種類

サービス API

Request URL

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

HTTP Method

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

Request

パラメータ	タイプ	必須	説明
folderSN	String	Y	メールフォルダのシリアルナンバー

Request Example

https://apis.worksmobile.com/r/{API ID}/mail/v2/removeFolder?folderSN=123

Response

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

Error

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

プロパティ	タイプ	説明
code	String	Error Code
message	String	Error Message

HTTP Status	Error Code	説明
400	INVALID_PARAMETER	リクエスト値が不適切
403	FORBIDDEN	システムメールフォルダは削除不可
500	SYSTEM_ERROR	内部サーバーエラー

Error Example

{
    "code": "INVALID_PARAMETER",
    "message": "Invalid parameter, Please check folderSN",
    "domain": "mail"
}

LINE WORKS Developers