Endpoint for Camel Mail.
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
host | path | java.lang.String | true | false | The mail server host name | ||
port | path | int | false | The port number of the mail server | |||
username | parameter | java.lang.String | false | The username for login | |||
password | parameter | java.lang.String | false | The password for login | |||
subject | parameter | java.lang.String | false | The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. | |||
javaMailSender | parameter | org.apache.camel.component.mail.JavaMailSender | false | To use a custom {@link org.apache.camel.component.mail.JavaMailSender} for sending emails. | |||
mapMailMessage | parameter | boolean | false | true | |||
from | parameter | java.lang.String | false | camel@localhost | The from email address | ||
folderName | parameter | java.lang.String | false | INBOX | The folder to poll. | ||
delete | parameter | boolean | false | Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not. | |||
copyTo | parameter | java.lang.String | false | After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value, with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime. | |||
unseen | parameter | boolean | false | true | Whether to limit by unseen mails only. | ||
ignoreUriScheme | parameter | boolean | false | Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. | |||
replyTo | parameter | java.lang.String | false | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. | |||
fetchSize | parameter | int | false | -1 | Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all. | ||
debugMode | parameter | boolean | false | Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. | |||
connectionTimeout | parameter | int | false | 30000 | The connection timeout in milliseconds. | ||
dummyTrustManager | parameter | boolean | false | ||||
contentType | parameter | java.lang.String | false | text/plain | The mail message content type. Use text/html for HTML mails. | ||
alternativeBodyHeader | parameter | java.lang.String | false | CamelMailAlternativeBody | Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header. | ||
useInlineAttachments | parameter | boolean | false | ||||
ignoreUnsupportedCharset | parameter | boolean | false | Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. | |||
disconnect | parameter | boolean | false | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. | |||
closeFolder | parameter | boolean | false | true | Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keep the folder open between polls. | ||
peek | parameter | boolean | false | true | Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server, which allows us to rollback the mail message if there is an error processing in Camel. | ||
sslContextParameters | parameter | org.apache.camel.util.jsse.SSLContextParameters | false | ||||
binding | parameter | org.apache.camel.component.mail.MailBinding | false | Sets the binding used to convert from a Camel message to and from a Mail message | |||
headerFilterStrategy | parameter | org.apache.camel.spi.HeaderFilterStrategy | false | ||||
contentTypeResolver | parameter | org.apache.camel.component.mail.ContentTypeResolver | false | ||||
maxMessagesPerPoll | parameter | int | false | ||||
searchTerm | parameter | javax.mail.search.SearchTerm | false | ||||
sortTerm | parameter | com.sun.mail.imap.SortTerm[] | false | @param sortTerm {@link #getSortTerm()} | |||
postProcessAction | parameter | org.apache.camel.component.mail.MailBoxPostProcessAction | false | @param postProcessAction {@link #getPostProcessAction()} | |||
startScheduler | parameter | boolean | false | true | |||
initialDelay | parameter | long | false | 1000 | |||
delay | parameter | long | false | 500 | |||
timeUnit | parameter | java.util.concurrent.TimeUnit | false | MILLISECONDS | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
||
useFixedDelay | parameter | boolean | false | true | |||
pollStrategy | parameter | org.apache.camel.spi.PollingConsumerPollStrategy | false | ||||
runLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | TRACE | DEBUG ERROR INFO TRACE WARN OFF |
||
sendEmptyMessageWhenIdle | parameter | boolean | false | ||||
greedy | parameter | boolean | false | ||||
scheduler | parameter | org.apache.camel.spi.ScheduledPollConsumerScheduler | false | spring quartz2 |
|||
schedulerProperties | parameter | java.util.Map |
false | ||||
scheduledExecutorService | parameter | java.util.concurrent.ScheduledExecutorService | false | ||||
backoffMultiplier | parameter | int | false | ||||
backoffIdleThreshold | parameter | int | false | ||||
backoffErrorThreshold | parameter | int | false | ||||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
A {@link org.apache.camel.Consumer Consumer} which consumes messages from JavaMail using a {@link javax.mail.Transport Transport} and dispatches them to the {@link Processor}
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
maxMessagesPerPoll | parameter | int | false |