30.4.2. 查询参数(66 参数)


Name描述默认类型

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由 Error Handler,这意味着在消费者尝试获取传入的消息时发生任何异常,或像这样一样处理,消息现在将被作为消息进行处理,并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 处理异常,该处理程序将记录在 WARN 或 ERROR 级别并忽略。

false

布尔值

closeFolder (consumer)

轮询后,消费者是否应该关闭文件夹。将此选项设置为 false,并且具有 disconnect=false,然后消费者保持在轮询之间保持文件夹打开。

true

布尔值

copyTo (consumer)

处理邮件消息后,可以使用指定名称将其复制到邮件文件夹。您可以覆盖此配置值,使用带有键 copyTo 的标头,允许您将消息复制到运行时配置的文件夹名称。

 

字符串

decodeFilename (consumer)

如果设置为 true,则使用 MimeUtility.decodeText 方法来解码文件名。这类似于设置 JVM 系统属性 mail.mime.encodefilename。

false

布尔值

delete (consumer)

在消息被处理后删除它们。这可以通过在邮件消息上设置 DELETED 标志来完成。如果为 false,则设置 SEEN 标志。自 Camel 2.10 起,您可以通过设置键 delete 的标头来决定是否应删除邮件是否应该删除。

false

布尔值

disconnect (consumer)

轮询后使用者是否应该断开连接。如果启用它,它会强制 Camel 在每次轮询时连接。

false

布尔值

handleFailedMessage (consumer)

如果邮件使用者无法检索给定邮件邮件,则此选项允许处理由消费者的错误处理程序导致异常。通过在消费者上启用网桥错误处理程序,Camel 路由错误处理程序可以改为处理异常。默认行为是消费者引发异常,来自批处理的任何邮件都无法通过 Camel 进行路由。

false

布尔值

maxMessagesPerPoll (consumer)

指定每个轮询要收集的最大消息数。默认情况下不设置最大值。可用于设置诸如 1000 的限制,以避免在服务器启动时下载数千个文件。将值设为 0 或负数可禁用这个选项。

 

int

mimeDecodeHeaders (consumer)

此选项为邮件标头启用透明 MIME 解码和取消折叠数据。

false

布尔值

moveTo (consumer)

处理邮件消息后,可使用指定名称将其移动到邮件文件夹。您可以覆盖此配置值,使用键 moveTo 的标头,允许您将消息移到运行时配置的文件夹名称。

 

字符串

peek (consumer)

将 javax.mail.Message 标记为 peeked,然后处理邮件。这只适用于 IMAPMessage 消息类型。如果使用 peek 邮件,邮件将不会在邮件服务器上标记为 SEEN,如果 Camel 中存在错误处理,则让我们可以回滚邮件消息。

true

布尔值

sendEmptyMessageWhenIdle (consumer)

如果轮询消费者没有轮询任何文件,您可以启用这个选项来发送空消息(无正文)。

false

布尔值

skipFailedMessage (consumer)

如果邮件使用者无法检索给定邮件邮件,则此选项允许跳过消息并继续检索下一个邮件。默认行为是消费者引发异常,来自批处理的任何邮件都无法通过 Camel 进行路由。

false

布尔值

unseen (消费者)

是否只通过未识别邮件来限制。

true

布尔值

exceptionHandler (consumer (advanced))

要让消费者使用自定义 ExceptionHandler。请注意,如果选项 bridgeErrorHandler 已启用,则不会使用这个选项。默认情况下,消费者处理异常,该消费者在 WARN 或 ERROR 级别上记录并忽略。

 

ExceptionHandler

exchangePattern (consumer (advanced))

在消费者创建交换时设置交换模式。

枚举值:

  • InOnly
  • InOut
  • InOptionalOut
 

ExchangePattern

fetchSize (consumer (advanced))

设置轮询过程中要消耗的最大消息数。如果邮箱文件夹包含大量邮件,这可用于避免过载邮件服务器。默认值 -1 表示没有获取大小,所有消息都将被消耗。将值设为 0 是一个特殊的基点,Camel 根本不消耗任何消息。

-1

int

folderName (consumer (advanced))

要轮询的文件夹。

INBOX

字符串

mailUidGenerator (consumer (advanced))

