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

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

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

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

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

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

GET /api2/admin/email/list?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

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

Тип

Число

Значение

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

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

Тип

Число

Значение

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

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

Описание

ПДД-токен.

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

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

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

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

on_page Число

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

GET /api2/registrar/email/list?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

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

Тип

Число

Значение

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

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

Тип

Число

Значение

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

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

Описание

ПДД-токен.

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

Описание

OAuth-токен.

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

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

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

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "page
[no-highlight[

Тип значения

Число

Описание

Номер страницы ответа. Значение параметра page, заданное в запросе. Если значение параметра не задано, используется его значение по умолчанию.

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

Тип значения

Число

Описание

Общее количество страниц ответа.

]no-highlight]
": "{общее количество страниц ответа}", "on_page
[no-highlight[

Тип значения

Число

Описание

Количество почтовых ящиков на каждой странице ответа. Значение параметра on_page, заданное в запросе.

]no-highlight]
": "{количество почтовых ящиков на каждой странице ответа}", "total
[no-highlight[

Тип значения

Число

Описание

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

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

Тип значения

Число

Описание

Количество почтовых ящиков на текущей странице ответа (может отличаться от значения ключа on_page для последней страницы в меньшую сторону).

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

Тип значения

Массив

Описание

Атрибуты почтовых ящиков. Каждый объект массива соответствует отдельному почтовому ящику.

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

Тип значения

Строка

Описание

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

]no-highlight]
": "{email-адрес почтового ящика}", "uid
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{идентификатор почтового ящика}", "enabled
[no-highlight[

Тип значения

Строка

Описание

Статус работы почтового ящика.

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

  • yes — почтовый ящик работает.
  • no — почтовый ящик заблокирован (например, из-за рассылки спама или подозрения на взлом).

]no-highlight]
": "{статус работы почтового ящика}", "fio
[no-highlight[

Тип значения

Строка

Описание

ФИО пользователя.

]no-highlight]
": "{ФИО пользователя}", "fname
[no-highlight[

Тип значения

Строка

Описание

Фамилия пользователя.

]no-highlight]
": "{фамилия пользователя}", "iname
[no-highlight[

Тип значения

Строка

Описание

Имя пользователя.

]no-highlight]
": "{имя пользователя}", "birth_date
[no-highlight[

Тип значения

Строка

Описание

Дата рождения пользователя в формате YYYY-MM-DD.

]no-highlight]
": "{дата рождения пользователя}", "sex
[no-highlight[

Тип значения

Число

Описание

Пол пользователя.

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

  • 0 — не указан.
  • 1 — мужской.
  • 2 — женский.

]no-highlight]
": "{пол пользователя}", "hintq
[no-highlight[

Тип значения

Строка

Описание

Секретный вопрос.

]no-highlight]
": "{секретный вопрос}", "ready
[no-highlight[

Тип значения

Строка

Описание

Готовность к работе почтового ящика.

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

  • yes — пользовательское соглашение принято, ящик готов к использованию.
  • no — пользовательское соглашение не принято, ящик не готов к использованию.

]no-highlight]
": "{готовность к работе почтового ящика}", "aliases
[no-highlight[

Тип значения

Массив

Описание

Список алиасов почтовых адресов.

]no-highlight]
": [ "{имя алиаса}", ... ], "maillist
[no-highlight[

Тип значения

Строка

Описание

Признак рассылки.

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

  • yes — почтовый ящик является рассылкой.
  • no — почтовый ящик не является рассылкой.

]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 Строка

Имя домена.

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 — почтовый ящик не является рассылкой.