POST/users/{userId}/mail/settings/forwarding

メール転送設定を登録する。
受信したメールは指定したメールアドレスに転送される。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

mail

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/mail/settings/forwarding

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • 自身 ("me")

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
email string 

メールアドレス (RFC822 フォーマット)


required
minLength : 1
format : email 
isSaveOriginalMail boolean 

原本メールの保存フラグ

  • true : 保存 (既定)
  • false : 保存しない (ゴミ箱へ移動)

default : true 

Request Example

example

1{2  "email": "ex001@example.com",3  "isSaveOriginalMail": false4}

Response

HTTP 201

Created

HTTP 400

Bad Request

HTTP 401

Unauthorized