ConsumeIMAP

文档中心 › 组件索引 › ConsumeIMAP

ConsumeIMAP Processor

类型全限定名：cn.org.acal.lynxus.processors.email.ConsumeIMAP

所属 Bundle：cn.org.acal.lynxus:lynxus-email-nar:2.11.8

描述

使用 IMAP 协议使用来自电子邮件服务器的消息。 每封收到的电子邮件的原始字节被写入 FlowFile 的内容

标签

EmailImapGetIngestIngressMessageConsume

属性

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称默认值可选值描述
Host Name电子邮件服务器的网络地址（例如，pop.gmail.com、imap.gmail.com ......）
支持表达式语言：是（仅使用环境/系统变量求值）
Port标识电子邮件服务器端口的数值（例如 993）
支持表达式语言：是（仅使用环境/系统变量求值）
Authorization Modepassword-based-authorization-mode
  • Use Password — 使用密码
  • Use OAuth2 — 使用 OAuth2 获取访问令牌
如何授权代表用户发送电子邮件。
OAuth2 Access Token Provider控制器服务 API：
OAuth2AccessTokenProvider
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8		可以提供访问令牌的 OAuth2 服务。
User Name用于通过电子邮件服务器进行身份验证和授权的用户名。
支持表达式语言：是（仅使用环境/系统变量求值）
Password用于与电子邮件服务器进行身份验证和授权的密码。
敏感属性：是
支持表达式语言：是（仅使用环境/系统变量求值）
FolderINBOX用于从中检索消息的电子邮件文件夹（例如 INBOX）
支持表达式语言：是（仅使用环境/系统变量求值）
Fetch Size10指定每次调用电子邮件服务器时要获取的最大消息数。
支持表达式语言：是（仅使用环境/系统变量求值）
Delete Messagesfalse
  • true
  • false
指定邮件消息在检索后是否应删除。
Connection Timeout30 sec等待连接到电子邮件服务器的时间
支持表达式语言：是（仅使用环境/系统变量求值）
Mark Messages as Readfalse
  • true
  • false
指定消息在检索后是否应标记为已读。
Use SSLtrue
  • true
  • false
指定是否必须通过 SSL 加密连接（即 IMAPS）获取 IMAP 连接

关系 (Relationships)

名称描述自动终止
success从电子邮件服务器成功接收并转换为 FlowFiles 的所有消息都将路由到此关系否

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件不允许有传入连接。

详细说明

ConsumeIMAP

说明

该 Processor 通过 IMAP 协议消费邮件，并把邮件内容作为 FlowFile 的内容发送。传入邮件的内容会以原始字节的形式 写入输出 FlowFile 的内容。

不同的邮件服务商可能需要额外的 Java Mail 属性，这类属性 可以通过动态属性提供。例如，以下是 GMail 的示例配置：

Processor 的静态属性：

  • Host Name - imap.gmail.com
  • Port - 993
  • User Name - [你的用户名]
  • Password - [你的密码]
  • Folder - INBOX

Processor 的动态属性：

  • mail.imap.socketFactory.class - javax.net.ssl.SSLSocketFactory
  • mail.imap.socketFactory.fallback - false
  • mail.store.protocol - imaps

另一个有用的属性是 mail.debug，它允许 Java Mail API 把协议消息打印到控制台，帮助你了解运行状况并调试问题。

可用 Java Mail 属性的完整列表参见 这里

© 2026 ACAL Organization. Licensed under Apache License 2.0.