Методы ресурса SenderEmails

Метод:index

url: /mailer/senderemails

http-method: GET

Используется для получения списка всех email-ов отправителя.

Опциональные параметры

limit - происходит выборка всех значений по умолчанию (10).
page - присутствует только первая страница со всеми email-ми отправителя.
fields - значения по умолчанию: ["id","email"]. Список доступных полей: id, email, name, approved, default, last_approved. Если переданы неправильные параметры, вернётся значение по умолчанию.
filter - доступные поля: email, approved, default.
sort_field - значение по умолчанию: id. Доступные поля для сортировки: id, email, approved.

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

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "sender_emails": [
    {
      "id": 1,
      "email": "example@example.com",
      "name": "Name",
      "approved": 1,
      "default": 0,
      "last_approved": 1473937013
    },
    {
      "id": 1,
      "email": "email@example.com",
      "name": "Name",
      "approved": 1,
      "default": 0,
      "last_approved": 1473943131
    },
    {
      ...
    },
    
  ]
}
Название параметра Тип Описание
id int Идентификатор email-a отправителя.
email string Email адрес отправителя.
name string Имя отправителя.
approved int Статус подтверждения email-a отправителя. 1- email подтверждён. 0 - email не подтверждён.
default int Флаг email-а по умолчанию. 1 - установлен email-м по умолчанию. 0 - не установлен email-м по умолчанию.
last_approved timestamp Время отправки последнего письма активации данного email-а.

Метод:view

url: /mailer/senderemails/[id]

http-method: GET

Используется для получения email-a отправителя по уникальному идентификатору (id).

Опциональные параметры

fields - значение по умолчанию: ["id","email"]. Список доступных полей: id, email, name, approved, default, last_approved.

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

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "id": 1,
  "email": "example@example.com",
  "name": "Name",
  "approved": 1,
  "default": 1,
  "last_approved": 1474358359
}
Название параметра Тип Описание
id int Идентификатор email-a отправителя.
email string Email адрес отправителя.
name string Имя отправителя.
approved int Статус подтверждения email-a отправителя. 1- email подтверждён. 0 - email не подтверждён.
default int Флаг email-а по умолчанию. 1 - установлен email-м по умолчанию. 0 - не установлен email-м по умолчанию.
last_approved timestamp Время отправки последнего письма активации данного email-а.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20420 Invalid fields. Wrong parameters of string fields Переданны неправильные параметры строки fields.
404 Not found Email-a отпрвителя по переданому идентификатору не найдено.

Метод: add

url: /mailer/senderemails

http-method: POST

Используется для добавления нового email-a отправителя. Возможно добавить не больше 10 email-в отправителя. После добавления email-а на указанную почту Вам прийдет письмо активации, в котором необходимо активировать указанную почту нажав на кнопку "Подтвердить", либо использовать код активации и с помощью метода edit ресурса SenderEmails активировать эту почту, передав код активации и поле "approve = 1".

Обязательные параметры

Название Тип Описание
name string Имя отправителя.
email string Email адрес отправителя.

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

HTTP status code: 201.

При успешном выполнении запроса возвращается идентификатор (id) созданного email-a отправителя.

Пример успешного ответа:

{
  "id": 1
}
Название параметра Тип Описание
id int Идентификатор email-a отправителя.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20440 Invalid name. Name can not be empty Имя отправителя не может быть пустым.
400 20441 Invalid email. Check the validity of the specified email Email отправителя не может быть пустым и должен быть валидным.
400 20442 Exhausted the limit of sender emails. Maximum number: 10 Превышен лимит email-в отправителя. Максимальное кол-во: 10.
400 20443 This email already exists Данный email уже ранее добавлен в ваш список email-в отправителя.
400 20444 Emails on domains mail.ru, bk.ru, mail.ua, list.ru, inbox.ru can not be used Email-ы на доменах mail.ru, bk.ru, mail.ua, list.ru, inbox.ru использовать нельзя.
400 20445 At this tariff email should be on a personal domain На вашем тарифе email должен быть на персональном домене.

Метод: edit

url: /mailer/senderemails/[id]

http-method: PUT

Используется для редактирования, подтверждения и задания по умолчанию добавленного email-а отправителя.

Опциональные параметры

Название Тип Значение по умолчанию Описание
name string Новое имя отправителя.
approved int 0 Флаг подтверждения email-a. 1 - для подтверждения email-a. С момента добавления email находится с флагом 0 - не подтверждён.
activation_code string Код активации для подтверждения email-a. Скопируйте сюда код активации, который пришёл в письме активации email-a отправителя на Вашу почту.
default int Флаг задания email-a отправителя по умолчанию. 1 - для установки этого email-a по умолчанию. При этом предыдущий email по умолчанию автоматически изменит свой статус на email не по умолчанию.

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

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20460 Email is already approved Передан параметр "approved" = 1 , когда данный email уже подтверждён. Нельзя подтвердить уже подтверждённый email отправителя.
400 20461 Send email confirmation can not occur more than once per minute Вы попытались послать несколько писем активации в течении 1 минуты. Письмо активации можно высылать не чаще чем раз в минуту.
400 20462 Wrong activation code Вы передали неверный код активации.
400 20463 Email is not approved. Before you set this email as default , you have to approve it Передан параметр "default" = 1 , когда данный email еще не подтверждён. Подтвердите email отправителя для возможности установки его как email по умолчанию.
400 20464 Email is already set as default Передан параметр "default" = 1 , когда данный email уже установлен по умолчанию.
404 Not Found Email-а отправителя по переданому идентификатору не найдено.

Метод:delete

url: /mailer/senderemails/[id]

http-method: DELETE

Удаление email-a отправителя. Удалять можно только те email-ы, которые не являются email-ми по умолчанию.

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

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20480 Wrong id. This email is default. You can not delete the default email Нельзя удалять email, который установлен email-м отправителя по умолчанию.
404 Not found Email-a отправителя по переданому идентификатору не найдено.