Модуль ввода с электронной почты предназначен для захвата документов, поступающих по электронной почте. Модуль захватывает тексты сообщений, а также картинки из текстов писем и вложенные документы.
Модуль может работать с почтовыми серверами, поддерживающими протоколы MAPI (MS Exchange), IMAP, POP3. Протокол POP3 является устаревшим, использовать его не рекомендуется.
Ввод документов с электронной почты представлен на схеме:
Алгоритм работы модуля ввода с электронной почты:
1. | В почтовый ящик, указанный в настройках модуля ввода с электронной почты, поступают сообщения. |
2. | Чтобы отобрать из входящих писем только необходимые, на почтовом сервере используется фильтрация с помощью правил. Подходящие сообщения отправляются в папку, из которой осуществляется захват. |
3. | Модуль ввода с электронной почты проверяет новые входящие сообщения через заданный в конфигурационном файле промежуток времени. |
4. | После захвата модуль ввода с электронной почты удаляет сообщения с почтового сервера или помечает их прочитанными. Действие над сообщениями определяется режимом захвата, заданном в конфигурационном файле службы ввода. |
5. | Модуль ввода с электронной почты отправляет файлы в линию для их дальнейшей упаковки. |
Примечание
Не рекомендуется оставлять обработанные сообщения в папке ввода, так как это уменьшает быстродействие ввода и может привести к некорректной работе.
Модуль ввода с электронной почты может получить и отправить в линию один или несколько файлов. Возможные варианты:
• | файл с текстом сообщения. Формат файла зависит от формата входящего сообщения. Если сообщение передано в текстовом формате, то файл будет иметь формат TXT. Если сообщение передано в формате HTML, то файл будет иметь формат HTML. Если сообщение передано в форматах HTML и TXT, то будет создано 2 файла в HTML и TXT форматах; |
• | файлы с вложениями; |
• | файлы с текстом сообщения и вложениями. |
Вместе с файлом модуль ввода с электронной почты передает в линию метаданные об устройстве ввода и метаданные об экземплярах ввода в виде XML-файлов. Подробнее см. разделы «DeviceInfo.xml», «InstanceInfos.xml».
Секция Mail
Секция Mail предназначена для настройки модуля ввода с электронной почты. В файле настроек нужно создавать секцию для каждого почтового адреса, сообщения с которого необходимо отправлять в конечную систему.
Структура секции:
<Mail SenderLine="MailCaptureLine" >
<clear />
<add
Name="MailCapture"
MailReceivePeriodInSeconds="600"
SenderLine="MailCaptureLine"
TempFolder="C:\DCS\MailCapture\Temp"
IncludeMailBody="True"
IncludeAttachments="True"
SeparateLineForEachSender="False"
MessageBodyEncoding=""
UpdateHtmlCharsetOnMessageBodyEncoding="False"
CaptureMode="Delete" >
<Server>
<clear />
<add Name="Type" Value="MAPI" />
<add Name="ProfileName" Value="ExchangeOrOutlookProfileName" />
<add Name="BodyEncodingGatheringStrategy" Value="Default" />
<add Name="Folder" Value="" />
<add Name="MaxCount" Value="100" />
</Server>
</add>
</Mail>
Примечание
Можно указать несколько экземпляров ввода с электронной почты.
SenderLine – имя линии по умолчанию для обработки сообщений со всех почтовых ящиков, если в настройке ящика не указана другая линия. Указывается имя экземпляра линии из секции Lines. Параметр является обязательным.
add – настройка экземпляра ввода с электронной почты:
• | Name. Уникальное имя экземпляра ввода. |
• | MailReceivePeriodInSeconds. Интервал в секундах, через который модуль ввода проверяет новые сообщения на почтовом сервере. Параметр является необязательным. Значение по умолчанию 600. |
• | SenderLine. Имя линии для обработки сообщений. Укажите линию из тега Lines файла CaptureService.exe.config. Параметр является необязательным. Если значение не указано, используется линия по умолчанию. |
• | TempFolder. Папка временных файлов. Параметр является обязательным. |
• | IncludeMailBody. Признак добавления текста сообщения в пакет для отправки в конечную систему. Возможные значения: True, False. Параметр является необязательным. Значение по умолчанию True. |
• | IncludeAttachments. Признак добавления вложений в пакет для отправки в конечную систему. Возможные значения: True, False. Параметр является необязательным. Значение по умолчанию True. |
Один из параметров IncludeMailBody и IncludeAttachments должен иметь значение True. Если в обоих параметрах указано значение False, то в лог-файл службы ввода будут записываться ошибки ввода с электронной почты.
• | SeparateLineForEachSender. Признак создания линий для каждого отправителя. Укажите, как создавать линии для каждого отправителя: |
• | True – сообщения от каждого отправителя обрабатывать отдельной линией; |
• | False – сообщения от всех отправителей обрабатывать одной линией. |
Значение по умолчанию False.
• | MessageBodyEncoding. Кодировка, в которой сохраняется текст сообщения. Если параметр не заполнен, то текст сообщения сохраняется в исходной кодировке. |
• | UpdateHtmlCharsetOnMessageBodyEncoding. Признак обновления кодировки сообщений. Обновляется атрибут Charset в HTML-содержимом сообщения при его перекодировке. Возможные значения: True, False. Параметр является необязательным. Значение по умолчанию False. |
• | CaptureMode. Режим работы захвата сообщений: |
• | Delete – захватываются и удаляются все сообщения из папки; |
• | MarkAsRead – захватываются непрочитанные сообщения из папки и помечаются прочитанными. |
Server – настройки почтового сервера.
add – добавление настроек почтового сервера:
• | Name. Имя настройки соединения с сервером. Обязательная настройка Type определяет тип почтового сервера. После нее указываются настройки, соответствующие выбранному типу сервера. Подробный список настроек для каждого сервера см. в разделе «Метод Logon – выполнить вход на сервер». |
• | Value. Значение настройки почтового сервера. Возможные значения для настройки Type: MAPI, IMAP, POP3. |
Настройки для MAPI
MAPI – сервер для получения почты по протоколу Extended MAPI. Протокол используется в почтовых программах Microsoft Exchange или Outlook.
Структура секции Server с набором настроек MAPI:
<Server>
<clear/>
<add Name="Type" Value="MAPI"/>
<add Name="ProfileName" Value="ExchangeOrOutlookProfileName"/>
<add Name="BodyEncodingGatheringStrategy" Value="Default"/>
<add Name="Folder" Value="DCS MAPI Folder"/>
<add Name="MaxCount" Value="100"/>
</Server>
add – добавление настроек почтового сервера:
• | Name. Имя настройки. Подробный список настроек для каждого сервера см. в разделе «Метод Logon – выполнить вход на сервер». |
• | Value. Значение настройки. |
Примечание
Для настройки Folder указывается имя подпапки, вложенной во входящие. Например, <add Name="Folder" Value="DCS MAPI Folder"/>. Важен регистр символов. Регистр, который используется в имени папки, указанной в настройках, должен совпадать с регистром, который используется в имени папки, откуда захватываются письма.
Необязательный параметр. Если имя папки не указано, то выполняется поиск писем в папке «Входящие».
Рекомендуется указывать значение параметра для повышения быстродействия при получении писем.
Настройки для IMAP
IMAP – сервер для получения почты по протоколу IMAP.
Структура секции Server с набором настроек IMAP:
<Server>
<clear/>
<add Name="Type" Value="IMAP"/>
<add Name="Server" Value="imaphost"/>
<add Name="Port" Value="143"/>
<add Name="User" Value="imapuser"/>
<add Name="Password" Value="password"/>
<add Name="EncryptionMode" Value="OptionalExplicit"/>
<add Name="EncryptionVersion" Value="TLSv1"/>
<add Name="ConnectTimeOut" Value="0"/>
<add Name="ReadTimeOut" Value="-1"/>
<add Name="Folder" Value="DCS IMAP Folder"/>
<add Name="MaxCount" Value="100"/>
</Server>
add – добавление настроек почтового сервера:
• | Name. Имя настройки. Подробный список настроек для каждого сервера см. в разделе «Метод Logon – выполнить вход на сервер». |
• | Value. Значение настройки. |
Примечание
Если заполняется необязательная настройка Folder, то для нее указывается имя папки в корне. Например, <add Name="Folder" Value="DCS IMAP Folder"/>. Или указывается имя подпапки, вложенной во входящих (указывается как Inbox/Имя подпапки). Если настройка не указана, то выполняется поиск писем в папке «Входящие».
Рекомендуется указывать настройку для повышения быстродействия при получении писем.
Настройки для POP3
POP3 – сервер для получения почты по протоколу POP3.
Структура секции Server с набором настроек POP3:
<Server>
<clear/>
<add Name="Type" Value="POP3"/>
<add Name="Server" Value="pop3host"/>
<add Name="Port" Value="110"/>
<add Name="User" Value="pop3user"/>
<add Name="Password" Value="password"/>
<add Name="EncryptionMode" Value="OptionalExplicit"/>
<add Name="EncryptionVersion" Value="TLSv1"/>
<add Name="ConnectTimeOut" Value="0"/>
<add Name="ReadTimeOut" Value="-1"/>
<add Name="MaxCount" Value="100"/>
</Server>
add – добавление настроек почтового сервера:
• | Name. Имя настройки. Подробный список настроек для каждого сервера см. в разделе «Метод Logon – выполнить вход на сервер». |
• | Value. Значение настройки. |
© Компания Directum, 2020 | Сообщество пользователей Directum |