可插拔 mailUidGenerator,允许使用自定义逻辑来生成邮件的 UUID。

 

MailUidGenerator

mapMailMessage (consumer (advanced))

指定 Camel 是否应将收到的邮件消息映射到 Camel 正文/headers/attachments。如果设置为 true,邮件邮件正文将映射到 Camel IN 邮件的正文,邮件标题将映射到 IN 标头,附件则映射到 Camel IN attachment 消息。如果此选项设为 false,则 IN 消息包含 raw javax.mail.Message。You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class).

true

布尔值

pollStrategy (consumer (advanced))

可插入的 org.apache.camel.PollingConsumerPollingStrategy 可让您提供自定义实施来控制错误处理,在创建 Exchange 被创建并在 Camel 中路由前通常会发生。

 

PollingConsumerPollStrategy

postProcessAction (consumer (advanced))

在正常处理结束后,指的是 mailBoxPostProcessAction 在邮箱中处理后任务。

 

MailBoxPostProcessAction

bcc (producer)

设置 BCC 电子邮件地址。使用逗号分隔多个电子邮件地址。

 

字符串

cc (producer)

设置 CC 电子邮件地址。使用逗号分隔多个电子邮件地址。

 

字符串

from (producer)

来自电子邮件地址。

camel@localhost

字符串

lazyStartProducer (producer)

制作者是否应该启动 lazy(在第一个消息上)。通过启动 lazy,您可以使用它来允许 CamelContext 和路由在启动期间启动,否则在启动期间出现问题,并导致路由启动失败。通过将这个启动延迟到 lazy 后,可以在通过 Camel 的路由错误处理程序路由消息期间处理启动失败。注意在处理第一个消息时,创建并启动制作者可能花费较少的时间,从而延长处理的总处理时间。

false

布尔值

replyTo (producer)

Reply-To 接收者(响应邮件的接收器)。使用逗号分隔多个电子邮件地址。

 

字符串

subject (producer)

发送的消息的主题。注意:在标头中设置主题优先于这个选项。

 

字符串

to (producer)

设置 To 电子邮件地址。使用逗号分隔多个电子邮件地址。

 

字符串

javaMailSender (producer (advanced))

使用自定义 org.apache.camel.component.mail.JavaMailSender 来发送电子邮件。

 

JavaMailSender

additionalJavaMailProperties (advanced)

设置其他 java 邮件属性,它将根据所有其他选项附加/覆盖任何默认设置。如果您需要添加一些特殊选项,但希望让其他内容保留原样,这很有用。

 

Properties

alternativeBodyHeader (advanced)

指定包含替代电子邮件正文的 IN 消息标题的键。例如:如果您以文本/html 格式发送电子邮件,并且想要为非 HTML 电子邮件客户端提供替代邮件正文,请将此密钥的备选邮件正文设置为标题。

CamelMailAlternativeBody

字符串

attachmentsContentTransferEncodingResolver (advanced)

要使用自定义附件ContentTransferEncodingResolver 来解析要用于附件的内容类型代码。

 

AttachmentsContentTransferEncodingResolver

authenticator (advanced)

登录验证器。如果设置,则忽略密码和用户名。可以为令牌使用,这些令牌可到期,因此必须动态读取。

 

MailAuthenticator

binding (advanced)

设置用于从 Camel 消息转换为邮件消息的绑定。

 

MailBinding

connectionTimeout (advanced)

连接超时(以毫秒为单位)。

30000

int

contentType (advanced)

邮件消息内容类型。将 text/html 用于 HTML 邮件。

text/plain

字符串

contentTypeResolver (advanced)

用于为文件附加确定 Content-Type 的解析器。

 

ContentTypeResolver

debugMode (advanced)

在底层邮件框架上启用调试模式。默认情况下,SUN 邮件框架将调试消息记录到 system.out。

false

布尔值

headerFilterStrategy (advanced)

使用自定义 org.apache.camel.spi.HeaderFilterStrategy 过滤标头。

 

HeaderFilterStrategy

ignoreUnsupportedCharset (advanced)

让 Camel 在发送邮件时忽略本地 JVM 中不支持的 charset 选项。如果不支持 charset,则 charset=XXX(其中 XXX 代表不受支持的 charset)已从 content-type 中删除,它依赖于平台默认值。

