Import a single mailbox
Connection settings for the server source that Yandex.Mail for Domain should use. You can check the validity of the settings using a separate request.
If the connection cannot be made using the settings you pass, Yandex.Mail for Domain will keep repeating the connection attempt for a long time without returning errors.
- The username and password of the mailbox to import.
- The username must:
must contain only Latin letters, numbers, dashes, or dots.
start with a letter, end with a letter or number, and be no longer than 30 characters.
- The password must:
contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.”
be different from the username.
Request syntax
The request should be sent over the HTTPS protocol using the POST method.
POST /api2/admin/import/start_one_import
Host: pddimp.yandex.ru
PddToken: <PDD token>
...
domain=<mail domain name>
&method=<server protocol>
&server=<server name>
&port=<server port>
&ssl=<SSL usage>
&ext-login=<username on source server>
&ext-passwd=<password on source server>
[&int-login=<username for Yandex.Mail for Domain>]
[&int-passwd=<password for Yandex.Mail for Domain>]
Headers:
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the mail domain. |
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
method | String | Server protocol. Possible values:
|
ssl | String | Use of SSL. Possible values:
|
ext-login | String | Username on the server source. |
ext-passwd | String | Password on the server source. |
Optional | ||
int-login | String | Username for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-login username does not meet Yandex requirements:
|
int-passwd | String | Password for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-passwd password does not meet Yandex requirements:
|
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the mail domain. |
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
method | String | Server protocol. Possible values:
|
ssl | String | Use of SSL. Possible values:
|
ext-login | String | Username on the server source. |
ext-passwd | String | Password on the server source. |
Optional | ||
int-login | String | Username for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-login username does not meet Yandex requirements:
|
int-passwd | String | Password for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-passwd password does not meet Yandex requirements:
|
POST /api2/registrar/import/start_one_import
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
...
domain=<mail domain name>
&method=<server protocol>
&server=<server name>
&port=<server port>
&ssl=<SSL usage>
&ext-login=<username on source server>
&ext-passwd=<password on source server>
[&int-login=<username for Yandex.Mail for Domain>]
[&int-passwd=<password for Yandex.Mail for Domain>]
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
Parameters:
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
method | String | Server protocol. Possible values:
|
ssl | String | Use of SSL. Possible values:
|
ext-login | String | Username on the server source. |
ext-passwd | String | Password on the server source. |
Optional | ||
int-login | String | Username for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-login username does not meet Yandex requirements:
|
int-passwd | String | Password for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-passwd password does not meet Yandex requirements:
|
Parameter | Type | Value |
---|---|---|
Mandatory | ||
domain | String | Name of the domain. |
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
method | String | Server protocol. Possible values:
|
ssl | String | Use of SSL. Possible values:
|
ext-login | String | Username on the server source. |
ext-passwd | String | Password on the server source. |
Optional | ||
int-login | String | Username for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-login username does not meet Yandex requirements:
|
int-passwd | String | Password for authenticating on Yandex.Mail for Domain. The parameter should be passesd if the ext-passwd password does not meet Yandex requirements:
|
Request example
POST /api2/admin/import/start_one_import HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890' 'https://pddimp.yandex.ru/api2/admin/import/start_one_import'
POST /api2/admin/import/start_one_import HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890' 'https://pddimp.yandex.ru/api2/admin/import/start_one_import'
Response structure
{
"domain": "{mail domain name}",
"settings":
{
"method": "{server protocol}",
"server": "{server name}",
"port": "{server port}",
"ssl": "{SSL usage}"
},
"import_list":
[
"external_login": "{username on source server}",
"external_password": "{password on source server}",
"internal_login": "{username on Yandex.Mail for Domain}",
"internal_password": "{password on Yandex.Mail for Domain}",
"started": "{ready to start import}"
]
"success": "{status of request execution}"
}
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
settings | Object | Server source settings. |
import_list | Array | Authentication data. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for the settings object | ||
method | String | Server protocol. Possible values:
|
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
ssl | String | Use of SSL. Possible values:
|
Keys for the import_list array | ||
external_login | String | Username on the server source. |
external_password | String | Password on the server source. |
internal_login | String | Username for authenticating on Yandex.Mail for Domain. |
internal_password | String | Password for authenticating on Yandex.Mail for Domain. |
started | String | Ready to start importing. Possible values:
|
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
settings | Object | Server source settings. |
import_list | Array | Authentication data. |
success | String | Status of request execution. Possible values:
|
error | String | Error code. Included in the response if the request resulted in an error. Possible values:
|
Keys for the settings object | ||
method | String | Server protocol. Possible values:
|
server | String | Server's domain name or IP address. |
port | Integer | Server port. |
ssl | String | Use of SSL. Possible values:
|
Keys for the import_list array | ||
external_login | String | Username on the server source. |
external_password | String | Password on the server source. |
internal_login | String | Username for authenticating on Yandex.Mail for Domain. |
internal_password | String | Password for authenticating on Yandex.Mail for Domain. |
started | String | Ready to start importing. Possible values:
|