Email Receive端口

Version 24.2.9039

Email Receive端口

Email Receive 端口，支持从 IMAP 邮件服务器检索邮件。

概览

Email Receive 端口提供了一种自动化接收电子邮件的简单方法。端口连接到指定的 IMAP 服务器，并轮询指定的邮箱以处理新消息。默认情况下，该端口仅接收尚未处理的消息，并支持其它 IMAP 过滤条件。

端口支持接收 EML 格式的消息，或仅下载待处理的电子邮件附件。

端口配置

本文包含所有可配置的端口属性。

配置

邮件接收配置

与建立连接相关的设置.

端口 Id 端口的静态、唯一标识符。
端口类型 显示端口类型及其用途的描述。
端口描述 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。

IMAP 连接

与建立 IMAP 服务器连接相关的设置。

服务器 IMAP 服务器的主机名称或 IP 地址。
端口连接到 IMAP 服务器的端口。大多值包括 143 和 993。
邮箱 IMAP 邮箱以轮询消息。
TLS 类型 连接到服务器时如何启用 TLS／SSL。当设置为 “STARTTLS” 时，将建立明文连接，然后用显式命令启动 TLS/SSL。当设置为 “TLS/SSL” 时，将立即启用 TLS／SSL，无需建立明文连接，当设置为 “None” 时不启用 TLS／SSL。

认证

与认证连接相关的设置.

{:.table}{:.table}

用户登录 IMAP 服务器的用户名。
认证机制 在 Basic 和 OAuth 2.0 之间进行选择。选项根据选择而变化。
密码（Basic）IMAP 服务器的密码。
认证 URL (OAuth 2.0) 服务的授权 URL。这是在单击“连接”按钮登录并授予应用程序权限时定向到的 URL。
访问令牌 URL (OAuth 2.0) 访问令牌的 URL。
客户端 Id (OAuth 2.0) 注册 OAuth 时分配的客户端 ID。
客户端密码 (OAuth 2.0) 注册 OAuth 时分配的密钥。
授权范围 (OAuth 2.0) 应用程序应有权访问的范围列表。
回调 URL (OAuth 2.0) 连接到的服务返回令牌以提供访问权限的 URL。服务通常要求将允许的 URL 列入白名单，因此这是在服务中配置应用程序注册时要使用的值。

下载

与下载相关的设置.

新消息 是否只处理新消息。这通常是通过跟踪下载消息的 UID 来控制的。如果 UID 值变得无效，端口将回退到使用上次处理的消息的时间戳或查找天数设置（如果尚未处理任何消息）。
查找天数 搜索邮件的天数。如果选中 仅处理新消息，则仅当端口无法按 UID 或上次处理消息的时间戳进行搜索时，才会使用此值。
附加搜索过滤条件 提供符合 IMAP RFC 的搜索过滤器，以附加到基于 新邮件 和 搜索天数 设置自动构建的查询。
下载类型 选择下载 EML 格式的完整邮件消息或仅下载电子邮件附件。
删除邮件 是否从邮箱中删除成功下载的邮件。
删除后清除 是否永久删除标记为删除的电子邮件。重要：如果选择此选项，则无法恢复已删除的电子邮件。

自动化

自动化配置

与端口自动处理文件相关的设置。

接收端口是否应自动轮询远程邮箱以下载消息。
接收间隔 自动下载的时间间隔。
分每次执行等待的分钟数。仅当执行间隔被设置为 Minute 时适用。
第几分钟/小时 每小时计划的分钟偏移量。仅当执行间隔被设置为 Hourly 时适用。例如，如果将此值设置为 5，将在 1:05、2:05、3:05 自动执行脚本。
时在指定的某一天内进行消息处理的时间。仅当执行间隔被设置为 Daily 或 Weekly 或 Monthly 时适用。
天进行消息处理的某一天。仅当执行间隔被设置为 Weekly 或 Monthly 时适用。
Cron 表达式 表示 cron 表达式的任意字符串，用于确定何时执行。仅当执行间隔被设置为 Advanced 时适用。

通知

与配置警报和服务等级协议 (SLA) 相关的设置。

端口邮件设置

在执行 SLA 之前，需要设置电子邮件警报以获取通知。单击 配置通知 将打开一个新的浏览器窗口，转到系统设置，可以在其中设置系统范围的警报。有关详细信息，请参阅通知。

服务等级协议 (SLA) 配置

