You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2013/10/26 16:19:27 UTC
svn commit: r884226 - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
mail.html
Author: buildbot
Date: Sat Oct 26 14:19:26 2013
New Revision: 884226
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-component-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/mail.html
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Sat Oct 26 14:19:26 2013
@@ -11072,7 +11072,7 @@ smtp://mycompany.mailserver:30?password=
<h3><a shape="rect" name="BookComponentAppendix-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#BookComponentAppendix-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email ser
ver. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="
1" rowspan="1" class="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" r
owspan="1" class="confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to de
termine if the mail should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default option of <tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class=
"confluenceTd"> <tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>debugMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 second
s. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/Scheduled
ExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>n
ull</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for example: <tt>mail.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to
false then the IN message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none
provided, Camel uses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <tt>charset=XXX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.
html">Registry</a>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, whi
ch supports a limited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#BookComponentAppendix-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email ser
ver. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="
1" rowspan="1" class="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" r
owspan="1" class="confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td
><td colspan="1" rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>peek</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.3/2.12.2:</b> Consumer only. Will mark the <tt>javax.mail.Message</tt> as peeked before processing the mail message. This applies to <tt>IMAPMessage</tt> messages types only. By using peek the mail will not be eager marked as <tt>SEEN</tt> on the mail server, which allows us to rollback the
mail message if there is an error processing in Camel. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to determine if the mail should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The de
fault option of <tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class=
"confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="conflu
enceTd"> <tt>debugMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 seconds. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colsp
an="1" rowspan="1" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></
tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for
example: <tt>mail.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to g
ather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none provided, Camel uses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported t
hen <tt>charset=XXX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, which supports a limited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/book-in-one-page.html
==============================================================================
--- websites/production/camel/content/book-in-one-page.html (original)
+++ websites/production/camel/content/book-in-one-page.html Sat Oct 26 14:19:26 2013
@@ -32593,7 +32593,7 @@ smtp://mycompany.mailserver:30?password=
<h3><a shape="rect" name="BookInOnePage-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#BookInOnePage-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email server. </t
d></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="1" rowsp
an="1" class="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="
1" class="confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td><td col
span="1" rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to determine
if the mail should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default option of <tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan=
"1" class="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class="conflue
nceTd"> <tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>debugMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 seconds. </td>
</tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutor
Service.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for example: <tt>mail.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false th
en the IN message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none provided
, Camel uses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <tt>charset=XXX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Re
gistry</a>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, which suppo
rts a limited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#BookInOnePage-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email server. </t
d></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="1" rowsp
an="1" class="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="
1" class="confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td><td col
span="1" rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>peek</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.3/2.12.2:</b> Consumer only. Will mark the <tt>javax.mail.Message</tt> as peeked before processing the mail message. This applies to <tt>IMAPMessage</tt> messages types only. By using peek the mail will not be eager marked as <tt>SEEN</tt> on the mail server, which allows us to rollback the mail mes
sage if there is an error processing in Camel. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to determine if the mail should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default op
tion of <tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class="conflue
nceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>debugMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 seconds. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colspan="1" r
owspan="1" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></tr><tr><
td colspan="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for example
: <tt>mail.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to gather pe
r poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none provided, Camel uses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <tt>
charset=XXX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><t
d colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, which supports a limited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/mail.html
==============================================================================
--- websites/production/camel/content/mail.html (original)
+++ websites/production/camel/content/mail.html Sat Oct 26 14:19:26 2013
@@ -168,7 +168,7 @@ smtp://mycompany.mailserver:30?password=
<h3><a shape="rect" name="Mail-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#Mail-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email server. </td></tr><t
r><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="1" rowspan="1" cl
ass="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class=
"confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to determine if the ma
il should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default option of <tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class
="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <
tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>debugMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 seconds. </td></tr><tr>
<td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.h
tml" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for example: <tt>mail.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN
message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none provided, Camel u
ses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <tt>charset=XXX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a
>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, which supports a lim
ited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Property </th><th colspan="1" rowspan="1" class="confluenceTh"> Default </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The host name or IP address to connect to. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>port</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> See <a shape="rect" href="#Mail-DefaultPorts">DefaultPorts</a> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TCP port number to connect on. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user name on the email server. </td></tr><t
r><td colspan="1" rowspan="1" class="confluenceTd"> <tt>password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The password on the email server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUriScheme</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>false</tt>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.) </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>defaultEncoding</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The default encoding to use for Mime Messages. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>contentType</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>text/plain</tt> </td><td colspan="1" rowspan="1" cl
ass="confluenceTd"> The mail message content type. Use <tt>text/html</tt> for HTML mails. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>folderName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>INBOX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The folder to poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>destination</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>@deprecated</b> Use the <tt>to</tt> option instead. The <tt>TO</tt> recipients (receivers of the email). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>to</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>username@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class=
"confluenceTd"> <tt>replyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alias@host</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.8.4, 2.9.1+</b>, the Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>BCC</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>from</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>camel@localhost</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The FROM email address. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>subject</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> As of <b>Camel 2.3</b>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>peek</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11.3/2.12.2:</b> Consumer only. Will mark the <tt>javax.mail.Message</tt> as peeked before processing the mail message. This applies to <tt>IMAPMessage</tt> messages types only. By using peek the mail will not be eager marked as <tt>SEEN</tt> on the mail server, which allows us to rollback the mail message if t
here is an error processing in Camel. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Deletes the messages after they have been processed. This is done by setting the <tt>DELETED</tt> flag on the mail message. If <tt>false</tt>, the <tt>SEEN</tt> flag is set instead. As of <b>Camel 2.10</b> you can override this configuration option by setting a header with the key <tt>delete</tt> to determine if the mail should be deleted or not. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>unseen</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default option of <
tt>true</tt> will filter to only unseen messages. POP3 does not support the <tt>SEEN</tt> flag, so this option is not supported in POP3; use IMAP instead. <b>Important:</b> This option is <b>not</b> in use if you also use <tt>searchTerm</tt> options. Instead if you want to disable unseen when using <tt>searchTerm</tt>'s then add <tt>searchTerm.unseen=false</tt> as a term. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>copyTo</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Consumer only. 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 <tt>copyTo</tt>, allowing you to copy messages to folder names configured at runtime. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fetchSize</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <
tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 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 <tt>-1</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>alternativeBodyHeader</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>CamelMailAlternativeBody</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <tt>text/html</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>debu
gMode</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <tt>System.out</tt> by default. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectionTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> The connection timeout in milliseconds. Default is 30 seconds. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the polling starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>60000</tt> </td><td colspan="1" rowspan="1
" class="confluenceTd"> Camel will poll the mailbox only once a minute by default to avoid overloading the mail server. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to <tt>true</tt> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>disconnect</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.3/2.9:</b> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. </td></tr><tr><td colspa
n="1" rowspan="1" class="confluenceTd"> <tt>closeFolder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.4:</b> Whether the consumer should close the folder after polling. Setting this option to <tt>false</tt> and having <tt>disconnect=false</tt> as well, then the consumer keep the folder open between polls. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mail.XXX</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <tt>mail.pop3.forgettopheaders=true</tt>. You can set multiple such options, for example: <tt>mai
l.pop3.forgettopheaders=true&mail.mime.encodefilename=true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>mapMailMessage</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw <tt>javax.mail.Message</tt>. You can retrieve this raw message by calling <tt>exchange.getIn().getBody(javax.mail.Message.class)</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum number of messages to gather per poll. B
y default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>javaMailSender</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies a pluggable <tt>org.springframework.mail.javamail.JavaMailSender</tt> instance in order to use a custom email implementation. If none provided, Camel uses the default <tt>org.springframework.mail.javamail.JavaMailSenderImpl</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreUnsupportedCharset</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <tt>charset=X
XX</tt> (where <tt>XXX</tt> represents the unsupported charset) is removed from the <tt>content-type</tt> and it relies on the platform default instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This reference overrides any configured SSLContextParameters at the component level.  See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan
="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Refers to a <tt>javax.mail.search.SearchTerm</tt> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>searchTerm.xxx</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> To configure search terms directly from the endpoint uri, which supports a limited number of terms defined by the <tt>org.apache.camel.component.mail.SimpleSearchTerm</tt> class. See further below for examples. </td></tr></tbody></table>
</div>
</div>