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).

  1. Request syntax
  2. Request example
  3. Response structure

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:

Name Description
PddToken

PDD token.
Name Description
PddToken

PDD token.

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:

  • imap

  • imap4

  • pop

  • pop3
ssl String

Use of SSL.

Possible values:
  • yes — SSL connection required.
  • no — SSL should not be used.
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:

  • imap

  • imap4

  • pop

  • pop3
ssl String

Use of SSL.

Possible values:
  • yes — SSL connection required.
  • no — SSL should not be used.

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
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'

Response structure

{
  "domain": "{domain name}",
  "settings":
    {
      "method": "{server protocol}",
      "server": "{server name}",
      "port": "{server port}",
      "ssl": "{SSL usage}"
    },
  "success": "{status of request execution}"
}
Name Type of value Description
domain String

Name of the domain.
settings Object

Server source settings.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.
Keys for the settings object
method String

Server protocol.

Possible values:

  • imap

  • imap4

  • pop

  • pop3
server String

Server's domain name or IP address.
port Integer

Server port.
ssl String

Use of SSL.

Possible values:
  • yes — SSL connection required.
  • no — SSL should not be used.
Name Type of value Description
domain String

Name of the domain.
settings Object

Server source settings.
success String

Status of request execution.

Possible values:
  • ok — Request executed successfully.
  • error — Request executed with error.
error String

Error code.

Included in the response if the request resulted in an error.

Possible values:
  • unknown — A temporary failure or API error occurred (repeat the request again later).
  • no_token (no_domain, no_ip ) — A mandatory parameter was omitted.
  • bad_domain — The domain name was not specified or does not conform to the RFC.
  • prohibited — A forbidden domain name.
  • bad_token (bad_login, bad_passwd) — An invalid PDD token (or username/password) was passed.
  • no_auth — The PddToken header was omitted.
  • not_allowed — This operation is not allowed for this user (the user is not the domain administrator).
  • blocked — Blocked domain (for example, due to spam and so on).
  • occupied — The domain name is in use by another user.
  • domain_limit_reached — Exceeded the acceptable number of connected domains (50).
  • no_reply — Yandex.Mail for Domain cannot connect to the server source for the import.
Keys for the settings object
method String

Server protocol.

Possible values:

  • imap

  • imap4

  • pop

  • pop3
server String

Server's domain name or IP address.
port Integer

Server port.
ssl String

Use of SSL.

Possible values:
  • yes — SSL connection required.
  • no — SSL should not be used.