SLA 能够配置期望工作流中的端口发送或接收的数量，并设置期望满足该数量的时间范围。知行之桥在不满足 SLA 时发送电子邮件警告用户，并将 SLA 标记为 有风险，这意味着如果很快不满足 SLA，则会将其标记为 已违反。这使用户有机会介入并确定未满足 SLA 的原因，并采取适当的措施。如果在风险时间段结束时仍未满足 SLA，则将 SLA 标记为违反，并再次通知用户。

要定义 SLA，请单击 添加预期数量条件。

如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 所属的方向。
将 期待至少 设置为期望处理的最小交易数量（交易量），然后使用每字段指定时间范围。
默认情况下，SLA 每天都有效。要更改此设置，请取消选中每日，然后选中想要的一周中的几天的框。
使用 将状态设置为“有风险” 来指示何时应将 SLA 标记为存在风险。
默认情况下，在违反 SLA 之前不会发送通知。要更改此设置，请选中 发送“有风险”通知。

以下示例显示为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。如果尚未收到 1000 个文件，则会在该时间段结束前 1 小时发送风险通知。

高级设置

代理配置

这些是一组设置的集合，用于识别代理并对其进行身份验证，Email Receive 连接应通过该代理进行路由。默认情况下，此部分使用设置页面上的全局设置。清除该复选框可提供特定于的端口的设置。

代理类型 基于代理的防火墙使用的协议。
代理主机 基于代理的防火墙的名称或 IP 地址。
代理端口 基于代理的防火墙的 TCP 端口。
代理用户 用于通过基于代理的防火墙进行身份验证的用户名。
代理密码 用于对基于代理的防火墙进行身份验证的密码。
身份验证方案 保留默认值 None 或选择以下身份验证方案之一：Basic、Digest、Proprietary或NTLM。

高级设置

不包括在之前类别中的设置。

IMAP 标题信息 IMAP 消息标题中的逗号分隔列表，应将其升级为下载文件中的元数据。
收件服务器公钥证书 用于验证 TLS/SSL 服务器身份的公钥证书。如果目标服务器使用TLS/SSL，则将此字段设置为标识服务器的证书。如果服务器的证书不可用，可以将此设置留空以允许底层 OS/JVM 执行证书验证，或将其设置为 “Any Certificate” 以隐式信任服务器的身份。
命令超时时间（秒） 命令执行超时持续时间（以秒为单位）。
本地文件名格式 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏来包含标识符和时间戳等信息。有关详细信息，请参阅宏。

消息

消息设置 确定端口如何搜索消息并在处理后管理它们。可以将消息保存到你的 已发送 文件夹，或者可以根据 已发送 文件夹方案将它们保存，如下所述。

保存至 Sent 文件夹 选中此选项可将端口处理的文件复制到端口的已发送文件夹中。
已发送文件夹方案 端口根据选定的时间间隔对已发送文件夹中的文件进行分组。例如，选项每周（Weekly）指示端口每周创建一个新的子文件夹，并将本周发送的所有文件存储在该文件夹中。空白设置告诉端口将所有文件直接保存在“Sent”文件夹中。对于处理许多事务的端口，使用子文件夹可以帮助保持文件有序并提高性能。

日志

日志级别 端口生成的日志的详细程度。当端口请求支持时，请将其设置为调试。
日志子文件夹方案 指端口根据选定的时间间隔对日志文件夹中的文件进行分组。例如，Weekly 选项表示端口每周创建一个新子文件夹并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在 Logs 文件夹中。对于处理大量事务的端口，使用子文件夹有助于保持日志井井有条并提高性能。
保留消息副本 选中此项可使已处理文件的日志条目包含文件本身的副本。如果禁用此功能，端口可能无法从输入或输出选项卡下载文件的副本。

特殊设置

特殊设置 适用于特定用例。

其他设置 允许在以分号分隔的列表中配置隐藏的端口设置，例如setting1=value1;setting2=value2。正常的端口用例和功能不需要使用这些设置。

建立连接

建立与 IMAP 服务器的网络连接需要以下设置：

服务器
端口
TLS 类型

测试连接按钮可以验证端口是否可以到达服务器。

建立网络连接后，需要以下设置才能访问 IMAP 服务器上存储的消息：

用户名
密码或者 OAuth 2.0 认证
邮箱

接收邮件

如果启用了自动接收，则 Email Receive 端口将自动轮询配置的 IMAP 邮箱以下载消息。默认情况下，端口将仅接收尚未下载的消息。但是，端口第一次收到消息时，需要通过“查找天数”设置指定要下载的消息范围。

单击端口“输出”选项卡中的接收按钮，可以手动检索消息。

下载类型 设置确定将下载完整邮件还是仅邮件附件。下载的文件将放置在 Receive 文件夹 中或发送到工作流中的下一个连接的端口。

