MailConfiguration (Camel :: Mail 2.17.3 API)

java.lang.Object
- org.apache.camel.component.mail.MailConfiguration

All Implemented Interfaces:

Cloneable
```
@UriParams
public class MailConfiguration
extends Object
implements Cloneable
```
Represents the configuration data for communicating over email

Version:

Constructor Summary

Constructors
Constructor and Description

MailConfiguration()

MailConfiguration(org.apache.camel.CamelContext context)

Constructors
Constructor and Description
`MailConfiguration()`
`MailConfiguration(org.apache.camel.CamelContext context)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configure(URI uri)`
`MailConfiguration`	`copy()` Returns a copy of this configuration
`protected JavaMailSender`	`createJavaMailSender()`
`Properties`	`getAdditionalJavaMailProperties()`
`String`	`getAlternativeBodyHeader()`
`String`	`getBcc()`
`String`	`getCc()`
`long`	`getConnectionTimeout()`
`String`	`getContentType()`
`String`	`getCopyTo()`
`int`	`getFetchSize()`
`String`	`getFolderName()`
`String`	`getFrom()`
`String`	`getHost()`
`Properties`	`getJavaMailProperties()`
`JavaMailSender`	`getJavaMailSender()`
`String`	`getMailStoreLogInformation()`
`String`	`getPassword()`
`int`	`getPort()`
`String`	`getProtocol()`
`Map<javax.mail.Message.RecipientType,String>`	`getRecipients()`
`String`	`getReplyTo()`
`javax.mail.Session`	`getSession()`
`org.apache.camel.util.jsse.SSLContextParameters`	`getSslContextParameters()`
`String`	`getSubject()`
`String`	`getTo()`
`String`	`getUsername()`
`boolean`	`isCloseFolder()`
`boolean`	`isDebugMode()`
`boolean`	`isDelete()`
`boolean`	`isDisconnect()`
`boolean`	`isDummyTrustManager()`
`boolean`	`isHandleFailedMessage()`
`boolean`	`isIgnoreUnsupportedCharset()`
`boolean`	`isIgnoreUriScheme()`
`boolean`	`isMapMailMessage()`
`boolean`	`isPeek()`
`boolean`	`isSecureProtocol()` Is the used protocol to be secure or not
`boolean`	`isSkipFailedMessage()`
`boolean`	`isStartTlsEnabled()`
`boolean`	`isUnseen()`
`boolean`	`isUseInlineAttachments()`
`void`	`setAdditionalJavaMailProperties(Properties additionalJavaMailProperties)` Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.
`void`	`setAlternativeBodyHeader(String alternativeBodyHeader)` Specifies the key to an IN message header that contains an alternative email body.
`void`	`setBcc(String address)` Sets the `BCC` email address.
`void`	`setCc(String address)` Sets the `CC` email address.
`void`	`setCloseFolder(boolean closeFolder)` Whether the consumer should close the folder after polling.
`void`	`setConnectionTimeout(int connectionTimeout)` The connection timeout in milliseconds.
`void`	`setContentType(String contentType)` The mail message content type.
`void`	`setCopyTo(String copyTo)` After processing a mail message, it can be copied to a mail folder with the given name.
`void`	`setDebugMode(boolean debugMode)` Enable debug mode on the underlying mail framework.
`void`	`setDelete(boolean delete)` Deletes the messages after they have been processed.
`void`	`setDisconnect(boolean disconnect)` Whether the consumer should disconnect after polling.
`void`	`setDummyTrustManager(boolean dummyTrustManager)` To use a dummy security setting for trusting all certificates.
`void`	`setFetchSize(int fetchSize)` Sets the maximum number of messages to consume during a poll.
`void`	`setFolderName(String folderName)` The folder to poll.
`void`	`setFrom(String from)` The from email address
`void`	`setHandleFailedMessage(boolean handleFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler.
`void`	`setHost(String host)` The mail server host name
`void`	`setIgnoreUnsupportedCharset(boolean ignoreUnsupportedCharset)` Option to let Camel ignore unsupported charset in the local JVM when sending mails.
`void`	`setIgnoreUriScheme(boolean ignoreUriScheme)` Option to let Camel ignore unsupported charset in the local JVM when sending mails.
`void`	`setJavaMailProperties(Properties javaMailProperties)` Sets the java mail options.
`void`	`setJavaMailSender(JavaMailSender javaMailSender)` To use a custom `JavaMailSender` for sending emails.
`void`	`setMapMailMessage(boolean mapMailMessage)` Specifies whether Camel should map the received mail message to Camel body/headers.
`void`	`setPassword(String password)` The password for login
`void`	`setPeek(boolean peek)` Will mark the javax.mail.Message as peeked before processing the mail message.
`void`	`setPort(int port)` The port number of the mail server
`void`	`setProtocol(String protocol)` The protocol for communicating with the mail server
`void`	`setReplyTo(String replyTo)` The Reply-To recipients (the receivers of the response mail).
`void`	`setSession(javax.mail.Session session)` Specifies the mail session that camel should use for all mail interactions.
`void`	`setSkipFailedMessage(boolean skipFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message.
`void`	`setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters.
`void`	`setSubject(String subject)` The Subject of the message being sent.
`void`	`setTo(String address)` Sets the `To` email address.
`void`	`setUnseen(boolean unseen)` Whether to limit by unseen mails only.
`void`	`setUseInlineAttachments(boolean useInlineAttachments)` Whether to use disposition inline or attachment.
`void`	`setUsername(String username)` The username for login

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MailConfiguration
```
public MailConfiguration()
```
  - MailConfiguration
```
public MailConfiguration(org.apache.camel.CamelContext context)
```
- Method Detail
  - copy
```
public MailConfiguration copy()
```
    Returns a copy of this configuration
  - configure
```
public void configure(URI uri)
```
  - createJavaMailSender
```
protected JavaMailSender createJavaMailSender()
```
  - isSecureProtocol
```
public boolean isSecureProtocol()
```
    Is the used protocol to be secure or not
  - isStartTlsEnabled
```
public boolean isStartTlsEnabled()
```
  - getMailStoreLogInformation
```
public String getMailStoreLogInformation()
```
  - getJavaMailSender
```
public JavaMailSender getJavaMailSender()
```
  - setJavaMailSender
```
public void setJavaMailSender(JavaMailSender javaMailSender)
```
    To use a custom JavaMailSender for sending emails.
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String host)
```
    The mail server host name
  - getJavaMailProperties
```
public Properties getJavaMailProperties()
```
  - setJavaMailProperties
```
public void setJavaMailProperties(Properties javaMailProperties)
```
    Sets the java mail options. Will clear any default properties and only use the properties provided for this method.
  - getAdditionalJavaMailProperties
```
public Properties getAdditionalJavaMailProperties()
```
  - setAdditionalJavaMailProperties
```
public void setAdditionalJavaMailProperties(Properties additionalJavaMailProperties)
```
    Sets additional java mail properties, that will append/override any default properties that is set based on all the other options. This is useful if you need to add some special options but want to keep the others as is.
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
    The password for login
  - getSubject
```
public String getSubject()
```
  - setSubject
```
public void setSubject(String subject)
```
    The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option.
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
    The port number of the mail server
  - getProtocol
```
public String getProtocol()
```
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol for communicating with the mail server
  - getSession
```
public javax.mail.Session getSession()
```
  - setSession
```
public void setSession(javax.mail.Session session)
```
    Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. If this is not specified, Camel automatically creates the mail session for you.
  - getUsername
```
public String getUsername()
```
  - setUsername
```
public void setUsername(String username)
```
    The username for login
  - getFrom
```
public String getFrom()
```
  - setFrom
```
public void setFrom(String from)
```
    The from email address
  - isDelete
```
public boolean isDelete()
```
  - setDelete
```
public void setDelete(boolean delete)
```
    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.
  - isMapMailMessage
```
public boolean isMapMailMessage()
```
  - setMapMailMessage
```
public void setMapMailMessage(boolean mapMailMessage)
```
    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 javax.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class).
  - getFolderName
