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

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

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

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

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

  • Логин и пароль почтового ящика, который нужно импортировать.

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

  • Логин:

    • может состоять из латинских символов, цифр, одинарного дефиса или точки;

    • должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.

  • Пароль:

    • не должен совпадать с логином;

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

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

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

POST /api2/admin/import/start_one_import
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

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

Тип

Строка

Значение

Имя домена почты.

]no-highlight]
=<имя домена почты> &method
[no-highlight[

Тип

Строка

Значение

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
=<протокол сервера> &server
[no-highlight[

Тип

Строка

Значение

Доменное имя или IP-адрес сервера.

]no-highlight]
=<имя сервера> &port
[no-highlight[

Тип

Число

Значение

Порт сервера.

]no-highlight]
=<порт сервера> &ssl
[no-highlight[

Тип

Строка

Значение

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
=<использование SSL> &ext-login
[no-highlight[

Тип

Строка

Значение

Логин на сервере-источнике.

]no-highlight]
=<логин на сервере-источнике> &ext-passwd
[no-highlight[

Тип

Строка

Значение

Пароль на сервере-источнике.

]no-highlight]
=<пароль на сервере-источнике> [&int-login
[no-highlight[

Тип

Строка

Значение

Логин для авторизации на Яндекс.Почте для домена.

Параметр нужно передать, если логин ext-login не соответствует требованиям Яндекса:

  • может состоять из латинских символов, цифр, одинарного дефиса или точки;

  • должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.

]no-highlight]
=<логин для Яндекс.Почты для домена>] [&int-passwd
[no-highlight[

Тип

Строка

Значение

Пароль для авторизации на Яндекс.Почте для домена.

Параметр нужно передать, если пароль ext-passwd не соответствует требованиям Яндекса:

  • не должен совпадать с логином;

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

]no-highlight]
=<пароль для Яндекс.Почты для домена>]

Заголовки:

НазваниеОписание
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 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ | , . < > / ?, не допускаются ~ и ').

POST /api2/registrar/import/start_one_import
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

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

Описание

OAuth-токен.

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

Тип

Строка

Значение

Имя домена почты.

]no-highlight]
=<имя домена почты> &method
[no-highlight[

Тип

Строка

Значение

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
=<протокол сервера> &server
[no-highlight[

Тип

Строка

Значение

Доменное имя или IP-адрес сервера.

]no-highlight]
=<имя сервера> &port
[no-highlight[

Тип

Число

Значение

Порт сервера.

]no-highlight]
=<порт сервера> &ssl
[no-highlight[

Тип

Строка

Значение

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
=<использование SSL> &ext-login
[no-highlight[

Тип

Строка

Значение

Логин на сервере-источнике.

]no-highlight]
=<логин на сервере-источнике> &ext-passwd
[no-highlight[

Тип

Строка

Значение

Пароль на сервере-источнике.

]no-highlight]
=<пароль на сервере-источнике> [&int-login
[no-highlight[

Тип

Строка

Значение

Логин для авторизации на Яндекс.Почте для домена.

Параметр нужно передать, если логин ext-login не соответствует требованиям Яндекса:

  • может состоять из латинских символов, цифр, одинарного дефиса или точки;

  • должен начинаться с буквы, заканчиваться буквой или цифрой и содержать не более 30 символов.

]no-highlight]
=<логин для Яндекс.Почты для домена>] [&int-passwd
[no-highlight[

Тип

Строка

Значение

Пароль для авторизации на Яндекс.Почте для домена.

Параметр нужно передать, если пароль ext-passwd не соответствует требованиям Яндекса:

  • не должен совпадать с логином;

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

]no-highlight]
=<пароль для Яндекс.Почты для домена>]

Заголовки:

НазваниеОписание
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 символов — латинские буквы, цифры или спецсимволы (допускаются знаки ` ! @ # $ % ^ & * ( ) - _ = + [ ] { } ; : " \ | , . < > / ?, не допускаются ~ и ').

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

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
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена почты}", "settings
[no-highlight[

Тип значения

Объект

Описание

Настройки сервера-источника.

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

Тип значения

Строка

Описание

Протокол сервера.

Допустимые значения:

  • imap;

  • imap4;

  • pop;

  • pop3.

]no-highlight]
": "{протокол сервера}", "server
[no-highlight[

Тип значения

Строка

Описание

Доменное имя или IP-адрес сервера.

]no-highlight]
": "{имя сервера}", "port
[no-highlight[

Тип значения

Число

Описание

Порт сервера.

]no-highlight]
": "{порт сервера}", "ssl
[no-highlight[

Тип значения

Строка

Описание

Использование SSL.

Допустимые значения:

  • yes — нужно использовать SSL-соединение.
  • no — не нужно использовать SSL-соединение.

]no-highlight]
": "{использование SSL}" }, "import_list
[no-highlight[

Тип значения

Массив

Описание

Аутентификационные данные.

]no-highlight]
": [ "external_login
[no-highlight[

Тип значения

Строка

Описание

Логин на сервере-источнике.

]no-highlight]
": "{логин на сервере-источнике}", "external_password
[no-highlight[

Тип значения

Строка

Описание

Пароль на сервере-источнике.

]no-highlight]
": "{пароль на сервере-источнике}", "internal_login
[no-highlight[

Тип значения

Строка

Описание

Логин для авторизации на Яндекс.Почте для домена.

]no-highlight]
": "{логин на Яндекс.Почте для домена}", "internal_password
[no-highlight[

Тип значения

Строка

Описание

Пароль для авторизации на Яндекс.Почте для домена.

]no-highlight]
": "{пароль на Яндекс.Почте для домена}", "started
[no-highlight[

Тип значения

Строка

Описание

Готовность к запуску импорта.

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

  • yes — импорт будет запущен (все параметры заданы верно).
  • no — импорт не будет запущен (обнаружена ошибка, ee код указан в значении ключа error).

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

Имя домена.

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).