SmtpComponentBuilderFactory.SmtpComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.mail.MailComponent>

All Known Implementing Classes:

SmtpComponentBuilderFactory.SmtpComponentBuilderImpl

Enclosing interface:

SmtpComponentBuilderFactory
```
public static interface SmtpComponentBuilderFactory.SmtpComponentBuilder
extends ComponentBuilder<org.apache.camel.component.mail.MailComponent>
```
Builder for the SMTP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`additionalJavaMailProperties(Properties additionalJavaMailProperties)` Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`alternativeBodyHeader(String alternativeBodyHeader)` Specifies the key to an IN message header that contains an alternative email body.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`attachmentsContentTransferEncodingResolver(org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver attachmentsContentTransferEncodingResolver)` To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`authenticator(org.apache.camel.component.mail.MailAuthenticator authenticator)` The authenticator for login.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`bcc(String bcc)` Sets the BCC email address.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`cc(String cc)` Sets the CC email address.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`closeFolder(boolean closeFolder)` Whether the consumer should close the folder after polling.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`configuration(org.apache.camel.component.mail.MailConfiguration configuration)` Sets the Mail configuration.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`connectionTimeout(int connectionTimeout)` The connection timeout in milliseconds.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`contentType(String contentType)` The mail message content type.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`contentTypeResolver(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver)` Resolver to determine Content-Type for file attachments.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`copyTo(String copyTo)` After processing a mail message, it can be copied to a mail folder with the given name.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`debugMode(boolean debugMode)` Enable debug mode on the underlying mail framework.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`delete(boolean delete)` Deletes the messages after they have been processed.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`disconnect(boolean disconnect)` Whether the consumer should disconnect after polling.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`fetchSize(int fetchSize)` Sets the maximum number of messages to consume during a poll.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`folderName(String folderName)` The folder to poll.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`from(String from)` The from email address.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`handleFailedMessage(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.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`ignoreUnsupportedCharset(boolean ignoreUnsupportedCharset)` Option to let Camel ignore unsupported charset in the local JVM when sending mails.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`ignoreUriScheme(boolean ignoreUriScheme)` Option to let Camel ignore unsupported charset in the local JVM when sending mails.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`javaMailProperties(Properties javaMailProperties)` Sets the java mail options.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`javaMailSender(org.apache.camel.component.mail.JavaMailSender javaMailSender)` To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`mapMailMessage(boolean mapMailMessage)` Specifies whether Camel should map the received mail message to Camel body/headers/attachments.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`mimeDecodeHeaders(boolean mimeDecodeHeaders)` This option enables transparent MIME decoding and unfolding for mail headers.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`moveTo(String moveTo)` After processing a mail message, it can be moved to a mail folder with the given name.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`password(String password)` The password for login.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`peek(boolean peek)` Will mark the javax.mail.Message as peeked before processing the mail message.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`replyTo(String replyTo)` The Reply-To recipients (the receivers of the response mail).
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`session(javax.mail.Session session)` Specifies the mail session that camel should use for all mail interactions.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`skipFailedMessage(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.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`subject(String subject)` The Subject of the message being sent.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`to(String to)` Sets the To email address.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`unseen(boolean unseen)` Whether to limit by unseen mails only.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`useGlobalSslContextParameters(boolean useGlobalSslContextParameters)` Enable usage of global SSL context parameters.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`useInlineAttachments(boolean useInlineAttachments)` Whether to use disposition inline or attachment.
`default SmtpComponentBuilderFactory.SmtpComponentBuilder`	`username(String username)` The username for login.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - bridgeErrorHandler
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - closeFolder
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder closeFolder(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. The option is a: boolean type. Default: true Group: consumer
  - copyTo
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder copyTo(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. The option is a: java.lang.String type. Group: consumer
  - delete
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder delete(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. The option is a: boolean type. Default: false Group: consumer
  - disconnect
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder disconnect(boolean disconnect)
```
    Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. The option is a: boolean type. Default: false Group: consumer
  - handleFailedMessage
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder handleFailedMessage(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. The option is a: boolean type. Default: false Group: consumer
  - mimeDecodeHeaders
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder mimeDecodeHeaders(boolean mimeDecodeHeaders)
```
    This option enables transparent MIME decoding and unfolding for mail headers. The option is a: boolean type. Default: false Group: consumer
  - moveTo
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder moveTo(String moveTo)
```
    After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value, with a header with the key moveTo, allowing you to move messages to folder names configured at runtime. The option is a: java.lang.String type. Group: consumer
  - peek
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder peek(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. The option is a: boolean type. Default: true Group: consumer
  - skipFailedMessage
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder skipFailedMessage(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. The option is a: boolean type. Default: false Group: consumer
  - unseen
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder unseen(boolean unseen)
```
    Whether to limit by unseen mails only. The option is a: boolean type. Default: true Group: consumer
  - fetchSize
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder fetchSize(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. The option is a: int type. Default: -1 Group: consumer (advanced)
  - folderName
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder folderName(String folderName)
```
    The folder to poll. The option is a: java.lang.String type. Default: INBOX Group: consumer (advanced)
  - mapMailMessage
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder mapMailMessage(boolean mapMailMessage)
```
    Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. 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). The option is a: boolean type. Default: true Group: consumer (advanced)
  - bcc
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder bcc(String bcc)
```
    Sets the BCC email address. Separate multiple email addresses with comma. The option is a: java.lang.String type. Group: producer
  - cc
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder cc(String cc)
```
    Sets the CC email address. Separate multiple email addresses with comma. The option is a: java.lang.String type. Group: producer
  - from
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder from(String from)
```
    The from email address. The option is a: java.lang.String type. Default: camel@localhost Group: producer
  - lazyStartProducer
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - replyTo
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder replyTo(String replyTo)
```
    The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. The option is a: java.lang.String type. Group: producer
  - subject
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder subject(String subject)
```
    The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. The option is a: java.lang.String type. Group: producer
  - to
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder to(String to)
```
    Sets the To email address. Separate multiple email addresses with comma. The option is a: java.lang.String type. Group: producer
  - javaMailSender
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder javaMailSender(org.apache.camel.component.mail.JavaMailSender javaMailSender)
```
    To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. The option is a: org.apache.camel.component.mail.JavaMailSender type. Group: producer (advanced)
  - additionalJavaMailProperties
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder additionalJavaMailProperties(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. The option is a: java.util.Properties type. Group: advanced
  - alternativeBodyHeader
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder alternativeBodyHeader(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. The option is a: java.lang.String type. Default: CamelMailAlternativeBody Group: advanced
  - attachmentsContentTransferEncodingResolver
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder attachmentsContentTransferEncodingResolver(org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver attachmentsContentTransferEncodingResolver)
```
    To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. The option is a: org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver type. Group: advanced
  - authenticator
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder authenticator(org.apache.camel.component.mail.MailAuthenticator authenticator)
```
    The authenticator for login. If set then the password and username are ignored. Can be used for tokens which can expire and therefore must be read dynamically. The option is a: org.apache.camel.component.mail.MailAuthenticator type. Group: advanced
  - basicPropertyBinding
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder configuration(org.apache.camel.component.mail.MailConfiguration configuration)
```
    Sets the Mail configuration. The option is a: org.apache.camel.component.mail.MailConfiguration type. Group: advanced
  - connectionTimeout
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder connectionTimeout(int connectionTimeout)
```
    The connection timeout in milliseconds. The option is a: int type. Default: 30000 Group: advanced
  - contentType
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder contentType(String contentType)
```
    The mail message content type. Use text/html for HTML mails. The option is a: java.lang.String type. Default: text/plain Group: advanced
  - contentTypeResolver
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder contentTypeResolver(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver)
```
    Resolver to determine Content-Type for file attachments. The option is a: org.apache.camel.component.mail.ContentTypeResolver type. Group: advanced
  - debugMode
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder debugMode(boolean debugMode)
```
    Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. The option is a: boolean type. Default: false Group: advanced
  - ignoreUnsupportedCharset
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder ignoreUnsupportedCharset(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. The option is a: boolean type. Default: false Group: advanced
  - ignoreUriScheme
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder ignoreUriScheme(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. The option is a: boolean type. Default: false Group: advanced
  - javaMailProperties
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder javaMailProperties(Properties javaMailProperties)
```
    Sets the java mail options. Will clear any default properties and only use the properties provided for this method. The option is a: java.util.Properties type. Group: advanced
  - session
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder session(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. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session). The option is a: javax.mail.Session type. Group: advanced
  - useInlineAttachments
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder useInlineAttachments(boolean useInlineAttachments)
```
    Whether to use disposition inline or attachment. The option is a: boolean type. Default: false Group: advanced
  - headerFilterStrategy
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
```
    To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter
  - password
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder password(String password)
```
    The password for login. See also setAuthenticator(MailAuthenticator). The option is a: java.lang.String type. Group: security
  - sslContextParameters
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
```
    To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - useGlobalSslContextParameters
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
```
    Enable usage of global SSL context parameters. The option is a: boolean type. Default: false Group: security
  - username
```
default SmtpComponentBuilderFactory.SmtpComponentBuilder username(String username)
```
    The username for login. See also setAuthenticator(MailAuthenticator). The option is a: java.lang.String type. Group: security

Interface SmtpComponentBuilderFactory.SmtpComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

bridgeErrorHandler

closeFolder

copyTo

delete

disconnect

handleFailedMessage

mimeDecodeHeaders

moveTo

peek

skipFailedMessage

unseen

fetchSize

folderName

mapMailMessage

bcc

cc

from

lazyStartProducer

replyTo

subject

to

javaMailSender

additionalJavaMailProperties

alternativeBodyHeader

attachmentsContentTransferEncodingResolver

authenticator

basicPropertyBinding

configuration

connectionTimeout

contentType

contentTypeResolver

debugMode

ignoreUnsupportedCharset

ignoreUriScheme

javaMailProperties

session

useInlineAttachments

headerFilterStrategy

password

sslContextParameters

useGlobalSslContextParameters

username