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

Migrates existing email data to LINE WORKS Mail using IMAP.

Note

  • Only a successful login with the specified information to the IMAP server can lead to migration.
  • Depending on the IMAP server status or your network condition, email migration may fail.
  • If email migration fails, email data is restored to the previous state.
  • If you attempt to migrate email messages with the account for which email migration is already completed, the same messages may be saved again.
  • Because a login to the IMAP server is re-attempted on failure, the timeout value must be greater than 10 seconds.
  • Results of email migration using IMAP are sent via email.

Authorization

oauth2

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

Scope

mail

HTTP Request

POSThttps://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 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
host string 

IMAP address


required
minLength : 1 
port integer 

IMAP port


required
format : int32 
importedEmail string 

IMAP email address (RFC822 format)


required
minLength : 1
format : email 
password string 

IMAP password


required
minLength : 1 
useSsl boolean 

Indicates whether to use SSL.


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