Получить список почтовых ящиков

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

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

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

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

Ответ возвращается постранично, его параметры можно задать в запросе.

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

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

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

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

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
Необязательные
page	Число	Номер страницы ответа. Значение по умолчанию — 1.
on_page	Число	Количество почтовых ящиков на каждой странице ответа. Значение по умолчанию — 30.


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
Необязательные
page	Число	Номер страницы ответа. Значение по умолчанию — 1.
on_page	Число	Количество почтовых ящиков на каждой странице ответа. Значение по умолчанию — 30.

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

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

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
Необязательные
page	Число	Номер страницы ответа. Значение по умолчанию — 1.
on_page	Число	Количество почтовых ящиков на каждой странице ответа. Значение по умолчанию — 30.


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
Необязательные
page	Число	Номер страницы ответа. Значение по умолчанию — 1.
on_page	Число	Количество почтовых ящиков на каждой странице ответа. Значение по умолчанию — 30.

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

GET /api2/admin/email/list?domain=domain.com&page=1&on_page=5 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/email/list?domain=domain.com&page=1&on_page=5'

GET /api2/admin/email/list?domain=domain.com&page=1&on_page=5 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/list?domain=domain.com&page=1&on_page=5'

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

{
  "domain": "{имя домена}",
  "page": "{номер страницы ответа}",
  "pages": "{общее количество страниц ответа}",
  "on_page": "{количество почтовых ящиков на каждой странице ответа}", 
  "total": "{общее количество почтовых ящиков домена}", 
  "found": "{количество почтовых ящиков на текущей странице ответа}",
  "accounts": 
  [ 
    {
      "login": "{email-адрес почтового ящика}",
      "uid": "{идентификатор почтового ящика}",     
      "enabled": "{статус работы почтового ящика}",     
      "fio": "{ФИО пользователя}",     
      "fname": "{фамилия пользователя}",     
      "iname": "{имя пользователя}",     
      "birth_date": "{дата рождения пользователя}",     
      "sex": "{пол пользователя}",     
      "hintq": "{секретный вопрос}",     
      "ready": "{готовность к работе почтового ящика}",
      "aliases": 
        [
          "{имя алиаса}", 
          ...
        ],    
      "maillist": "{признак рассылки}"
    }, 
    ...
  ], 
  "success": "{статус выполнения запроса}"
}

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


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`page`	Число	Номер страницы ответа. Значение параметра page, заданное в запросе. Если значение параметра не задано, используется его значение по умолчанию.
`pages`	Число	Общее количество страниц ответа.
`on_page`	Число	Количество почтовых ящиков на каждой странице ответа. Значение параметра on_page, заданное в запросе.
`total`	Число	Общее количество почтовых ящиков домена.
`found`	Число	Количество почтовых ящиков на текущей странице ответа (может отличаться от значения ключа on_page для последней страницы в меньшую сторону).
`accounts`	Массив	Атрибуты почтовых ящиков. Каждый объект массива соответствует отдельному почтовому ящику.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива `accounts`
`login`	Строка	Email-адрес почтового ящика.
`uid`	Число	Идентификатор почтового ящика.
`enabled`	Строка	Статус работы почтового ящика. Возможные значения: `yes` — почтовый ящик работает. `no` — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).
`fio`	Строка	ФИО пользователя.
`aliases`	Массив	Список алиасов почтовых адресов.
`fname`	Строка	Фамилия пользователя.
`iname`	Строка	Имя пользователя.
`birth_date`	Строка	Дата рождения пользователя в формате YYYY-MM-DD.
`sex`	Число	Пол пользователя. Возможные значения: 0 — не указан. `1` — мужской. `2` — женский.
`hintq`	Строка	Секретный вопрос.
`ready`	Строка	Готовность к работе почтового ящика. Возможные значения: `yes` — пользовательское соглашение принято, ящик готов к использованию. `no` — пользовательское соглашение не принято, ящик не готов к использованию.
`maillist`	Строка	Признак рассылки. Возможные значения: `yes` — почтовый ящик является рассылкой. `no` — почтовый ящик не является рассылкой.


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`page`	Число	Номер страницы ответа. Значение параметра page, заданное в запросе. Если значение параметра не задано, используется его значение по умолчанию.
`pages`	Число	Общее количество страниц ответа.
`on_page`	Число	Количество почтовых ящиков на каждой странице ответа. Значение параметра on_page, заданное в запросе.
`total`	Число	Общее количество почтовых ящиков домена.
`found`	Число	Количество почтовых ящиков на текущей странице ответа (может отличаться от значения ключа on_page для последней страницы в меньшую сторону).
`accounts`	Массив	Атрибуты почтовых ящиков. Каждый объект массива соответствует отдельному почтовому ящику.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива `accounts`
`login`	Строка	Email-адрес почтового ящика.
`uid`	Число	Идентификатор почтового ящика.
`enabled`	Строка	Статус работы почтового ящика. Возможные значения: `yes` — почтовый ящик работает. `no` — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).
`fio`	Строка	ФИО пользователя.
`aliases`	Массив	Список алиасов почтовых адресов.
`fname`	Строка	Фамилия пользователя.
`iname`	Строка	Имя пользователя.
`birth_date`	Строка	Дата рождения пользователя в формате YYYY-MM-DD.
`sex`	Число	Пол пользователя. Возможные значения: 0 — не указан. `1` — мужской. `2` — женский.
`hintq`	Строка	Секретный вопрос.
`ready`	Строка	Готовность к работе почтового ящика. Возможные значения: `yes` — пользовательское соглашение принято, ящик готов к использованию. `no` — пользовательское соглашение не принято, ящик не готов к использованию.
`maillist`	Строка	Признак рассылки. Возможные значения: `yes` — почтовый ящик является рассылкой. `no` — почтовый ящик не является рассылкой.