POST/users/{userId}/mail/migration/pop3

POP3 を利用して、既存のメールを LINE WORKS メールへ移行する。

Authorization

oauth2

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

Scope

mail

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/mail/migration/pop3

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
pop3Id string 

POP3 ID


required
minLength : 1 
pop3Address string 

POP3 アドレス


required
minLength : 1 
pop3Password string 

POP3 パスワード


required
minLength : 1 
pop3Port integer 

POP3 ポート


required
format : int32 
isNewFolder boolean 

保存先メールフォルダの作成フラグ

  • true : 作成
  • false : 作成しない (既定)

default : false 
newFolderName string 

新規作成する保存先フォルダの名前
isNewFolder が true の場合は必須。


minLength : 1
maxLength : 100 

Request Example

example

1{2  "pop3Id": "pop3@example.com",3  "pop3Address": "pop3.example.com",4  "pop3Password": "Pwd",5  "pop3Port": 110,6  "isNewFolder": true,7  "newFolderName": "POP3MigrationFolder"8}

Response

HTTP 202

Accepted

HTTP 400

Bad Request