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

指定ユーザーの IMAP を用いたメール移行状況を取得する。

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

GEThttps://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 

Response

HTTP 200

OK

PropertyTypeDescription
startedTime string 

移行開始時刻


required 
totalMailCount integer 

マイグレーションのメール数


required 
port integer 

IMAP ポート


required 
completedTime string 

移行完了時刻

 
importedEmail string 

IMAP メールアドレス

 
useSsl boolean 

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


required 
status string 

移行ステータス

  • Before migration : 開始前
  • In progress : 進行中
  • Completed : 完了

required 

Response Example

example

1{2  "startedTime": "2024-03-12 13:43:58",3  "totalMailCount": 0,4  "port": 993,5  "completedTime": "",6  "importedEmail": "user1@example.com",7  "email": "",8  "useSsl": true,9  "status": "In progress"10}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 408

Request Timeout