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

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

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

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

Запрос позволяет получить:

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

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

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

Запрос следует отправлять по протоколу 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`.


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
login	Строка	Email-адрес почтового ящика в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: `login` или `uid`.
uid	Число	Идентификатор почтового ящика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: `login` или `uid`.

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

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

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
login	Строка	Email-адрес почтового ящика в формате «login@domain.ru» или «login». В запросе нужно передать только один из параметров: `login` или `uid`.
uid	Число	Идентификатор почтового ящика. Значение идентификатора можно получить в ответе на запрос Получить список почтовых ящиков. В запросе нужно передать только один из параметров: `login` или `uid`.


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

GET /api2/admin/email/counters?domain=domain.com&uid=12345678901 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/email/counters?domain=domain.com&uid=12345678901'

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

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

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


Название	Тип значения	Описание
`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`	Число	Количество писем, полученных после последней проверки почтового ящика.


Название	Тип значения	Описание
`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`	Число	Количество писем, полученных после последней проверки почтового ящика.