搜索过滤器

附加搜索过滤条件 允许进一步设置要检索的消息范围。此字段接受标准 IMAP 协议过滤规则，仅下载与过滤规则匹配的邮件。

支持以下过滤器:

<message set>	消息序列号对应于指定消息序列号集的消息
ALL	邮箱中的所有邮件 —— 此为默认值
ANSWERED	设置了 \Answered 标志的消息
BCC <string>	信封结构的密件抄送字段中包含指定字符串的消息
BEFORE <date>	内部日期早于指定日期的消息。
BODY <string>	消息正文中包含指定字符串的消息
CC <string>	在信封结构的抄送字段中包含指定字符串的消息
DELETED	设置了 \Deleted 标志的消息
DRAFT	设置了 \Draft 标志的消息
FLAGGED	设置了 \Flagged 标志的消息
FROM <string>	在信封结构的“发件人”字段中包含指定字符串的消息
HEADER <field-name> <string>	具有带有指定字段名（如在 [RFC-822] 中定义的）的报头并且在 [RFC-822] 字段体中包含指定字符串的消息
KEYWORD <flag>	具有指定关键字集的消息
LARGER <n>	带有 RFC822 的消息。大小大于指定的八位字节数
NEW	设置了 \Recent 标志但未设置 \SEEN 标志的消息。此功能 "(RECENT UNSEEN)".
NOT <search-key>	与指定搜索关键字不匹配的消息
OLD	未设置 \Recent 标志的消息。此功能相当于 "NOT RECENT" (相对于 "NOT NEW").
ON <date>	内部日期在指定日期内的消息
OR <search-key1> <search-key2>	匹配任一搜索关键字的消息
RECENT	设置了 \Recent 标志的消息
SEEN	设置了 \Seen 标志的消息
SENTBEFORE <date>	[RFC-822] 日期:标题早于指定日期的消息
SENTON <date>	[RFC-822] 日期:标题在指定日期内的消息
SENTSINCE <date>	[RFC-822] 日期:标题在指定日期之内或之后的消息
SINCE <date>	内部日期在指定日期之内或之后的消息
SMALLER <n>	带有 RFC822 的消息。大小小于指定的八位字节数
SUBJECT <string>	信封结构的 SUBJECT 字段中包含指定字符串的消息
TEXT <string>	消息头或消息正文中包含指定字符串的消息
TO <string>	在信封结构的“收件人”字段中包含指定字符串的消息
UID <message set>	具有对应于指定唯一标识符集的唯一标识符的消息
UNANSWERED	未设置 \Answered 标志的消息
UNDELETED	未设置 \Deleted 标志的消息
UNDRAFT	未设置 \Draft 标志的消息
UNFLAGGED	未设置 \Flagged 标志的消息
UNKEYWORD <flag>	没有指定关键字集的消息
UNSEEN	未设置 \Seen 标志的消息

宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。

知行之桥支持这些宏，它们都使用以下语法：%Macro%。

宏	描述
ConnectorID	替换为端口的 ConnectorID。
Ext	替换为端口当前正在处理的文件的文件扩展名。
Filename	替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt	替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId	计算端口输出的消息的 MessageId。
RegexFilename:pattern	将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:headername	替换为端口正在处理的当前消息的目标消息头 (`headername`) 的值。
LongDate	以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate	以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:format	以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅示例日期格式
Vault:vaultitem	计算指定保管库项目的值。
Subject	替换为端口当前收到的电子邮件的主题。

示例

某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：%Macro:argument%

以下是带有参数的宏的一些示例：

%Header:headername%：其中 headername 是消息上消息头的名称。
%Header:mycustomheader% 解析为输入消息上设置的 mycustomheader 消息头的值。
%Header:ponum% 解析为输入消息上设置的 ponum 消息头的值。
%RegexFilename:pattern%：其中“pattern”是正则表达式模式。例如，%RegexFilename:^([\w][A-Za-z]+)% 匹配并解析为文件名中的第一个单词，并且不区分大小写（test_file.xml解析为test）。
%Vault:vaultitem%：其中 vaultitem 是 vault 中项目的名称。例如，%Vault:companyname%解析为存储在保管库中的companyname项的值。
%DateFormat:format%：其中 format 是可接受的日期格式（有关详细信息，请参阅示例日期格式）。例如，%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%解析为文件上的日期和时间戳。

还可以创建更复杂的宏，如以下示例所示：

将多个宏组合在一个文件名中：%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
包括宏之外的文本：MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
在宏中包含文本： %DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%