Массовая рассылка

Примечание

Добавлено в версии 2.7.0 микросервиса ecos-notifications

1. Общие сведения

Массовая рассылка позволяет отправить уведомления пользователям через конфигурирование сообщений администратором системы.

Данный функционал может использоваться для системных уведомлений о технических работах, информационных сообщений или любых других рассылок.

Особенности:

  • отправка уведомлений большому количеству пользователей за счёт возможности разбиения получателей на партии;

  • добавление получателей в копию, скрытую копию;

  • отложенная отправка;

  • получение реципиентов из разных источников, редактирование реципиентов до отправки;

  • установление текста уведомлений напрямую;

  • подгрузка текста уведомления из заготовленных шаблонов с последующей корректировкой;

  • отправка уведомлений по шаблону с выбором базового рекорда;

  • просмотр статуса рассылки.

Примечание

В массовой рассылке заложена возможность отправки уведомлений через разные провайдеры - email, mobile push, sms и т.д.
На текущий момент реализована только отправка email. В будущем, для поддержки других провайдеров, необходимо реализовать получение разных адресов отправки в зависимости от типа уведомления.

Отсутствие подключения к SMTP серверу не блокирует работу микросервиса.
Все письма, которые нужно отправить, складываются в БД, и как только подключение восстановится, будут отправлены адресатам.

2. Создание массовой рассылки

Массовые рассылки располагаются в инструментах администратора, блок «Конфигурация уведомлений», журнал «Массовая рассылка».

2.1 Форма

../../_images/bulk_mail_form_1.png

2.2 Описание полей

Поле

Описание

Имя

Имя массовой рассылки

Сводка уведомлений

Сводка по количеству уведомлений в разных статусах, относящихся к текущей рассылке.

Шаблон уведомления

Отправка уведомления по выбранному шаблону уведомления.

Record уведомления

Если выбран шаблон уведомлений, то можно выбрать базовый recordRef для расчёта модели шаблона уведомления.

Заголовок

Прямое установление заголовка уведомления.

Тело сообщения

Прямое установление тела сообщения через редактор richText.

Оргструктура

Выбор получателей сообщения из компонента оргструктуры. Возможно выбрать конкретных пользователей или группу.

Пользовательский ввод получателей

Ввод получателей через указание прямого адреса (на данный момент только email) или userName пользователя. Разделители - ,, ;, пробел, перевод на строку - \n. Например, данное поле может использоваться для вставки списка получателей копированием из excel.

Тип уведомления

Выбор типа уведомления - email, mobile push, sms и т.д. На данный момент реализован только email.

Язык

Язык уведомления для выбранного шаблона уведомления

Всех получателей в копию

Если выбрано, то все получатели будут добавлены в копию (cc)

Всех получателей в скрытую копию

Если выбрано, то все получатели будут добавлены в скрытую копию (bcc)

Отложенная отправка

Планируемая дата отправки. Если пусто, уведомления доступны обработчику очереди после действия 3.2.2 Отправить сообщения, без дополнительной задержки по дате.

Размер пакета

Размер пакета при разбиении рассылки по получателям.
Например, если размер равен 0, то будет отправлено одно сообщение. Если получателей 10, а размер равен 2, то будет отправлено 5 сообщений.
Эта опция может быть полезна, если почтовый сервер не может обработать отсылку сообщения большому количеству получателей в одном сообщении.

Персонализированная рассылка

Отдельное сообщение на каждый адрес. Флаг сам по себе не добавляет индивидуальные атрибуты получателя в модель; при включении имеет приоритет над размером пакета.

Примечание

Через кнопку Загрузить текст из шаблона можно подгрузить заголовок и тело сообщения (см. поля выше) из заготовленного шаблона.

2.3 Примеры пакетной рассылки

Ниже будут описаны примеры логики обработки пакетной рассылки для более детального понимания.

Предположим, что в рассылке 1_000 получателей, тип уведомления - email, тогда:

Настройка

Результат

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

Будет отправлено одно сообщение, в котором в поле to будет 1_000 адресов.

Персонализированная рассылка

Будет отправлено 1_000 сообщений, в поле to по одному адресу.

Персонализированная рассылка + Всех получателей в копию/Всех получателей в скрытую копию

По одному адресу будет добавлено в cc или bcc соответственно, при этом в to будет пусто.

Размер пакета = 50

Будет отправлено 20 сообщений, в поле to по 50 адресов.

Размер пакета = 50 + Всех получателей в копию/Всех получателей в скрытую копию

По 50 адресов будет добавлено в cc или bcc соответственно, при этом в to будет пусто.

Некоторые почтовые серверы плохо обрабатывают большое количество писем в одном сообщении. С помощью пакетной обработки можно решить эту проблему.
Например, типичная задача - Отправить информационное сообщение большому количеству пользователей, при этом пользователи не должны видеть других получателей решается установлением размера пакета и флага Всех получателей в скрытую копию.

