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

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

  • 指定したログイン情報で IMAP サーバーと正常に接続してログインできた場合のみ成功として処理され、移行が行われる。
  • IMAP サーバーの状態やネットワークの状況により、メールの移行が失敗する可能性がある。
  • メールの移行に失敗すると、移行操作前の状態に復元される。
  • メールの移行が完了した後に同一アカウントで再度メール移行を実行した場合、メールが重複して保存される可能性がある。
  • IMAP サーバーへのログインに失敗した際の再接続を考慮して、timeout の値は 10 秒以上である必要がある。
  • IMAP メールの移行結果は、LINE WORKS メールで通知される。

Authorization

oauth2

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

Scope

mail

HTTP Request

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

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

IMAP アドレス


required
minLength : 1 
port integer 

IMAP ポート


required
format : int32 
importedEmail string 

IMAP メールアドレス


required
minLength : 1
format : email 
password string 

IMAP パスワード


required
minLength : 1 
useSsl boolean 

セキュリティ接続使用フラグ


default : false 

Request Example

example

1{2  "host": "imap.example.com",3  "port": 993,4  "importedEmail": "user1@example.com",5  "password": "test",6  "useSsl": true7}

Response

HTTP 202

Accepted

HTTP 400

Bad Request