Интеллектуальные возможности > Служба ввода документов > Настройка службы ввода > Настройка модуля ввода с электронной почты

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

ВАЖНО. В примерах указаны пути до папок по умолчанию. В appsettings.json пути указываются только из docker-контейнера службы ввода документов.

Структура секции:

"Mail": {
    "DefaultLine": "DefaultSimpleLine",
    "Instances": [
      {
        "Name": "MailEwsCapture",
        "MailReceivePeriodInSeconds": 600,
        "Line": "DocumentsToProgramLine",
        "TempFolder": "Mail/MailEwsCaptureTemp",
        "IncludeMailBody": "True",
        "IncludeAttachments": "True",
        "IncludeMailBodyImages": "True",
        "SeparateLineForEachSender": "False",
        "MessageBodyEncoding": "",
        "UpdateHtmlCharsetOnMessageBodyEncoding": "False",
        "CaptureMode": "MarkAsRead",
        "Server": {
           "Type": "EWS",
           "Server": "https://exchange.example.com/ews/exchange.asmx",
           "Domain": "",
           "User": "user",
           "Password": "password",
           "Timeout": -1,
           "Folder": "SubFolderName",
           "MaxCount": 100
         }
      }
  ]
},

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

Name. Имя варианта захвата, с помощью которого вводятся документы с электронной почты.

MailReceivePeriodInSeconds. Интервал времени, через который модуль ввода с электронной почты обращается к почтовому серверу для захвата сообщений. Необязательный параметр. Задается в секундах, значение по умолчанию 600.

Line. Имя линии для обработки сообщений с указанного почтового ящика. В качестве значения параметра следует указывать одну из линий, перечисленных в теге Lines файла настроек. Необязательный параметр. Если значение параметра не указано, для обработки сообщений используется линия, указанная в теге DefaultLine секции Mail.

TempFolder. Обязательный параметр. Полный или относительный путь к папке для временных файлов модуля ввода с электронной почты. Во втором случае путь задается относительно папки, указанной в параметре RootWorkingFolder.

IncludeMailBody. Признак включения текста сообщения в пакет для отправки в систему. Необязательный параметр. Возможные значения:

•True – для Exchange Server текст сообщения включается в пакет в виде текстового файла и файла в формате HTML. При использовании протокола POP3 текст включается в пакет в том виде, в котором его отправил почтовый клиент. Установлено по умолчанию;

•False – текст сообщения не включается в пакет.

IncludeAttachments. Признак включения вложений в пакет для отправки в систему. Необязательный параметр. Возможные значения:

•True – вложения включаются в пакет. Установлено по умолчанию;

•False – вложения не включаются в пакет.

Один из параметров IncludeMailBody и IncludeAttachments должен иметь значение True. Если оба параметра принимают значение False, то в журнал событий Windows записываются ошибки ввода с электронной почты.

IncludeMailBodyImages. Признак включения в пакет изображений, содержащихся в тексте письма. Настройка задается, если в параметре IncludeAttachments указано значение True. Возможные значения:

•True – изображения включаются в пакет. Установлено по умолчанию;

•False – изображения не включаются в пакет.

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

•True – сообщения от каждого отправителя обрабатываются независимо и не попадают в один пакет;

•False – сообщения обрабатываются совместно и попадают в один пакет. Установлено по умолчанию.

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

Возможные значения: utf-8, utf-16, windows-1251, ASMO-708, DOS-720, DOS-862, EUC-JP, IBM‑Thai, IBM00858, IBM00924, IBM01047, IBM01140, IBM01141, IBM01142, IBM01143, IBM01144, IBM01145, IBM01146, IBM01147, IBM01148, IBM01149, IBM037, IBM1026, IBM273, IBM277, IBM278, IBM280, IBM284, IBM285, IBM290, IBM297, IBM420, IBM423, IBM424, IBM437, IBM500, IBM855, IBM860, IBM863, IBM864, IBM865, IBM870, IBM871, IBM880, IBM905, Johab, big5, cp1025, cp866, cp875, gb2312, ibm737, ibm775, ibm850, ibm852, ibm857, ibm861, ibm869, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, macintosh, us-ascii, utf-16BE, utf-32, utf-32BE, windows-1250, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874, x-Chinese-CNS, x-Chinese-Eten, x-Europa, x-IA5, x-IA5-German, x-IA5-Norwegian, x-IA5-Swedish, x-cp20001, x-cp20003, x-cp20004, x-cp20005, x-cp20261, x-cp20269, x-cp20936, x-cp20949, x-ebcdic-koreanextended, x-mac-arabic, x-mac-ce, x-mac-chinesetrad, x-mac-croatian, x-mac-cyrillic, x-mac-greek, x-mac-hebrew, x-mac-icelandic, x-mac-japanese, x-mac-romanian, x-mac-thai, x-mac-turkish, x-mac-ukrainian.

