Email Receive端口

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

核心功能

基于 IMAP 的邮件轮询，支持现代服务商的 OAuth 2.0 认证
具备符合 IMAP RFC 标准的搜索过滤器，实现高级过滤
支持仅下载附件或下载完整邮件
可配置的邮件保留与删除策略

概览

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

Outlook 和 Gmail 邮件服务器的 OAuth 2.0 配置是 Email Receive 端口中最常见的两种连接配置。

端口配置

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

设置

邮件接收配置

与建立连接相关的设置。

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

建立连接

要允许知行之桥接收电子邮件，必须先建立 Email Receive 连接。建立后，该连接可以在多个 Email Receive 端口之间共享。建立此连接有以下几种方式：

在流程中添加一个 Email Receive 端口。然后使用 Connection 下拉菜单选择现有连接，或点击 Create 添加新连接。
打开知行之桥 系统设置 页面，然后打开 Connections 选项卡。点击 Add，选择 Email Receive，然后点击 Next。
如果通过此方式创建连接，仍需在端口的 Connection 下拉菜单中选择该连接。

完成以下属性配置：

设置	描述
Host	IMAP 服务器的主机名或 IP 地址。
Port	连接到 IMAP 服务器的端口。典型值包括 143 和 993。
TLS Type	连接到服务器时用于协商 SSL/TLS 的方法： STARTTLS：先建立明文连接，然后可以通过显式命令启动 SSL/TLS。 SSL/TLS：无需先建立明文连接，立即进行协商。 None (Plain Text)：建立明文连接，不使用 SSL/TLS。
User	登录 IMAP 服务器的用户名。
Authentication Mechanism	用于登录服务器的身份验证类型。可用选项会根据你的选择而变化。
Password	（Basic 和 NTLM）IMAP 服务器的密码。
Auth URL	（OAuth 2.0）服务的授权 URL。点击 Connect 按钮登录并授予应用程序权限时，会定向到此 URL。
Access Token URL	（OAuth 2.0）访问令牌的 URL。
Client Id	（OAuth 2.0）注册 OAuth 时分配的客户端 Id。
Client Secret	（OAuth 2.0）注册 OAuth 时分配的密钥。
Scope	（OAuth 2.0）应用程序应有权访问的作用域列表。
Callback URL	（OAuth 2.0）所连接服务返回令牌以提供访问权限的 URL。服务通常要求你将允许的 URL 加入白名单，因此在服务中配置应用程序注册时应使用此值。

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

Host
Port
TLS Type

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

User
Password 或 OAuth 2.0 身份验证凭据
Mailbox

使用 Add and Test 按钮验证端口是否可以连接到服务器。

下载

与处理消息相关的设置。

设置	描述
Mailbox	用于轮询消息的 IMAP 邮箱。
Only process new messages	勾选此项以仅处理新消息。这通常通过跟踪已下载消息的 UID 来控制。如果 UID 值变为无效，端口会回退到使用上次处理消息的时间戳，或在尚未处理任何消息时使用 Days to Search 设置。
Days to Search	搜索消息的天数。如果勾选 Only process new messages，则仅当端口无法按 UID 或上次处理消息的时间戳搜索时，才会使用此值。
Additional Search Filters	提供符合 IMAP RFC 的搜索过滤器，以附加到基于 New Messages 和 Days to Search 设置自动构建的查询。
Download Type	选择下载 EML 格式的完整邮件消息或仅下载电子邮件附件。
Delete Emails	勾选此项以从邮箱中删除成功下载的消息。
Expunge After Delete	勾选此项以从邮箱中永久删除成功下载的电子邮件。警告：服务器可能会立即永久删除（清除）消息，使其无法恢复。

高级页面

高级设置

前面类别中未包含的设置。

设置	描述
IMAP Headers	IMAP 消息头中以逗号分隔的列表，这些消息头应提升为下载文件中的元数据。
Incoming Server Public Certificate	用于验证 TLS/SSL 服务器身份的公钥证书。如果目标服务器使用 TLS/SSL，请将此字段设置为标识服务器的证书。如果服务器证书不可用，可以将此设置留空以允许底层 OS/JVM 执行证书验证，或将其设置为 `Any Certificate` 以隐式信任服务器身份。
Command Timeout (seconds)	命令执行超时时间，以秒为单位。
TLS Enabled Protocols	建立出站连接时支持的 TLS/SSL 协议列表。最佳做法是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有在合作伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未被普遍采用，如果目标服务器不支持它，可能会被拒绝。
本地文件方案	用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符和时间戳等信息。有关更多信息，请参阅宏。

代理配置

这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用安全设置页面的代理设置部分中的全局设置。清除此复选框可为您的端口提供特定的设置。

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

消息

消息设置确定端口如何搜索消息并在处理后管理它们。

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

设置

描述

保存到已发送文件夹

选中此项可将端口处理的文件复制到该端口的“已发送”文件夹中。

已发送文件夹方案

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

日志

用于管理日志创建和存储的设置。

设置	描述
日志级别	指定要记录在端口日志目录中的信息类型： None - 不创建任何日志。 Error - 仅当端口遇到错误时才创建日志。 Warning - 仅当端口发出警告时才创建日志。 Info - 记录工作流的一般信息，包括任何错误和警告（如果适用）。 Debug - 记录成功和失败工作流的详细调试信息。 Trace - 记录成功和失败工作流的详细跟踪信息。请注意：Debug 和 Trace 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
日志文件夹结构	指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，Weekly 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
保留消息副本	指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。

