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

Получить состояние импорта

Запрос позволяет получить информацию о состоянии импорта.

Если импорт остановлен из-за большого количества ошибок, ответ может получиться многостраничным. Чтобы получать ответ постранично, нужно с помощью параметров запроса указать номер страницы и количество почтовых ящиков на каждой из них.

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

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

GET /api2/admin/import/check_imports?
[page
[no-highlight[

Тип

Число

Значение

Номер страницы ответа. Значение по умолчанию — 1.

Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным.

]no-highlight]
=<номер страницы ответа>] [on_page
[no-highlight[

Тип

Число

Значение

Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10.

Параметр может понадобиться, если ответ содержит большое количество ошибок.

]no-highlight]
=<количество почтовых ящиков на каждой странице ответа>] Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

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

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

Необязательные
page Число

Номер страницы ответа. Значение по умолчанию — 1.

Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным.

on_page Число

Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10.

Параметр может понадобиться, если ответ содержит большое количество ошибок.

GET /api2/registrar/import/check_imports?
[page
[no-highlight[

Тип

Число

Значение

Номер страницы ответа. Значение по умолчанию — 1.

Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным.

]no-highlight]
=<номер страницы ответа>] [on_page
[no-highlight[

Тип

Число

Значение

Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10.

Параметр может понадобиться, если ответ содержит большое количество ошибок.

]no-highlight]
=<количество почтовых ящиков на каждой странице ответа>] Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

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

Описание

OAuth-токен.

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

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена>

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Имя домена.

Необязательные
page Число

Номер страницы ответа. Значение по умолчанию — 1.

Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным.

on_page Число

Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10.

Параметр может понадобиться, если ответ содержит большое количество ошибок.

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

GET  /api2/admin/import/check_imports HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_imports?domain=domain.com'
GET  /api2/admin/import/check_imports HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_imports?domain=domain.com'

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

{
  "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}" }, "import
[no-highlight[

Тип значения

Объект

Описание

Информация об импорте.

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

Тип значения

Строка

Описание

Состояние импорта.

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

  • task_just_created — запрос на импорт принят, но процесс пока не запущен.
  • paused — импорт временно приостановлен, чтобы дать возможность обработать другие запросы на импорт (возникает при обработке запроса с большим количеством почтовых ящиков).
  • in_progress — импорт запущен.
  • paused_cause_of_error — импорт временно остановлен из-за ошибки, не связанной с правильностью формирования запроса (например, сервер отказал в соединении).
  • failed — импорт остановлен из-за ошибки, связанной с формированием запроса на импорт (например, неверный логин и пароль и т.д.).
  • done — импорт завершен успешно.
  • removed — импорт отменен пользователем.

]no-highlight]
": "{состояние импорта}", "total_box_count
[no-highlight[

Тип значения

Число

Описание

Количество почтовых ящиков, которые были отправлены на импорт.

]no-highlight]
": "{количество отправленных на импорт почтовых ящиков}", "done_box_count
[no-highlight[

Тип значения

Число

Описание

Количество почтовых ящиков, импорт которых был завершен успешно.

]no-highlight]
": "{количество успешно импортированных почтовых ящиков}", "complete_box_count
[no-highlight[

Тип значения

Число

Описание

Количество почтовых ящиков, импорт которых был завершен (успешно или с ошибками).

]no-highlight]
": "{количество успешно импортированных почтовых ящиков и тех, импорт которых завершен с ошибками}", "failed_boxes_count
[no-highlight[

Тип значения

Число

Описание

Количество почтовых ящиков, импорт которых был остановлен из-за ошибок.

]no-highlight]
": "{количество почтовых ящиков, импорт которых остановлен из-за ошибок}", "failed_boxes_pages
[no-highlight[

Тип значения

Число

Описание

Количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок (статус failed).

]no-highlight]
": "{количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок}", "failed_boxes_current_page
[no-highlight[

Тип значения

Число

Описание

Номер страницы ответа.

]no-highlight]
": "{номер страницы ответа}", "imported_message_count
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{количество импортированных писем всех почтовых ящиков}", "total_message_count
[no-highlight[

Тип значения

Число

Описание

Общее количество писем почтовых ящиков, которые были отправлены на импорт.

]no-highlight]
": "{общее количество отправленных на импорт писем}", "progress_percent
[no-highlight[

Тип значения

Число

Описание

Прогресс импорта в процентах.

]no-highlight]
": "{прогресс импорта в процентах}", "failed_boxes
[no-highlight[

Тип значения

Массив

Описание

Данные о почтовых ящиках и их ошибках, импорт которых был остановлен (статус failed). Каждый объект массива соответствует отдельному почтовому ящику.

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

Тип значения

Строка

Описание

Логин на сервере-источнике.

]no-highlight]
": "{логин на сервере-источнике}", "external_password
[no-highlight[

Тип значения

Строка

Описание

Пароль на сервере-источнике.

]no-highlight]
": "{пароль на сервере-источнике}", "internal_login
[no-highlight[

Тип значения

Строка

Описание

Логин для авторизации на Яндекс.Почте для домена.

]no-highlight]
": "{логин на Яндекс.Почте для домена}", "internal_password
[no-highlight[

Тип значения

Строка

Описание

Пароль для авторизации на Яндекс.Почте для домена.

]no-highlight]
": "{пароль на Яндекс.Почте для домена}", "imported_mail
[no-highlight[

Тип значения

Число

Описание

Количество писем почтового ящика, которые удалось импортировать.

]no-highlight]
": "{количество импортированных писем}", "last_error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки, из-за которой завершилась последняя попытка импорта.

]no-highlight]
": "{код последней ошибки}", "last_error_count
[no-highlight[

Тип значения

Число

Описание

Количество ошибок, из-за которых импорт был остановлен.

]no-highlight]
": "{количество ошибок}", }, ... ] }, "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 Объект

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

