Документация
API Яндекс.Почты для домена

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

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

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

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

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

GET /api2/admin/import/check_settings?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена почты.

]no-highlight]
=<имя домена почты> &method
[no-highlight[

Тип

Строка

Значение

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
=<протокол сервера> &server
[no-highlight[

Тип

Строка

Значение

Доменное имя или IP-адрес сервера.

]no-highlight]
=<имя сервера> &port
[no-highlight[

Тип

Число

Значение

Порт сервера.

]no-highlight]
=<порт сервера> &ssl
[no-highlight[

Тип

Строка

Значение

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
=<использование SSL> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен>

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Параметры:

ПараметрТипЗначение
Обязательные
domain Строка

Имя домена почты.

server Строка

Доменное имя или IP-адрес сервера.

port Число

Порт сервера.

method Строка

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

ssl Строка

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

GET /api2/registrar/import/check_settings?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена почты.

]no-highlight]
=<имя домена почты> &method
[no-highlight[

Тип

Строка

Значение

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
=<протокол сервера> &server
[no-highlight[

Тип

Строка

Значение

Доменное имя или IP-адрес сервера.

]no-highlight]
=<имя сервера> &port
[no-highlight[

Тип

Число

Значение

Порт сервера.

]no-highlight]
=<порт сервера> &ssl
[no-highlight[

Тип

Строка

Значение

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
=<использование SSL> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен>

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

ПараметрТипЗначение
Обязательные
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
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "settings
[no-highlight[

Тип значения

Объект

Описание

Настройки сервера-источника.

]no-highlight]
": { "method
[no-highlight[

Тип значения

Строка

Описание

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
": "{протокол сервера}", "server
[no-highlight[

Тип значения

Строка

Описание

Доменное имя или IP-адрес сервера.

]no-highlight]
": "{имя сервера}", "port
[no-highlight[

Тип значения

Число

Описание

Порт сервера.

]no-highlight]
": "{порт сервера}", "ssl
[no-highlight[

Тип значения

Строка

Описание

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
": "{использование SSL}" }, "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • 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 — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
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-соединение.