Untitled :: Справочная документация

email/Folders

Коллекция IMAP-каталогов, привязанных к email-аккаунтам. Коллекция создается и используется микросервисом 'email'.

Сущности создаются автоматически во время синхронизации email-аккаунта с IMAP-сервером. Требуется включение созданного каталога для активации сервиса получения писем в систему.

Отправляемые сообщения также должны быть привязаны к какому-либо каталогу. Каталог для отправляемых писем может быть создан вручную с ограниченным количеством заполненных полей: 'account_id', 'title'.

Тип хранилища: category.

Table 1. Поля класса
Поле	Описание
`id`	Идентификатор.
`account_id`	Идентификатор родительского email-аккаунта.
`title`	Полное название IMAP-каталога. Например, 'my.address@email/INBOX'. Подставляется автоматически при создании каталога во время синхронизации с IMAP-сервером. Не следует изменять автоматически сформированные названия.
`name`	Краткое название IMAP-каталога. Например, 'INBOX'. Подставляется автоматически при создании каталога во время синхронизации с IMAP-сервером. Не следует изменять автоматически сформированные названия.
`enabled`	Выключатель синхронизации каталога. При автоматическом создании каталога во время синхронизации выставляется в 'false'. Требуется включение каталога для запуска синхронизации входящих писем с системой.
`options`	Дополнительные опции: `portion_limit` (по умолчанию 5) - количество писем, обрабатываемых за одну итерацию операцией получения. `load_existing` (по умолчанию true) - при обнаружении смены uidValidity у каталога принудительно начинает загружать все сообщения из каталога с самого первого. `keep_unseen` (по умолчанию false) - переключение в true оставляет неизменным признак непрочитанности письма. `store_raw_as_file` (по умолчанию true) - переключение в false отменяет сохранение исходного содержания полученного письма (RFC-822) в качестве файла-вложения к сущности. `store_html_as_file` (по умолчанию true) - переключение в false отменяет сохранение html-раздела из полученного письма в качестве файла-вложения к сущности.
`deleteOnServer`	Выключатель режима автоматического удаления письма с сервера после получения. По умолчанию 'false'. В случае отказа от удаления система помнит и использует идентификатор последнего полученного письма и заказывает получение следующих писем.
`sendOnly`	Выключатель режима синхронизации для получения писем. Каталог может не существовать на IMAP сервере. Для всех каталогов IMAP сервера - `false`. Для виртуального каталога отправки сообщений, автоматически создаваемого для аккаунтов с признаком 'isSystem' - `true`.
`flags`	Список IMAP-флагов каталога. Подставляется автоматически при создании каталога во время синхронизации с IMAP-сервером. Не следует изменять автоматически сформированное значение.