Импортировать один почтовый ящик

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

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

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

Запрос позволяет импортировать письма одного почтового ящика на Яндекс Почту для домена. Для импорта необходимо передать:

Настройки соединения с сервером-источником, которые должна использовать Яндекс Почта для домена. Корректность настроек можно проверить отдельным запросом.

Если передать настройки, при которых соединение невозможно, Яндекс Почта для домена будет повторять попытки соединения длительное время, не возвращая при этом ошибки.
Логин и пароль почтового ящика, который нужно импортировать.

При импорте создается новый почтовый ящик на Яндекс Почте для домена. Поэтому логин и пароль должны соответствовать требованиям Яндекса: Если логин или пароль на сервере-источнике не соответствует требованиям Яндекса, нужно передать новый.

Логин:
- может состоять из латинских символов, цифр, одинарного дефиса или точки;
- должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.
Пароль:
- не должен совпадать с логином;
- должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ | , . < > / ?, не допускаются ~ и ').

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

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

POST /api2/admin/import/start_one_import
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...

domain=<имя домена почты>
&method=<протокол сервера>
&server=<имя сервера>
&port=<порт сервера>
&ssl=<использование SSL>
&ext-login=<логин на сервере-источнике>
&ext-passwd=<пароль на сервере-источнике>
[&int-login=<логин для Яндекс Почты для домена>]
[&int-passwd=<пароль для Яндекс Почты для домена>]

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.
ext-login	Строка	Логин на сервере-источнике.
ext-passwd	Строка	Пароль на сервере-источнике.
Необязательные
int-login	Строка	Логин для авторизации на Яндекс Почте для домена. Параметр нужно передать, если логин `ext-login` не соответствует требованиям Яндекса: может состоять из латинских символов, цифр, одинарного дефиса или точки; должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.
int-passwd	Строка	Пароль для авторизации на Яндекс Почте для домена. Параметр нужно передать, если пароль `ext-passwd` не соответствует требованиям Яндекса: не должен совпадать с логином; должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ \| , . < > / ?, не допускаются `~` и `'`).


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена почты.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.
ext-login	Строка	Логин на сервере-источнике.
ext-passwd	Строка	Пароль на сервере-источнике.
Необязательные
int-login	Строка	Логин для авторизации на Яндекс Почте для домена. Параметр нужно передать, если логин `ext-login` не соответствует требованиям Яндекса: может состоять из латинских символов, цифр, одинарного дефиса или точки; должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.
int-passwd	Строка	Пароль для авторизации на Яндекс Почте для домена. Параметр нужно передать, если пароль `ext-passwd` не соответствует требованиям Яндекса: не должен совпадать с логином; должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ \| , . < > / ?, не допускаются `~` и `'`).

POST /api2/registrar/import/start_one_import
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>
...

domain=<имя домена почты>
&method=<протокол сервера>
&server=<имя сервера>
&port=<порт сервера>
&ssl=<использование SSL>
&ext-login=<логин на сервере-источнике>
&ext-passwd=<пароль на сервере-источнике>
[&int-login=<логин для Яндекс Почты для домена>]
[&int-passwd=<пароль для Яндекс Почты для домена>]

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.
ext-login	Строка	Логин на сервере-источнике.
ext-passwd	Строка	Пароль на сервере-источнике.
Необязательные
int-login	Строка	Логин для авторизации на Яндекс Почте для домена. Параметр нужно передать, если логин `ext-login` не соответствует требованиям Яндекса: может состоять из латинских символов, цифр, одинарного дефиса или точки; должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.
int-passwd	Строка	Пароль для авторизации на Яндекс Почте для домена. Параметр нужно передать, если пароль `ext-passwd` не соответствует требованиям Яндекса: не должен совпадать с логином; должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ \| , . < > / ?, не допускаются `~` и `'`).


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.
server	Строка	Доменное имя или IP-адрес сервера.
port	Число	Порт сервера.
method	Строка	Протокол сервера. Допустимые значения: `imap`; `imap4`; `pop`; `pop3`.
ssl	Строка	Использование SSL. Допустимые значения: `yes` — нужно использовать SSL-соединение. `no` — не нужно использовать SSL-соединение.
ext-login	Строка	Логин на сервере-источнике.
ext-passwd	Строка	Пароль на сервере-источнике.
Необязательные
int-login	Строка	Логин для авторизации на Яндекс Почте для домена. Параметр нужно передать, если логин `ext-login` не соответствует требованиям Яндекса: может состоять из латинских символов, цифр, одинарного дефиса или точки; должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.
int-passwd	Строка	Пароль для авторизации на Яндекс Почте для домена. Параметр нужно передать, если пароль `ext-passwd` не соответствует требованиям Яндекса: не должен совпадать с логином; должен содержать от 6 до 20 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ \| , . < > / ?, не допускаются `~` и `'`).

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

POST  /api2/admin/import/start_one_import HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890' 'https://pddimp.yandex.ru/api2/admin/import/start_one_import'

POST  /api2/admin/import/start_one_import HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&method=pop3&server=pop.yandex.ru&port=110&ssl=no&ext-login=111&ext-passwd=my&int-login=s123456789a&int-passwd=1234567890' 'https://pddimp.yandex.ru/api2/admin/import/start_one_import'

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

{
  "domain": "{имя домена почты}",
  "settings": 
    {
      "method": "{протокол сервера}",
      "server": "{имя сервера}",
      "port": "{порт сервера}",
      "ssl": "{использование SSL}"
    }, 
  "import_list":
  [
    "external_login": "{логин на сервере-источнике}",
    "external_password": "{пароль на сервере-источнике}",
    "internal_login": "{логин на Яндекс Почте для домена}",
    "internal_password": "{пароль на Яндекс Почте для домена}",
    "started": "{готовность к запуску импорта}"
  ]
  "success": "{статус выполнения запроса}"
}

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


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`settings`	Объект	Настройки сервера-источника.
`import_list`	Массив	Аутентификационные данные.
`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_list`
`external_login`	Строка	Логин на сервере-источнике.
`external_password`	Строка	Пароль на сервере-источнике.
`internal_login`	Строка	Логин для авторизации на Яндекс Почте для домена.
`internal_password`	Строка	Пароль для авторизации на Яндекс Почте для домена.
`started`	Строка	Готовность к запуску импорта. Возможные значения: `yes` — импорт будет запущен (все параметры заданы верно). `no` — импорт не будет запущен (обнаружена ошибка, ee код указан в значении ключа `error` ).


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`settings`	Объект	Настройки сервера-источника.
`import_list`	Массив	Аутентификационные данные.
`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_list`
`external_login`	Строка	Логин на сервере-источнике.
`external_password`	Строка	Пароль на сервере-источнике.
`internal_login`	Строка	Логин для авторизации на Яндекс Почте для домена.
`internal_password`	Строка	Пароль для авторизации на Яндекс Почте для домена.
`started`	Строка	Готовность к запуску импорта. Возможные значения: `yes` — импорт будет запущен (все параметры заданы верно). `no` — импорт не будет запущен (обнаружена ошибка, ee код указан в значении ключа `error` ).