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

Почтовые уведомления в системе реализованы при помощи плагина сервиса Chronos. Для их настройки необходимо внести данные о способе доставки уведомлений в файл app.json, который находится в папке Chronos. Существует два способа доставки почтовых уведомлений – SMTP и Exchange.

Warning

Если необходимо, чтобы в почтовом уведомлении помимо обычной ссылки на карточку (ссылка на открытие карточки в desktop-клиенте Tessa) была также и ссылка для открытия карточки в Web клиенте, то требуется прописать Базовый адрес web-клиента в карточке настроек сервера.

Настройки SMTP

Для настройки SMTP необходимо в параметре NoticeMailer.Mode указать значение "Smtp", а также заполнить остальные параметры, название которых начинается с NoticeMailer.Smtp***:

В простом случае, когда в организации используется smtp-сервер c Windows аутентификацией, достаточно задать только параметр SmtpHost. Если требуется явно задать логин/пароль пользователя, укажите также параметры SmtpUserName, SmtpPassword.

Для настройки smtp используются следующие параметры:

• SmtpPickupDirectoryLocation

  Настройки для выгрузки почты в папку (используется для тестирования). В параметре указывается либо абсолютный путь: "C:\\Tessa\\MailDrop" (не забывайте про эскейпинг символа обратного слэша, т.е. пишем \\ вместо одного \, это часть стандарта JSON), либо относительный "MailDrop", тогда путь рассчитывается относительно папки с плагинами Chronos\Plugins\Tessa.

  Если настройка SmtpPickupDirectoryLocation имеет указанную папку (непустая) и в NoticeMailer.Mode указано "Smtp", то файлы писем выгружаются в эту папку. Если же указано "Smtp", но папка - пустая строка "" или null, то почта отправляется по настройкам NoticeMailer.Smtp***.

• SmtpHost

  Задает имя почтового SMTP-сервера. У данного атрибута нет значения по умолчанию.

• SmtpPort

  Задает номер порта, используемый для подключения к почтовому SMTP - серверу. Значение по умолчанию - 25.

• SmtpEnableSsl

  Задает, используется ли протокол SSL для доступа к почтовому SMTP - серверу. Значение по умолчанию - false.

• SmtpDefaultCredentials

  Указывает, следует ли использовать учетные данные пользователя по умолчанию для доступа к SMTP-серверу для SMTP-транзакций. Значение по умолчанию - false.

• SmtpUserName

  Задает имя пользователя, используемое для проверки подлинности на почтовом SMTP - сервере. У данного атрибута нет значения по умолчанию.

• SmtpPassword

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

• SmtpClientDomain

  Определяет имя домена клиента, используемое запросом протокола SMTP для подключения к почтовому SMTP-серверу. У данного атрибута нет значения по умолчанию, что соответствует домену локального компьютера. Также вы можете явно указать имя localhost локального компьютера, отправляющего запрос.

• SmtpFrom

  Адрес, с которого будет производиться рассылка сообщений. Если указана пустая строка (по умолчанию), то используется настройка SmtpUserName.

• SmtpFromDisplayName

  Задаёт имя сервиса, от которого рассылаются все почтовые уведомления (имя, которое будет отображать в письме как Отправитель).

• SmtpTimeout

  Таймаут подключения сервиса Chronos к SMTP-серверу в миллисекундах. Значение "0" означает таймаут по умолчанию, принятый в .NET, на текущей версии это 100 секунд (значение "100 000").

Настройки Exchange

Для настройки Exchange необходимо в параметре NoticeMailer.Mode указать значение "Exchange", также необходимо заполнить следующие параметры подключения к Exchange серверу:

• ExchangeOAuth

Ключ API, сгенерированный на сервере Exchange для аутентификации OAuth. Если указан, то логин/пароль ниже игнорируются.

• ExchangeUser

