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

Gets the status of IMAP email migration for a specified email account.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • User ID
  • Login ID (email)
  • Me

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
startedTime string 

Migration start time


required 
totalMailCount integer 

Number of migrated messages


required 
port integer 

IMAP port


required 
completedTime string 

Migration end time

 
importedEmail string 

IMAP email address

 
useSsl boolean 

Indicates whether to use SSL.


required 
status string 

Migration status

  • Before migration: Migration is not yet started.
  • In progress: Migration is in progress.
  • Completed: Migration is 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