Проверить возможность соединения перед импортом

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос позволяет проверить может ли Яндекс Почта для домена установить соединение с сервером-источником. Для проверки нужно передать настройки сервера-источника (протокол, порт сервера, нужно ли использовать SSL-соединение и др.). Если соединение невозможно, ответ запроса будет содержать ошибку с кодом no_reply.

Запрос следует использовать перед запуском импорта (см. Импортировать один почтовый ящик, Импортировать несколько почтовых ящиков).

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода GET.

GET /api2/admin/import/check_settings?
domain=<имя домена почты>
&method=<протокол сервера>
&server=<имя сервера>
&port=<порт сервера>
&ssl=<использование SSL>

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>

Заголовки:


Название	Описание
PddToken	ПДД-токен.

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.

GET /api2/registrar/import/check_settings?
domain=<имя домена почты>
&method=<протокол сервера>
&server=<имя сервера>
&port=<порт сервера>
&ssl=<использование SSL>

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>

Заголовки:


Название	Описание
PddToken	ПДД-токен.
Authorization	OAuth-токен.

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.

Пример запроса

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'

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

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'

Структура ответа

{
  "domain": "{имя домена}",
  "settings": 
    {
      "method": "{протокол сервера}",
      "server": "{имя сервера}",
      "port": "{порт сервера}",
      "ssl": "{использование SSL}"
    }, 
  "success": "{статус выполнения запроса}"
}

{
  "domain": "{имя домена}", 
  "success": "{статус выполнения запроса}", 
  "error": "{код ошибки}"
}


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`settings`	Объект	Настройки сервера-источника.
`success`	Строка	Статус выполнения запроса. Возможные значения: `ok` — запрос выполнен успешно. `error` — запрос выполнен с ошибкой.
`error`	Строка	Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения: `unknown` — произошел временный сбой или ошибка работы API (повторите запрос позже). `no_token` (`no_domain`, `no_ip` ) — не передан обязательный параметр. `bad_domain` — имя домена не указано или не соответствует RFC. `prohibited` — запрещенное имя домена. `bad_token` (`bad_login`, `bad_passwd`) — передан неверный ПДД-токен (логин, пароль). `no_auth` — не передан заголовок `PddToken`. `not_allowed` — пользователю недоступна данная операция (он не является администратором этого домена). `blocked` — домен заблокирован (например, за спам и т.п.). `occupied` — имя домена используется другим пользователем. `domain_limit_reached` — превышено допустимое количество подключенных доменов (50). `no_reply` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта `settings`
`method`	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
`server`	Строка	Доменное имя или IP-адрес сервера.
`port`	Число	Порт сервера.
`ssl`	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`settings`	Объект	Настройки сервера-источника.
`success`	Строка	Статус выполнения запроса. Возможные значения: `ok` — запрос выполнен успешно. `error` — запрос выполнен с ошибкой.
`error`	Строка	Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения: `unknown` — произошел временный сбой или ошибка работы API (повторите запрос позже). `no_token` (`no_domain`, `no_ip` ) — не передан обязательный параметр. `bad_domain` — имя домена не указано или не соответствует RFC. `prohibited` — запрещенное имя домена. `bad_token` (`bad_login`, `bad_passwd`) — передан неверный ПДД-токен (логин, пароль). `no_auth` — не передан заголовок `PddToken`. `not_allowed` — пользователю недоступна данная операция (он не является администратором этого домена). `blocked` — домен заблокирован (например, за спам и т.п.). `occupied` — имя домена используется другим пользователем. `domain_limit_reached` — превышено допустимое количество подключенных доменов (50). `no_reply` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта `settings`
`method`	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
`server`	Строка	Доменное имя или IP-адрес сервера.
`port`	Число	Порт сервера.
`ssl`	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.