メールフォルダ追加

メールフォルダを追加します。

サービス API ではログインしたメンバーにメールフォルダを追加します。サーバー API では、指定したメンバーにメールフォルダを追加します。

API の種類

サービス API、サーバー API

Request URL

サービス API: https://apis.worksmobile.com/r/{API ID}/mail/v2/addFolder

サーバー API: https://apis.worksmobile.com/r/{API ID}/mail/v2/addFolderServer

HTTP Method

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

Request

サービスAPI

パラメータ	タイプ	必須	説明
folderName	String	Y	メールフォルダ名

サーバーAPI

パラメータ	タイプ	必須	説明
folderName	String	Y	メールフォルダ名
targetMemberEmail	String	Y(サーバー API のみ)	LINE WORKS メールアドレス (入力したメンバーのメールフォルダが作成される)

Response

API呼び出しに成功するとHTTP Status コード 200 を返し、応答内容は JSON 形式で返します。

プロパティ	タイプ	必須	説明
folderName	String	Y	追加されたメールフォルダ名
folderSN	Integer	Y	追加されたメールフォルダのシリアルナンバー

Response Example

{"folderName":"追加されたメールフォルダ名","folderSN":101}

Error

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

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

HTTP ステータス	エラーコード	説明
400	BAD_REQUEST	メールアドレスが存在しない
400	INVALID_PARAMETER	パラメーターエラー
409	DUPLICATE_FOLDERNAME	同じメールフォルダ名が存在する
409	LIMIT_EXCEEDED	メールフォルダ数超過
500	SYSTEM_ERROR	内部エラー

Error Example

{
    "code": "DUPLICATE_FOLDERNAME",
    "message": "It is already existing mailbox.",
    "domain": "mail"
}