```
public String getFolderName()
```
  - setFolderName
```
public void setFolderName(String folderName)
```
    The folder to poll.
  - isIgnoreUriScheme
```
public boolean isIgnoreUriScheme()
```
  - setIgnoreUriScheme
```
public void setIgnoreUriScheme(boolean ignoreUriScheme)
```
    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.
  - isUnseen
```
public boolean isUnseen()
```
  - setUnseen
```
public void setUnseen(boolean unseen)
```
    Whether to limit by unseen mails only.
  - setTo
```
public void setTo(String address)
```
    Sets the To email address. Separate multiple email addresses with comma.
  - getTo
```
public String getTo()
```
  - setCc
```
public void setCc(String address)
```
    Sets the CC email address. Separate multiple email addresses with comma.
  - getCc
```
public String getCc()
```
  - setBcc
```
public void setBcc(String address)
```
    Sets the BCC email address. Separate multiple email addresses with comma.
  - getBcc
```
public String getBcc()
```
  - getRecipients
```
public Map<javax.mail.Message.RecipientType,String> getRecipients()
```
  - getReplyTo
```
public String getReplyTo()
```
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
    The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma.
  - getFetchSize
```
public int getFetchSize()
```
  - setFetchSize
```
public void setFetchSize(int fetchSize)
```
    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.
  - isDebugMode