Режимы CC и BCC выбирайте раздельно. Если оба флага установлены одновременно, используется CC.

3. Жизненный цикл массовой рассылки

После создания, массовая рассылка переходит в статус «Новый», на котором можно сформировать получателей, скорректировать их и запланировать отправку.

3.1 Статусы

Статусы устанавливаются в приоритете описания:

Статус

Условие установки

Новый

Массовая рассылка создана.

Осуществляются попытки отправки

Устанавливается, если хотя бы у одного сообщения при отправке произошла временная ошибка и по нему ещё выполняются повторные попытки отправки.

Ожидается отправка

Устанавливается, если хотя бы одно сообщение массовой рассылки находится в статусе «Ожидание отправки».

Ошибка

Устанавливается, когда по рассылке не осталось сообщений в работе и хотя бы одно из них завершилось неудачей: постоянной ошибкой (статус FAILED) или исчерпанием бюджета повторов (статус EXPIRED).

Отправлено

Обработка завершена без FAILED и EXPIRED. Возможны итоговые состояния BLOCKED, CANCELLED, RECIPIENTS_NOT_FOUND и частичная доставка отдельного письма. Это не гарантия получения сообщения каждым адресатом.

Примечание

Удаление массовой рассылки отменяет её сообщения, ожидающие отправки и находящиеся в статусе ERROR: запланированные повторные попытки по ним останавливаются.

Удаление не отзывает уже принятое почтовым сервером письмо и не гарантирует остановку сетевой отправки, которая уже началась.

3.2 Действия

3.2.1 Сформировать получателей

Выбранные получатели на форме массовой рассылки являются заготовкой для формирования конечного списка получателей.

По умолчанию, на форме есть возможность выбрать получателей из компонента оргструктуры и ручного ввода (см. 2.2 Описание полей).
При этом, заложена возможность получить дополнительных реципиентов из кастомного источника. (см. 4. Дополнительные источники формирования получателей)

При выполнении действия «Формирование получателей» происходит сбор получателей из разных источников и формирование уникальных реципиентов по адресу. В результате можно посмотреть и скорректировать список сформированных получателей в журнале «Получатели»:

../../_images/bulk_mail_recipients_journal.png

Журнал получателей поддерживает удаление и простой текстовый поиск через ИЛИ.

Примечание

При каждом запуске действия «Сформировать получателей» происходит удаление старых получателей и формирование новых.

3.2.2 Отправить сообщения

Действие «Отправить сообщения» создаёт записи WAIT_FOR_DISPATCH для сформированного списка получателей. Доставка выполняется обработчиком очереди с учётом отложенной даты и загрузки сервиса. При пустом итоговом списке сообщений действие завершается ошибкой.

В результате действия будут сформированы уведомления в журнале «Уведомления» (см. Описание уведомлений), в котором можно посмотреть информацию о сформированных сообщениях и так же их статус.

../../_images/bulk_mail_notifications_journal.png

При разрешении пользователей и групп проверяются personDisabled и наличие email. Прямые email и адреса custom providers не проходят ту же проверку пользовательской записи: отключение пользователя не запрещает безусловно отправку на его адрес из любого источника.

4. Дополнительные источники формирования получателей

Получение дополнительных получателей осуществляется через records dao, который при queryOne запросе атрибута recipients[]?json, должен вернуть список объектов в формате:

RecipientInfo
data class RecipientInfo(

    @AttName("address")
    var address: String? = "",


    @AttName(".disp")
    var disp: String? = "",

    @AttName("record")
    var record: RecordRef? = RecordRef.EMPTY

)
Запрос дополнительных получателей
val query = RecordsQuery.Builder()
            .withQuery(bulkMail.recipientsData.custom)
            .withSourceId(provider)
            .withMaxItems(1)
            .build()

recordsService.queryOne(query, "recipients[]?json").asList(RecipientInfo::class.java)

Перечисление records-источников устанавливается через ecos config с id bulk-mail-custom-recipients-providers.

Дополнительные источники вызываются только при непустом recipientsData.custom.

Ecos config: bulk-mail-custom-recipients-providers
id: bulk-mail-custom-recipients-providers
value:
    - notifications/custom-fixed-recipients
    - notifications/custom-mail-recipients

Указанному источнику, для вычисления получателей, можно передать необходимую информацию в query. Информация, передаваемая в query берется из bulkMailRecord.recipientsData.custom, где custom это ObjectData.
Например, объект custom можно заполнить на переопределённой форме bulk mail, внутри контейнера recipientsData, создав вложенный контейнер custom. Таким образом, все, что будет заполнено внутри custom, будет передано в query объекте, источнику records.

В итоге, при формировании получателей, будет вызван records api метод queryOne с переданным query, для каждого указанного источника в конфиге bulk-mail-custom-recipients-providers.