Необязательный параметр. По умолчанию принимает пустое значение.

UpdateHtmlCharsetOnMessageBodyEncoding. Признак обновления кодировки сообщений. При перекодировке сообщения в его HTML-содержимом обновляется атрибут Charset. Возможные значения: True, False. Необязательный параметр. Значение по умолчанию False.

CaptureMode. Режим работы захвата сообщений:

•Delete – захватываются и удаляются все сообщения из папки;

•MarkAsRead – захватываются непрочитанные сообщения из папки и помечаются прочитанными.

Server – настройки почтового сервера.

Type. Тип почтового сервера. Возможные значения: EWS, IMAP, POP3.

После указываются настройки, соответствующие выбранному типу сервера.

Настройки для EWS

EWS – сервер для получения почты по протоколу Exchange Web Services (EWS). Протокол используется в почтовых программах, например, Microsoft Exchange или Outlook.

Структура секции Server с набором настроек EWS:

"Server": {
  "Type": "EWS",
  "Server": "https://exchange.example.com/ews/exchange.asmx",
  "Domain": "",
  "User": "user",
  "Password": "password",
  "Timeout": -1,
  "Folder": "SubFolderName",
  "MaxCount": 100
}

Подробный список настроек см. в разделе «Параметры настройки почтовых серверов».

Настройки для IMAP

IMAP – сервер для получения почты по протоколу IMAP.

Структура секции Server с набором настроек IMAP:

"Server": {
  "Type": "IMAP",
  "Server": "imaphost",
  "Port": 143,
  "User": "imapuser",
  "Password": "password",
  "EncryptionMode": "OptionalExplicit",
  "EncryptionVersion": "TLSv1",
  "Timeout": -1,
  "Folder": "INBOX",
  "MaxCount": 100
}

Подробный список настроек см. в разделе «Параметры настройки почтовых серверов».

Примечание. Если заполняется необязательная настройка Folder, то для нее указывается имя корневой папки. Например, "Folder":"DCS IMAP Folder". Или имя подпапки, вложенной во входящие: "Inbox/Имя подпапки". Если настройка не указана, то выполняется поиск писем в папке «Входящие». Рекомендуется указывать настройку для повышения быстродействия при получении писем.

Настройки для POP3

POP3 – сервер для получения почты по протоколу POP3.

Структура секции Server с набором настроек POP3:

"Server": {
  "Type": "POP3",
  "Server": "pop3host",
  "Port": 110,
  "User": "pop3user",
  "Password": "password",
  "EncryptionMode": "OptionalExplicit",
  "EncryptionVersion": "TLSv1",
  "Timeout": -1,
  "MaxCount": 100
}

Подробный список настроек см. в разделе «Параметры настройки почтовых серверов».

Пример настройки модуля ввода с электронной почты в Directum RX

Чтобы настроить занесение документов в систему из выделенного ящика электронной почты, в файле appsettings.json в секции Mail заполните параметры:

•Server – адрес почтового сервера;

•User – имя пользователя для подключения к почтовому серверу;

•Password – пароль пользователя для подключения к почтовому серверу.

Пример:

"Mail": {
  "DefaultLine": "DefaultSimpleLine",
  "Instances": [
    {
      ...
      "Server": {
        "Type": "EWS",
        "Server": "https://exchange.example.com/ews/exchange.asmx",
        "User": "user",
        "Password": "password",
         ...
      }
    }

СМ. ТАКЖЕ