Check connection before importing
This request is used for checking whether Yandex.Mail for Domain can connect to the server source. To check the connection, you need to pass the settings of the server source (protocol, server port, whether to use SSL, and so on). If the connection can't be established, the response to the request will contain an error with the code no_reply
.
This request should be used before launching an import (see Import a single mailbox and Import multiple mailboxes).
Request syntax
The request should be sent over the HTTPS protocol using the GET method.
GET /api2/admin/import/check_settings?
domain=<mail domain name>
&method=<server protocol>
&server=<server name>
&port=<server port>
&ssl=<SSL usage>
Host: pddimp.yandex.ru
PddToken: <PDD token>
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:
|
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:
|
GET /api2/registrar/import/check_settings?
domain=<mail domain name>
&method=<server protocol>
&server=<server name>
&port=<server port>
&ssl=<SSL usage>
Host: pddimp.yandex.ru
PddToken: <PDD token>
Authorization: OAuth <OAuth token>
Headers:
Name | Description |
---|---|
PddToken | |
Authorization |
Name | Description |
---|---|
PddToken | |
Authorization |
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:
|
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:
|
Request example
GET /api2/admin/import/check_settings?domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_settings?domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no'
GET /api2/admin/import/check_settings?domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_settings?domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no'
Response structure
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
settings | Object | Server source settings. |
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:
|
Name | Type of value | Description |
---|---|---|
domain | String | Name of the domain. |
settings | Object | Server source settings. |
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:
|