Mail accounts

Синхронизировать ящик по требованию

Быстрая проверка ящика: «Входящие» и названная папка (folder_id) не дольше 20 секунд, с переносом прочтения и удалений, сделанных в другом клиенте. Остальные папки, история и прогрев тел уходят фоновым проходом сразу следом. Ящик, который уже проверяется, или проверка, не успевшая в срок, отвечают 200 со state = running: письма появятся сами, это не ошибка. Выключенный ящик — 409 mail.account_disabled, ящик без сохранённого пароля — 409 mail.not_connected. Отчёт возвращается и тогда, когда нового ничего нет: «ничего не изменилось» — тоже ответ.

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

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/mail/accounts/{id}/sync
  • 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

folder_idstring uuid

Папка, которую человек сейчас смотрит: проверяется вместе с «Входящими»

Response

Итог прохода по ящику

account_idstring uuid required
foldersinteger required

Сколько папок прочитано

new_messagesinteger required
rules_appliedinteger required

Сколько писем разобрали правила

finished_atstring date-time required
full_reloadedstring[]

Папки, перечитанные целиком после смены UIDVALIDITY на сервере

failed_foldersstring[]

Папки, которые в этот проход прочитать не удалось; остальные разобраны

updatedinteger

Письма, у которых проход перенёс с сервера прочтение, отметку или удаление из другого клиента

state'done' | 'running'

Только у проверки по требованию: done — проверено, running — ящик проверяется фоном и письма появятся сами

partialboolean

Проверка по требованию успела не все свои папки; остальное доделает фон

Changes

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