Mail messages

Получить письма по фильтру

Одна выборка обслуживает и список папки, и поиск. Папку можно назвать ролью (folder_role), не зная её идентификатора: так инструкция агента переносится между кабинетами. Видны письма только тех ящиков, которые доступны сотруднику.

get/api/v1/mail/messages

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/mail/messages
  • 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)

Query parameters

qstring

Поиск по теме, отправителю и тексту

account_idstring uuid

Ограничить одним ящиком

folder_idstring uuid

Ограничить одной папкой

thread_idstring uuid

Ограничить одной перепиской

folder_role'inbox' | 'outbox' | 'sent' | 'drafts' | 'trash' | 'spam' | 'archive' | 'custom'

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

Папка по назначению вместо идентификатора

fromstring

Адрес отправителя

spam_verdict'unknown' | 'spam' | 'ham'

Вердикт по спаму; unknown — состояние по умолчанию. Вердикт справочный и с папкой не связан: письмо во «Входящих» может нести spam от провайдера (флаг $Junk на сервере почты), а папку «Спам» задаёт только перенос. Решение человека (spam_source=user) сильнее флага сервера и правил.

Вердикт по спаму

is_readboolean

Только прочитанные или только непрочитанные

is_flaggedboolean

Только отмеченные важными

has_filesboolean

Только письма с вложениями

sent_afterstring date-time

Письма, отправленные не раньше этого момента (RFC 3339)

sent_beforestring date-time

Письма, отправленные не позже этого момента (RFC 3339)

limitinteger

Размер страницы

offsetinteger

Смещение страницы

all_mailboolean

Вся почта, как в Gmail: письма всех папок, кроме спама, корзины и черновиков

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Страница писем с общим числом строк

totalinteger required
limitinteger required
offsetinteger required
has_moreboolean required

Changes

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