import Объект

Информация об импорте.

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-соединение.

Ключи объекта import
state Строка

Состояние импорта.

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

  • task_just_created — запрос на импорт принят, но процесс пока не запущен.
  • paused — импорт временно приостановлен, чтобы дать возможность обработать другие запросы на импорт (возникает при обработке запроса с большим количеством почтовых ящиков).
  • in_progress — импорт запущен.
  • paused_cause_of_error — импорт временно остановлен из-за ошибки, не связанной с правильностью формирования запроса (например, сервер отказал в соединении).
  • failed — импорт остановлен из-за ошибки, связанной с формированием запроса на импорт (например, неверный логин и пароль и т.д.).
  • done — импорт завершен успешно.
  • removed — импорт отменен пользователем.

done_box_count Число

Количество почтовых ящиков, импорт которых был завершен успешно.

total_box_count Число

Количество почтовых ящиков, которые были отправлены на импорт.

complete_box_count Число

Количество почтовых ящиков, импорт которых был завершен (успешно или с ошибками).

failed_boxes_count ЧислоКоличество почтовых ящиков, импорт которых был остановлен из-за ошибок.
failed_boxes_pages Число

Количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок (статус failed).

failed_boxes_current_page Число

Номер страницы ответа.

imported_message_count Число

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

total_message_count Число

Общее количество писем почтовых ящиков, которые были отправлены на импорт.

progress_percent Число

Прогресс импорта в процентах.

failed_boxes Массив

Данные о почтовых ящиках и их ошибках, импорт которых был остановлен (статус failed). Каждый объект массива соответствует отдельному почтовому ящику.

Ключи объектов массива failed_boxes
external_login Строка

Логин на сервере-источнике.

external_password Строка

Пароль на сервере-источнике.

internal_login Строка

Логин для авторизации на Яндекс.Почте для домена.

internal_password Строка

Пароль для авторизации на Яндекс.Почте для домена.

imported_mail ЧислоКоличество писем почтового ящика, которые удалось импортировать.
last_error Строка

Код ошибки, из-за которой завершилась последняя попытка импорта.

last_error_count Число

Количество ошибок, из-за которых импорт был остановлен.