其他设置

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

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

自动化

自动化设置

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

设置	描述
Receive	端口是否应自动轮询远程邮箱以下载消息。
Interval	自动下载尝试之间的间隔。
Minutes Past the Hour	小时计划的分钟偏移量。仅当上面的间隔设置为 Hourly 时适用。例如，如果此值设置为 5，自动化服务会在 1:05、2:05、3:05 等时间下载。
Time	应执行尝试的当天时间。仅当上面的间隔设置为 Daily、Weekly 或 Monthly 时适用。
Day	应执行尝试的日期。仅当上面的间隔设置为 Weekly 或 Monthly 时适用。
Minutes	尝试下载前等待的分钟数。仅当上面的间隔设置为 Minute 时适用。
Cron Expression	表示 cron 表达式的五段字符串，用于确定何时执行尝试。仅当上面的间隔设置为 Advanced 时适用。

警报

SLA

交易

此选项卡列出与该端口关联的所有消息。使用搜索栏查找特定消息，或点击漏斗图标应用过滤器。可以按跟踪消息头、时间和/或状态进行过滤。

接收邮件

如果启用了 Receive Automation，Email Receive 端口会自动轮询配置的 IMAP 邮箱以下载消息。默认情况下，端口只接收尚未下载的消息。端口第一次接收消息时，请使用下载配置部分中的 Days to Search 设置来指定要下载的消息范围。也可以点击端口 Transactions 选项卡上的 Receive 按钮手动检索消息。 Download Type 设置决定下载完整邮件还是仅下载邮件附件。下载的文件会放置在 Output Folder 中，或传递到流程中的下一个端口。当 Download Type 设置为 Attachments 时，端口会向每条消息添加两个消息头：

EmailReceive-Attachment-Index：每个附件的附件编号
EmailReceive-Attachment-Count：电子邮件中的附件总数

搜索过滤器

IMAP Search Filter 设置允许进一步自定义要检索的消息范围。此字段接受标准 IMAP 协议过滤器，并且仅下载与配置的过滤器匹配的消息。支持以下过滤器：

过滤器	描述
`<message set>`	消息序列号对应于指定消息序列号集的消息。
ALL	邮箱中的所有消息：这是用于 AND 组合的默认初始关键字。
ANSWERED	设置了 `\Answered` 标志的消息。
BCC `<string>`	信封结构的 BCC 字段中包含指定字符串的消息。
BEFORE `<date>`	内部日期早于指定日期的消息。
BODY `<string>`	消息正文中包含指定字符串的消息。
CC `<string>`	信封结构的 CC 字段中包含指定字符串的消息。
DELETED	设置了 `\Deleted` 标志的消息。
DRAFT	设置了 `\Draft` 标志的消息。
FLAGGED	设置了 `\Flagged` 标志的消息。
FROM `<string>`	信封结构的 FROM 字段中包含指定字符串的消息。
HEADER `<field-name> <string>`	具有指定字段名（如 [RFC-822] 中定义）的消息头，并且 [RFC-822] 字段正文中包含指定字符串的消息。
KEYWORD `<flag>`	设置了指定关键字的消息。
LARGER `<n>`	RFC822.SIZE 大于指定八位字节数的消息。
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] Date: 消息头早于指定日期的消息。
SENTON `<date>`	[RFC-822] Date: 消息头在指定日期内的消息。
SENTSINCE `<date>`	[RFC-822] Date: 消息头在指定日期之内或之后的消息。
SINCE `<date>`	内部日期在指定日期之内或之后的消息。
SMALLER `<n>`	RFC822.SIZE 小于指定八位字节数的消息。
SUBJECT `<string>`	信封结构的 SUBJECT 字段中包含指定字符串的消息。
TEXT `<string>`	消息头或消息正文中包含指定字符串的消息。
TO `<string>`	信封结构的 TO 字段中包含指定字符串的消息。
UID `<message set>`	唯一标识符对应于指定唯一标识符集的消息。
UNANSWERED	未设置 `\Answered` 标志的消息。
UNDELETED	未设置 `\Deleted` 标志的消息。
UNDRAFT	未设置 `\Draft` 标志的消息。
UNFLAGGED	未设置 `\Flagged` 标志的消息。
UNKEYWORD `<flag>`	未设置指定关键字的消息。
UNSEEN	未设置 `\Seen` 标志的消息。

入门指南

工作流

EDI 交易伙伴管理控制台

端口

映射

系统 API

操作指南

脚本编写

软件许可和第三方版权

核心功能

概览

端口配置

设置

邮件接收配置

建立连接

下载

高级页面

高级设置

代理配置

消息

日志

其他设置

自动化

自动化设置

警报

SLA

交易

接收邮件

搜索过滤器

宏

示例

​核心功能

​概览

​端口配置

​设置

​邮件接收配置

​建立连接

​下载

​高级页面

​高级设置

​代理配置

​消息

​日志

​其他设置

​自动化

​自动化设置

​警报

​SLA

​交易

​接收邮件

​搜索过滤器

​宏

​示例

核心功能

概览

端口配置

设置

邮件接收配置

建立连接

下载

高级页面

高级设置

代理配置

消息

日志

其他设置

自动化

自动化设置

警报

SLA

交易

接收邮件

搜索过滤器

宏

示例