false

布尔值

ignoreUriScheme (advanced)

让 Camel 在发送邮件时忽略本地 JVM 中不支持的 charset 选项。如果不支持 charset,则 charset=XXX(其中 XXX 代表不受支持的 charset)已从 content-type 中删除,它依赖于平台默认值。

false

布尔值

javaMailProperties (advanced)

设置 java 邮件选项。将清除任何默认属性,并且仅使用为此方法提供的属性。

 

Properties

会话 (高级)

指定 camel 应该用于所有邮件交互的邮件会话。在由某些其他资源创建和管理邮件会话时(如 JavaEE 容器)的情景中非常有用。使用自定义邮件会话时,将使用邮件会话中的主机名和端口(如果在会话上配置)。

 

session

useInlineAttachments (advanced)

是否使用对内联还是附加。

false

布尔值

idempotentRepository (filter)

可插入的存储库 org.apache.camel.spi.IdempotentRepository,它允许从同一邮箱消耗集群,并让存储库协调邮件是否对消费者而言有效。默认情况下,不使用任何存储库。

 

IdempotentRepository

idempotentRepositoryRemoveOnCommit (filter)

使用幂等存储库时,当邮件消息被成功处理并提交后,则应将消息 ID 从幂等存储库(默认)中删除,或保留在存储库中。默认情况下,它假定消息 id 是唯一的,并且没有要保留在存储库中的值,因为邮件消息将被标记为 seen/moved 或 delete,以防止它被再次消耗。因此,使消息 id 存储在幂等存储库中的值较小。但是,这个选项允许存储消息 id,因为您可能具有的任何原因。

true

布尔值

searchTerm (filter)

引用 javax.mail.search.SearchTerm,它可根据搜索条件(如主题、正文等)过滤邮件。

 

SearchTerm

backoffErrorThreshold (scheduler)

后续错误轮询次数(因为一些错误),在 backoffMultipler 应启动前应该发生。

 

int

backoffIdleThreshold (scheduler)

在 backoffMultipler 应启动前应进行的后续空闲轮询数量。

 

int

backoffMultiplier (scheduler)

如果一行中有多个后续的空闲/错误,则计划轮询消费者 backoff。倍数是,在下一次实际尝试再次发生前跳过的轮询数。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。

 

int

delay (scheduler)

下一个轮询前毫秒。

60000

long

greedy (scheduler)

如果启用了 greedy,则 ScheduledPollConsumer 将立即再次运行,如果上一运行轮询了 1 或更多消息。

false

布尔值

initialDelay (scheduler)

在第一次轮询开始前毫秒。

1000

long

repeatCount (scheduler)

指定最大触发数量的限制。因此,如果您将其设置为 1,调度程序将仅触发一次。如果将其设置为 5,它将仅触发五次。值为零或负表示永久触发。

0

long

runLoggingLevel (scheduler)

使用者在轮询时记录 start/complete 日志行。此选项允许您为其配置日志级别。

枚举值:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • OFF

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

允许配置要用于使用者的自定义/共享线程池。默认情况下,每个消费者都有自己的单一线程线程池。

 

ScheduledExecutorService

调度程序 (scheduler)

使用来自 camel-spring 或 camel-quartz 组件中的 cron 调度程序。使用值 spring 或 quartz 在调度程序中构建。

none

对象

schedulerProperties (scheduler)

要在使用自定义调度程序或任何基于 Spring 的调度程序时配置额外的属性。

 

map

startScheduler (scheduler)

调度程序是否应自动启动。

true

布尔值

timeUnit (scheduler)

初始延迟和延迟选项的时间单位。

枚举值:

  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • 分钟
  • HOURS

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。

true

布尔值

密码 (安全性)

登录密码。另请参阅 setAuthenticator(MailAuthenticator)。

 

字符串

sslContextParameters (security)

使用 SSLContextParameters 配置安全性。

 

SSLContextParameters

username (security)

登录的用户名。另请参阅 setAuthenticator(MailAuthenticator)。

 

字符串

sortTerm (sort)

消息排序顺序。仅支持 IMAP 的原生支持。使用 POP3 或 IMAP 服务器没有 SORT 功能时可模拟到某种程度。

 

SortTerm[]

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.