Почта

• Список ящиков домена
• Создание нескольких ящиков домена из CSV-файла
• Создание нового ящика
• Информация о ящике
• Изменение почтового ящика
• Удаление ящика
• Добавление адреса пересылки
• Удаление ящика для пересылки
• Изменение пароля ящика
• Выключение почтового ящика
• Очистка почтового ящика

Список ящиков домена

URL: /api/v2/mail/domains/{id}/mailboxes/
Метод: GET
Результат: JSON

Параметры запроса

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

• id: int – ID почтового домена

Необязательные параметры:

• offset: int – Индекс первой строки выборки, начиная с 0
• limit: int – Количество элементов в выборке в диапазоне от 1 до 100
• order: Sequence[str] – Сортировка элементов в выборке
• filter: str – Фильтр для запроса

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

• count: int – Количество элементов
• entities – Список почтовых ящиков
  • id: int – Идентификатор ящика
  • name: str – Имя ящика
  • aliases: str – Адреса ящиков для пересылки почты
  • comment: str – Комментарий к ящику
  • created: datetime – Дата создания почтового ящика
  • domain_id: int – ID домена
  • is_local: bool – Хранение почты в ящике
  • quota: int – Максимальный объем дискового пространства для ящика (МБ)
  • state: str – Состояние почтового ящика
  • updated: datetime – Дата изменения почтового ящика
  • used: int – Занятое дисковое пространство (МБ)

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

curl --request GET 'https://api-ms.netangels.ru/api/v2/mail/domains/{id}/mailboxes/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

---

Создание нескольких ящиков домена из CSV-файла

URL: /api/v2/mail/domains/{id}/mailboxes/batch-create/
Метод: POST
Результат: JSON

Параметры запроса

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

• id: int – ID почтового домена

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

• count: int – Количество элементов
• entities – Список почтовых ящиков
  • id: int – Идентификатор ящика
  • name: str – Имя ящика
  • aliases: str – Адреса ящиков для пересылки почты
  • comment: str – Комментарий к ящику
  • created: datetime – Дата создания почтового ящика
  • domain_id: int – ID домена
  • is_local: bool – Хранение почты в ящике
  • quota: int – Максимальный объем дискового пространства для ящика (МБ)
  • state: str – Состояние почтового ящика
  • updated: datetime – Дата изменения почтового ящика
  • used: int – Занятое дисковое пространство (МБ)

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

curl --request POST 'https://api-ms.netangels.ru/api/v2/mail/domains/{id}/mailboxes/batch-create/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

---

Создание нового ящика

URL: /api/v2/mail/mailboxes/
Метод: POST
Результат: JSON

Параметры тела запроса

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

• domain_id: int – ID почтового домена
• name: str – Имя почтового ящика
• password: str – Пароль для почтового ящика

Необязательные параметры:

• comment: str – Комментарий

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request POST 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "domain_id": 1001, 
          "name": "mailbox1", 
          "password": "PassWord", 
          "comment": "Ящик номер 1" 
    }'

---

Информация о ящике

URL: /api/v2/mail/mailboxes/{id}/
Метод: GET
Результат: JSON

Параметры запроса

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

• id: int – ID почтового ящика

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request GET 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

---

Изменение почтового ящика

URL: /api/v2/mail/mailboxes/{id}/
Метод: PUT
Результат: JSON

Параметры запроса

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

• id: int – ID почтового ящика

Параметры тела запроса

Необязательные параметры:

• comment: str – Комментарий
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• is_local: bool – Хранение почты в ящике
• aliases: Список str – Ящик для пересылки

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "comment": "Ящик номер 1", 
          "quota": 1000, 
          "is_local": true, 
          "aliases": "mail@google.com" 
    }'

---

Удаление ящика

URL: /api/v2/mail/mailboxes/{id}/
Метод: DELETE

Параметры запроса

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

• id: int – ID почтового ящика

Коды ответов

Код	Описание
200	Успешный запрос

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

curl --request DELETE 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

---

Добавление адреса пересылки

URL: /api/v2/mail/mailboxes/{id}/add-alias/
Метод: PUT
Результат: JSON

Параметры запроса

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

• id: int – ID почтового ящика

Параметры тела запроса

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

• alias: str – Ящик для пересылки

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/add-alias/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "alias": "mail@google.com" 
    }'

---

Удаление ящика для пересылки

URL: /api/v2/mail/mailboxes/{id}/delete-alias/
Метод: PUT
Результат: JSON

Параметры запроса

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

• id: int – ID почтового ящика

Параметры тела запроса

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

• alias: str – Ящик для пересылки

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/delete-alias/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "alias": "mail@google.com" 
    }'

---

Изменение пароля ящика

URL: /api/v2/mail/mailboxes/{id}/change-password/
Метод: PUT
Результат: JSON

Параметры запроса

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

• id: int – ID почтового ящика

Параметры тела запроса

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

• password: str – Пароль для почтового ящика

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Почтовый ящик

• id: int – Идентификатор ящика
• name: str – Имя ящика
• aliases: str – Адреса ящиков для пересылки почты
• comment: str – Комментарий к ящику
• created: datetime – Дата создания почтового ящика
• domain_id: int – ID домена
• is_local: bool – Хранение почты в ящике
• quota: int – Максимальный объем дискового пространства для ящика (МБ)
• state: str – Состояние почтового ящика
• updated: datetime – Дата изменения почтового ящика
• used: int – Занятое дисковое пространство (МБ)

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/change-password/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "password": "PassWord" 
    }'

---

Выключение почтового ящика

URL: /api/v2/mail/mailboxes/{id}/disable/
Метод: PUT

Параметры запроса

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

• id: int – ID почтового ящика

Коды ответов

Код	Описание
200	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/disable/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

---

Очистка почтового ящика

URL: /api/v2/mail/mailboxes/{id}/cleanup/
Метод: PUT

Параметры запроса

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

• id: int – ID почтового ящика

Коды ответов

Код	Описание
200	Успешный запрос
400	Очистка ящика запрещена

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/mail/mailboxes/{id}/cleanup/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"