Mail accounts

Создать папку ящика

Косые черты в названии запрещены: разделитель иерархии задаёт почтовый сервер, и имя с ним внутри создаёт не папку, а ветку с пустым промежуточным узлом. Папка верхнего уровня ложится туда, где сервер держит остальные, в том числе под префикс «INBOX.». Служебное имя («Archive», «Архив», «Trash», «Корзина», «Sent», «Junk», «Drafts»), когда папки этой роли у ящика нет, заводит служебную папку под серверным именем и возвращает её с ролью; так экран заводит архив при первом «В архив».

post/api/v1/mail/accounts/{id}/folders

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/mail/accounts/{id}/folders
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Request body

namestring required

Косые черты запрещены: разделитель иерархии задаёт сервер

parent_idstring uuid

Response

Созданная папка

idstring uuid required
account_idstring uuid required
external_idstring required

Идентификатор папки у провайдера; локальная папка «Исходящие» использует внутренний идентификатор и не синхронизируется по IMAP

namestring required
role'inbox' | 'outbox' | 'sent' | 'drafts' | 'trash' | 'spam' | 'archive' | 'custom' required

Назначение папки в нашем прочтении, а не её имя на сервере. Незнакомое имя остаётся custom — угаданная роль складывала бы туда отправленные письма.

parent_idstring uuid required
delimiterstring required

Разделитель иерархии, который назвал сервер

total_countinteger required
unread_countinteger required
sort_orderinteger required

Вес папки в привычном порядке системных папок

subscribedboolean required
mirrorboolean required

Вид на ту же почту (Gmail «Вся почта», «Важное», «Помеченные»): письма в нём — копии писем из настоящих папок, в сводные выборки они не попадают

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.