Получить количество новых писем

Запрос позволяет получить:
  • общее количество писем, непрочитанных владельцем почтового ящика;
  • количество писем, полученных владельцем после последней проверки почтового ящика.

Почтовый ящик можно задать с помощью email-адреса или идентификатора. Идентификатор можно получить в ответе на запрос Получить список почтовых ящиков.

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

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

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

GET /api2/admin/email/counters?
domain=<имя домена>
&(login=<email-адрес или логин почтового ящика>|uid=<идентификатор почтового ящика>)

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

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

loginСтрока

Email-адрес почтового ящика в формате «login@domain.ru» или «login».

В запросе нужно передать только один из параметров: login или uid.

uidЧисло

Идентификатор почтового ящика.

Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков.

В запросе нужно передать только один из параметров: login или uid.

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

GET /api2/admin/email/counters?domain=domain.com&uid=12345678901 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/counters?domain=domain.com&uid=12345678901'

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

{
  "domain": "{имя домена}",
  "login": {email-адрес почтового ящика}, 
  "uid": {идентификатор почтового ящика}, 
  "counters": 
    {
      "unread": "{количество непрочитанных писем}",
      "new": "{количество писем, полученных после последней проверки почтового ящика}"     
    }, 
  "success": "{статус выполнения запроса}"
}
НазваниеТип значенияОписание
domainСтрока

Имя домена.

loginСтрока

Email-адрес почтового ящика.

uidЧисло

Идентификатор почтового ящика.

countersОбъект

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

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 — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта counters
unreadЧисло

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

newЧисло

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