Задает имя пользователя, используемое для проверки подлинности на почтовом Exchange-сервере. Параметр является необязательным, если используется аутентификация OAuth (параметр ExchangeOAuth должен быть непустой) или Windows аутентификация (параметр ExchangeOAuth пустой).

• ExchangePassword

Задает пароль, используемый для проверки подлинности на почтовом Exchange–сервере. Пароль является необязательным, если на Exchange–сервере используется Windows аутентификация.

• ExchangeServer

Задает адрес почтового Exchange-сервера (необязательный параметр). Если параметр не задан, сервис Chronos осуществит попытку автоматического определения адреса Exchange-сервера по имени пользователя, в этом случае имя должно быть указано в параметре ExchangeUser.

• ExchangeVersion

Задает версию почтового Exchange-сервера, что определяет минимальную версию протокола, который должен поддерживать сервер Exchange. Не указывайте более новую версию, чем фактически используемая. Значение по умолчанию: Exchange2010. Другие возможные значения (проверьте, что ваш сервер Exchange обновлён до этой версии): Exchange2010_SP1, Exchange2010_SP2, Exchange2013, Exchange2013_SP1, Exchange2015, Exchange2016.

• ExchangeFrom

  Адрес, с которого будет производиться рассылка сообщений. Если указана пустая строка (по умолчанию), то используется настройка ExchangeUser.

• ExchangeFromDisplayName

  Задаёт имя сервиса, от которого рассылаются все почтовые уведомления (имя, которое будет отображать в письме как Отправитель).

Настройки мобильного согласования

Мобильное согласование - это модуль системы, который рассылает пользователям на электронную почту расширенные уведомления с возможностью выполнять действия с заданиями по ссылкам в письме, такие как ссылки для согласования/не согласования документа, для подписания/отказа в подписании, для завершения задач и др.

Warning

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

Для настройки получения сервисом ответных писем мобильного согласования необходимо сначала указать режим MobileApproval.Mode - "Exchange", "IMAP" или "POP3", и далее указать настройки в соответствии с выбранным режимом.

Описание параметров можно посмотреть выше, в разделах настройки SMTP и Exhange, они аналогичны. На рисунке ниже зеленым выделены настройки, относящиеся к POP3, синим - Exchange:

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

1. В карточке “Настройки сервера” (см. Руководство администратора - Настройки сервера) прописать Email для мобильного согласования - адрес почтового ящика, куда необходимо отсылать ответные письма. Именно с этого почтового ящика будет выполняться скачивание писем из папки “Входящие” и выполнение действий, указанных в письмах, от имени сотрудника-отправителя письма.

2. В карточке “Лицензия” (см. Руководство администратора - Настройка лицензий) указать сотрудников, кому будут высылаться расширенные уведомления с возможностью мобильного согласования. В карточке этих сотрудников должно быть заполнено поле “Email”.

Прочие настройки

Параметр	Описание
NoticeMailer.NumberOfMessagesToProcessAtOnce	Количество обрабатываемых сообщений за один запуск NoticeMailer’а.
NoticeMailer.MaxAttemptsBeforeDelete	Количество неудачных попыток отправки сообщения до того, как оно будет удалено из папки исходящих сообщений.
NoticeMailer.RetryIntervalMinutes	Интервал времени, который должен пройти прежде, чем будет совершена новая попытка отправки сообщения, по которому произошла ошибка отправки.
NoticeMailer.MaxFilesSizeEmail	Максимально допустимый общий размер всех приложенных к письму файлов. Указывается в килобайтах.
NoticeMailer.MaxNumberWorkingProcesses	Максимальное количество потоков, которые используются для параллельной отправки почты. Рекомендуется использовать значение по умолчанию "1", чтобы письма отправлялись последовательно. При больших объёмах отправляемой почты её отправку можно ускорить за счёт параллельности, для этого следует увеличить значение в настройке, но не более, чем количество физических ядер (например, для 4-ядерного процессора установите значение "4").