```
public boolean isDebugMode()
```
  - setDebugMode
```
public void setDebugMode(boolean debugMode)
```
    Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default.
  - getConnectionTimeout
```
public long getConnectionTimeout()
```
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    The connection timeout in milliseconds.
  - isDummyTrustManager
```
public boolean isDummyTrustManager()
```
  - setDummyTrustManager
```
public void setDummyTrustManager(boolean dummyTrustManager)
```
    To use a dummy security setting for trusting all certificates. Should only be used for development mode, and not production.
  - getContentType
```
public String getContentType()
```
  - setContentType
```
public void setContentType(String contentType)
```
    The mail message content type. Use text/html for HTML mails.
  - getAlternativeBodyHeader
```
public String getAlternativeBodyHeader()
```
  - setAlternativeBodyHeader
```
public void setAlternativeBodyHeader(String alternativeBodyHeader)
```
    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.
  - isUseInlineAttachments
```
public boolean isUseInlineAttachments()
```
  - setUseInlineAttachments
```
public void setUseInlineAttachments(boolean useInlineAttachments)
```
    Whether to use disposition inline or attachment.
  - isIgnoreUnsupportedCharset
```
public boolean isIgnoreUnsupportedCharset()
```
  - setIgnoreUnsupportedCharset
```
public void setIgnoreUnsupportedCharset(boolean ignoreUnsupportedCharset)
```
    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.
  - isDisconnect
```
public boolean isDisconnect()
```
  - setDisconnect
```
public void setDisconnect(boolean disconnect)
```
    Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll.
  - isCloseFolder
```
public boolean isCloseFolder()
```
  - setCloseFolder
```
public void setCloseFolder(boolean closeFolder)
```
    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.
  - getSslContextParameters
```
public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()
```
  - setSslContextParameters
```
public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)
```
    To configure security using SSLContextParameters.
  - getCopyTo
```
public String getCopyTo()
```
  - setCopyTo
```
public void setCopyTo(String copyTo)
```
    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.
  - isPeek
```
public boolean isPeek()
```
  - setPeek
```
public void setPeek(boolean peek)
```
    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.
  - isSkipFailedMessage
```
public boolean isSkipFailedMessage()
```
  - setSkipFailedMessage
```
public void setSkipFailedMessage(boolean skipFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message.
    The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel.
  - isHandleFailedMessage
```
public boolean isHandleFailedMessage()
```
  - setHandleFailedMessage
```
public void setHandleFailedMessage(boolean handleFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead.
    The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel.

Class MailConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MailConfiguration

MailConfiguration

Method Detail

copy

configure

createJavaMailSender

isSecureProtocol

isStartTlsEnabled

getMailStoreLogInformation

getJavaMailSender

setJavaMailSender

getHost

setHost

getJavaMailProperties

setJavaMailProperties

getAdditionalJavaMailProperties

setAdditionalJavaMailProperties

getPassword

setPassword

getSubject

setSubject

getPort

setPort

getProtocol

setProtocol

getSession

setSession

getUsername

setUsername

getFrom

setFrom

isDelete

setDelete

isMapMailMessage

setMapMailMessage

getFolderName

setFolderName

isIgnoreUriScheme

setIgnoreUriScheme

isUnseen

setUnseen

setTo

getTo

setCc

getCc

setBcc

getBcc

getRecipients

getReplyTo

setReplyTo

getFetchSize

setFetchSize

isDebugMode

setDebugMode

getConnectionTimeout

setConnectionTimeout

isDummyTrustManager

setDummyTrustManager

getContentType

setContentType

getAlternativeBodyHeader

setAlternativeBodyHeader

isUseInlineAttachments

setUseInlineAttachments

isIgnoreUnsupportedCharset

setIgnoreUnsupportedCharset

isDisconnect

setDisconnect

isCloseFolder

setCloseFolder

getSslContextParameters

setSslContextParameters

getCopyTo

setCopyTo

isPeek