メール転送設定

メンバーの受信メールを、指定したメールアドレスへ自動転送するよう設定します。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API_ID}/organization/v2/domains/{domainId}/mail/forwarding

HTTP Method

PUT (Content-Type: application/json; charset=UTF-8)

Path Parameters

パラメータ	タイプ	上限	必須	説明
domainId	String		Y	ドメイン ID

Request Body

プロパティ	タイプ	上限	必須	説明
forwardingInfos[]	List	10	Y	転送設定情報
forwardingInfos[].externalKey	String		Y	メンバーの ExternalKey
forwardingInfos[].email	String		Y	転送先のメールアドレスこの値が空の場合は、既存の転送設定が解除されます。
forwardingInfos[].originalSaveYn	String		Y	"Y" 固定

Request Example

{
    "forwardingInfos": [
        {
            "externalKey": "ex001",
            "email": "ex001@example.com",
            "originalSaveYn": "Y"
        },
        {
            "externalKey": "ex002",
            "email": "ex002@example.com",
            "originalSaveYn": "N"
        }
    ]
}

Response

プロパティ	タイプ	必須	説明
success[]	List	N	成功したメール転送設定
success[].externalKey	String	Y	メンバーの ExternalKey
success[].email	String	Y	転送するメールアドレス
success[].originalSaveYn	String	Y	原本を保存するかどうか
fail[]	List	N	失敗したメール転送情報
fail[].externalKey	String	Y	メンバーの ExternalKey
fail[].email	String	Y	転送するメールアドレス
fail[].originalSaveYn	String	Y	原本を保存するかどうか
fail[].failReason	String	Y	失敗の原因

Response Example

{
    "success": [
        {
            "externalKey": "ex002",
            "email": "ex002@example.com",
            "originalSaveYn": "Y"
        }
    ],
    "fail": [
        {
            "externalKey": "ex001",
            "email": "ex001@example.com",
            "originalSaveYn": "Y"
            "failReason": "cannot find a target member."
        }
    ]  
}

Error Code

呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST API エラーコードを参照してください。

LINE WORKS Developers