217.3.2. 查询参数(62 参数):
Name | 描述 | 默认 | 类型 |
---|---|---|---|
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由 Error Handler,这意味着使用者试图获取传入消息或类似信息时出现任何异常,现在将作为一个消息进行处理,并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.Exception 处理程序处理异常,该处理程序将记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
关闭Folder (consumer) | 消费者是否应在轮询后关闭文件夹。将此选项设置为 false,也设置 disconnect=false,然后消费者在轮询之间保持打开的文件夹。 | true | 布尔值 |
copyTo (consumer) | 处理邮件后,可以使用指定名称将其复制到邮件文件夹中。您可以使用键 copyTo 的标头覆盖这个配置值,允许您将消息复制到运行时配置的文件夹名称。 | 字符串 | |
删除 (消费者) | 在处理消息后删除消息。这可以通过在邮件上设置 DELETED 标志来完成。如果为 false,则设置 SEEN 标志。从 Camel 2.10 开始,您可以通过使用密钥删除设置标头来覆盖该配置选项,以确定是否应删除邮件。 | false | 布尔值 |
断开连接 (消费者) | 轮询后使用者是否应断开连接。如果启用此项强制 Camel 在每次轮询上进行连接。 | false | 布尔值 |
handleFailedMessage (consumer) | 如果邮件使用者无法检索给定的邮件,则此选项允许处理消费者的错误处理程序所造成的异常。通过在使用者上启用网桥错误处理程序,Camel 路由错误处理程序可以改为处理异常。默认行为是使用者会抛出异常,并且 Camel 无法路由批处理中的邮件。 | false | 布尔值 |
maxMessagesPerPoll (consumer) | 指定每个轮询收集的最大消息数。默认情况下不设置最大值。可用于设置 e.g. 1000 的限制,以避免在服务器启动时下载数千个文件。将值设为 0 或负数可禁用此选项。 | int | |
mimeDecodeHeaders (consumer) | 此选项为邮件标头启用透明的 MIME 解码并取消折叠。 | false | 布尔值 |
peek (consumer) | 在处理邮件邮件之前,请将 javax.mail.Message 标记为peeked。这只适用于 IMAPMessage 消息类型。通过使用 peek 邮件将不会在邮件服务器上标记为 SEEN,这允许我们在 Camel 中进行错误处理时回滚邮件。 | true | 布尔值 |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用这个选项来发送空消息(无正文)。 | false | 布尔值 |
skipFailedMessage (consumer) | 如果邮件使用者无法检索给定的邮件,则此选项将允许跳过该邮件并继续检索下一个邮件。默认行为是使用者会抛出异常,并且 Camel 无法路由批处理中的邮件。 | false | 布尔值 |
unseen (消费者) | 是否仅通过未发送邮件进行限制. | true | 布尔值 |
exceptionHandler (消费者) | 要让使用者使用自定义 ExceptionHandler。请注意,如果启用了选项 bridgeErrorHandler,则不使用这个选项。默认情况下,消费者处理异常,这将在 WARN 或 ERROR 级别记录,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在使用者创建交换时设置交换模式。 | ExchangePattern | |
fetchSize (consumer) | 设置轮询期间要消耗的最大消息数。如果邮箱文件夹包含大量邮件,则这可用于避免过载邮件服务器。默认值 -1 表示没有获取大小,并且所有信息都会被消耗。将值设为 0 是一个特殊情况,Camel 将不会消耗任何信息。 | -1 | int |
folderName (consumer) | 要轮询的文件夹。 | INBOX | 字符串 |
mailUidGenerator (消费者) | 可插拔 mailUidGenerator,允许使用自定义逻辑来生成邮件的 UUID。 | MailUidGenerator | |
mapMailMessage (consumer) | 指定 Camel 是否应将接收的邮件信息映射到 Camel body/headers。如果设置为 true,邮件正文将映射到 Camel IN 消息的正文,邮件标题映射到 IN 标头。如果此选项设置为 false,则 IN 消息包含一个原始 javax.mail.Message。您可以通过调用 exchange.getIn ().getBody (javax.mail.Message.class)来检索此原始消息。 | true | 布尔值 |
pollStrategy (consumer) | 可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作中通常会发生错误处理,然后再在 Camel 中创建并被路由。 | PollingConsumerPoll 策略 | |
postProcessAction (consumer) | 指的是邮件BoxPostProcessAction,用于在普通处理结束之后在邮箱上处理任务。 | MailBoxPostProcess Action | |
BCC (生成器) | 设置 BCC 电子邮件地址。使用逗号分隔多个电子邮件地址。 | 字符串 | |
cc (生成器) | 设置 CC 电子邮件地址。使用逗号分隔多个电子邮件地址。 | 字符串 | |
来自于 (生成的) | 来自电子邮件地址 | camel@localhost | 字符串 |
replyTo (生成器) | Reply-To 收件人(响应邮件的接收器)。使用逗号分隔多个电子邮件地址。 | 字符串 | |
主题 (生产者) | 所发送消息的使用者。注意:在标头中设置主题优先于这个选项。 | 字符串 | |
至于 (生成的) | 设置 To 电子邮件地址。使用逗号分隔多个电子邮件地址。 | 字符串 | |
javaMailSender (producer) | 使用自定义 org.apache.camel.component.mail.JavaMailSender 来发送电子邮件。 | JavaMailSender | |
additionalJavaMail Properties (高级) | 设置额外的 java 邮件属性,这将根据所有其他选项附加/覆盖设置的任何默认属性。如果您需要添加一些特殊选项,但想让其他选项保留原样,这将非常有用。 | Properties | |
alternativeBodyHeader (advanced) | 指定包含替代电子邮件正文的 IN 消息标头的密钥。例如,如果您以 text/html 格式发送电子邮件,并希望为非HTML 电子邮件客户端提供替代邮件正文,请将此密钥作为标头设置替代邮件正文。 | CamelMailAlternativeBody | 字符串 |
attachmentsContentTransfer EncodingResolver (高级) | 使用自定义 AttachmentsContentTransferEncodingResolver 来解决要用于附件的内容类型代码。 | AttachmentsContent TransferEncoding Resolver | |
绑定 (高级) | 设置用于从 Camel 消息转换到邮件消息的绑定 | MailBinding | |
connectionTimeout (advanced) | 连接超时(毫秒)。 | 30000 | int |
contentType (高级) | 邮件邮件内容类型。将 text/html 用于 HTML 邮件。 | text/plain | 字符串 |
contentTypeResolver (advanced) | 用于确定文件附加内容类型的解析器. | ContentTypeResolver | |
debugMode (高级) | 在底层邮件框架中启用调试模式。默认情况下,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 | 布尔值 |
会话 (高级) | 指定 camel 应在所有邮件交互中使用的邮件会话。在一些其他资源(如 JavaEE 容器)创建和管理邮件会话时,很有用。如果没有指定,Camel 会自动为您创建邮件会话。 | 会话 | |
同步 (高级) | 设置同步处理是否应当严格使用,还是允许 Camel 使用异步处理(如果受支持)。 | false | 布尔值 |
useInlineAttachments (advanced) | 是否使用内嵌或附加功能。 | false | 布尔值 |
idempotentRepository (filter) | 可插拔存储库 org.apache.camel.spi.IdempotentRepository,允许从同一邮箱使用集群,并让存储库协调邮件是否有效处理。默认情况下,不使用任何存储库。 | IdempotentRepository | |
idempotentRepositoryRemove OnCommit (filter) | 在使用幂等存储库时,当邮件消息被成功处理并被提交时,应将消息 ID 从幂等存储库(默认)或从存储库中删除,或者保存在存储库中。默认情况下,其假定消息 id 是唯一的,并且没有要保留在存储库中的值,因为邮件信息将被标记为 see/moved 或删除,以防止其再次被使用。因此,在幂等存储库中存储了消息 id 很少的值。但是,这个选项可以根据您可能具有的任何原因存储消息 id。 | true | 布尔值 |
searchTerm (filter) | 指的是 javax.mail.search.SearchTerm,它允许根据搜索条件(如主题、正文、从某些日期等)过滤邮件。 | SearchTerm | |
backoffErrorThreshold (scheduler) | 后续错误轮询(因某些错误导致的失败)的数量,在 backoffMultipler 应该启动前发生。 | int | |
BackoffIdleThreshold (scheduler) | 后续闲置轮询的数量,在 backoffMultipler 应该启动之前发生。 | int | |
BackoffMultiplier (scheduler) | 如果行中有多个后续闲置/errors,让调度的轮询消费者重新关闭。然后,倍数是下一次实际尝试发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/or backoffErrorThreshold。 | int | |
延迟 (scheduler) | 下次轮询前的毫秒。 | 60000 | long |
greedy (scheduler) | 如果启用了 greedy,则 ScheduledPollConsumer 将立即再次运行,如果上一运行轮询了 1 或更多消息。 | false | 布尔值 |
initialDelay (scheduler) | 第一次轮询启动前的毫秒。您还可以使用单位(60 秒)、5m30s (5 分钟和 30 秒)和 1h (1 小时)指定时间值。 | 1000 | long |
runLoggingLevel (scheduler) | 消费者日志轮询轮询时启动/完成日志行。此选项允许您为其配置日志级别。 | TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | 允许配置用于使用者的自定义/共享线程池。默认情况下,每个使用者都有自己的单个线程池。 | ScheduledExecutor 服务 | |
调度程序 (scheduler) | 使用来自 camel-spring 或 camel-quartz2 组件的 cron 调度程序 | none | ScheduledPollConsumer Scheduler |
schedulerProperties (scheduler) | 在使用自定义调度程序或任何基于 Spring 的调度程序时配置额外属性。 | map | |
启动Scheduler (scheduler) | 调度程序是否应自动启动。 | true | 布尔值 |
timeUnit (scheduler) | 初始延迟和延迟选项的时间单位。 | MILLISECONDS | TimeUnit |
使用FixedDelay (scheduler) | 控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。 | true | 布尔值 |
sortTerm (sort) | 排序消息的顺序.仅对 IMAP 进行原生支持。在使用 POP3 或 IMAP 服务器没有 SORT 功能时,模拟到某种程度。 | 字符串 | |
dummyTrustManager (security) | 使用 dummy 安全设置信任所有证书。应该只用于开发模式,而不应该用于生产环境。 | false | 布尔值 |
密码 (安全) | 登录的密码 | 字符串 | |
sslContextParameters (安全) | 使用 SSLContextParameters 配置安全性。 | SSLContextParameters | |
用户名 (安全性) | 登录的用户名 | 字符串 |