メール移行
指定した EML ファイルを対象メンバーのメールフォルダにアップロードします。
注意
- メール移行 API を呼び出す前に必ず "メール移行の開始 API" を呼び出す必要があります。
- tenantId ごとに最大 20 名まで同時に移行することができます。
- 指定されたメールフォルダが存在しない場合、受信メールフォルダに保存されます。
API の種類
サービス API
Request URL
https://apis.worksmobile.com/r/{API ID}/mail/v2/saveEml
HTTP Method
POST(Content-Type: multipart/form-data; boundary="$boundary”; charset=UTF-8)
Request
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| targetMemberEmail | String | Y | 対象メンバーのメールアドレス |
| file | MultipartFile | Y | アップロードする EML ファイル |
| folderSN | Integer | N | EML ファイルをアップロードするフォルダ。 既定値は 0 で、受信メールフォルダに保存されます。 |
| isRead | Boolean | N | アップロードするメールの既読設定 ● true: 既読(既定値) ● false: 未読 |
Response
呼び出しに成功すると HTTP Status コード 200 のみを返します。レスポンス内容は含みません。
| プロパティ | タイプ | 必須 | 説明 |
|---|---|---|---|
| savedMailSN | Integer | Y | EMLファイルを保存するメールのシリアルナンバー |
Response Example
{"savedMailSN":437953}
Error
呼び出しに失敗すると、HTTP Status と以下のエラー情報を返します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| code | String | Error Code |
| message | String | Error Message |
| HTTP Status | Error Code | 説明 |
|---|---|---|
| 400 | BAD_REQUEST | startSaveEml API が呼び出されていない |
| 409 | SC_CONFLICT | tenantId ごとの移行数の超過 |
| 500 | SYSTEM_ERROR | 内部サーバーエラー |
Error Example
{
"code": "SC_CONFLICT",
"message": "The number of migrations by tenantId exceeded.",
"domain": "mail"
}