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

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

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

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

GET /api2/admin/import/check_imports?
[page=<номер страницы ответа>]
[on_page=<количество почтовых ящиков на каждой странице ответа>]

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...
domain=<имя домена>

Заголовки:

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

ПДД-токен.

Параметры:

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

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

{
  "domain": "{имя домена}",
  "settings": 
    {
      "method": "{протокол сервера}",
      "server": "{имя сервера}",
      "port": "{порт сервера}",
      "ssl": "{использование SSL}"
    }, 
  "import":
    {
      "state": "{состояние импорта}",
      "total_box_count": "{количество отправленных на импорт почтовых ящиков}",
      "done_box_count": "{количество успешно импортированных почтовых ящиков}",
      "complete_box_count": "{количество успешно импортированных почтовых ящиков и тех, импорт которых завершен с ошибками}",
      "failed_boxes_count": "{количество почтовых ящиков, импорт которых остановлен из-за ошибок}",
      "failed_boxes_pages": "{количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок}",
      "failed_boxes_current_page": "{номер страницы ответа}",
      "imported_message_count": "{количество импортированных писем всех почтовых ящиков}",
      "total_message_count": "{общее количество отправленных на импорт писем}",
      "progress_percent": "{прогресс импорта в процентах}",
      "failed_boxes": 
        [ 
          {
            "external_login": "{логин на сервере-источнике}",
            "external_password": "{пароль на сервере-источнике}",
            "internal_login": "{логин на Яндекс.Почте для домена}",
            "internal_password": "{пароль на Яндекс.Почте для домена}",
            "imported_mail": "{количество импортированных писем}",
            "last_error": "{код последней ошибки}",
            "last_error_count": "{количество ошибок}",
          },
          ...
        ]
    }, 
  "success": "{статус выполнения запроса}"
}
НазваниеТип значенияОписание
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Число

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