Interface MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
MailEndpointBuilderFactory.AdvancedMailEndpointBuilder
- Enclosing interface:
- MailEndpointBuilderFactory
public static interface MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the IMAP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
additionalJavaMailProperties(String key, Object value)
Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
additionalJavaMailProperties(Map values)
Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
alternativeBodyHeader(String alternativeBodyHeader)
Specifies the key to an IN message header that contains an alternative email body.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
attachmentsContentTransferEncodingResolver(String attachmentsContentTransferEncodingResolver)
To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
attachmentsContentTransferEncodingResolver(org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver attachmentsContentTransferEncodingResolver)
To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
authenticator(String authenticator)
The authenticator for login.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
authenticator(org.apache.camel.component.mail.MailAuthenticator authenticator)
The authenticator for login.default MailEndpointBuilderFactory.MailEndpointProducerBuilder
basic()
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
binding(String binding)
Sets the binding used to convert from a Camel message to and from a Mail message.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
binding(org.apache.camel.component.mail.MailBinding binding)
Sets the binding used to convert from a Camel message to and from a Mail message.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
connectionTimeout(int connectionTimeout)
The connection timeout in milliseconds.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
connectionTimeout(String connectionTimeout)
The connection timeout in milliseconds.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
contentType(String contentType)
The mail message content type.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
contentTypeResolver(String contentTypeResolver)
Resolver to determine Content-Type for file attachments.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
contentTypeResolver(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver)
Resolver to determine Content-Type for file attachments.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
debugMode(boolean debugMode)
Enable debug mode on the underlying mail framework.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
debugMode(String debugMode)
Enable debug mode on the underlying mail framework.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
ignoreUnsupportedCharset(boolean ignoreUnsupportedCharset)
Option to let Camel ignore unsupported charset in the local JVM when sending mails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
ignoreUnsupportedCharset(String ignoreUnsupportedCharset)
Option to let Camel ignore unsupported charset in the local JVM when sending mails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
ignoreUriScheme(boolean ignoreUriScheme)
Option to let Camel ignore unsupported charset in the local JVM when sending mails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
ignoreUriScheme(String ignoreUriScheme)
Option to let Camel ignore unsupported charset in the local JVM when sending mails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
javaMailProperties(String javaMailProperties)
Sets the java mail options.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
javaMailProperties(Properties javaMailProperties)
Sets the java mail options.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
javaMailSender(String javaMailSender)
To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
javaMailSender(org.apache.camel.component.mail.JavaMailSender javaMailSender)
To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
session(String session)
Specifies the mail session that camel should use for all mail interactions.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
session(javax.mail.Session session)
Specifies the mail session that camel should use for all mail interactions.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
useInlineAttachments(boolean useInlineAttachments)
Whether to use disposition inline or attachment.default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
useInlineAttachments(String useInlineAttachments)
Whether to use disposition inline or attachment.
-
-
-
Method Detail
-
basic
default MailEndpointBuilderFactory.MailEndpointProducerBuilder basic()
-
javaMailSender
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>org.apache.camel.component.mail.JavaMailSender</code> type. Group: producer (advanced)- Parameters:
javaMailSender
- the value to set- Returns:
- the dsl builder
-
javaMailSender
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder javaMailSender(String javaMailSender)
To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. The option will be converted to a <code>org.apache.camel.component.mail.JavaMailSender</code> type. Group: producer (advanced)- Parameters:
javaMailSender
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
additionalJavaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder additionalJavaMailProperties(String key, Object value)
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: <code>java.util.Properties</code> type. The option is multivalued, and you can use the additionalJavaMailProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
additionalJavaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder additionalJavaMailProperties(Map values)
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: <code>java.util.Properties</code> type. The option is multivalued, and you can use the additionalJavaMailProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced- Parameters:
values
- the values- Returns:
- the dsl builder
-
alternativeBodyHeader
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>java.lang.String</code> type. Default: CamelMailAlternativeBody Group: advanced- Parameters:
alternativeBodyHeader
- the value to set- Returns:
- the dsl builder
-
attachmentsContentTransferEncodingResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver</code> type. Group: advanced- Parameters:
attachmentsContentTransferEncodingResolver
- the value to set- Returns:
- the dsl builder
-
attachmentsContentTransferEncodingResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder attachmentsContentTransferEncodingResolver(String attachmentsContentTransferEncodingResolver)
To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. The option will be converted to a <code>org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver</code> type. Group: advanced- Parameters:
attachmentsContentTransferEncodingResolver
- the value to set- Returns:
- the dsl builder
-
authenticator
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>org.apache.camel.component.mail.MailAuthenticator</code> type. Group: advanced- Parameters:
authenticator
- the value to set- Returns:
- the dsl builder
-
authenticator
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder authenticator(String 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 will be converted to a <code>org.apache.camel.component.mail.MailAuthenticator</code> type. Group: advanced- Parameters:
authenticator
- the value to set- Returns:
- the dsl builder
-
binding
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder binding(org.apache.camel.component.mail.MailBinding binding)
Sets the binding used to convert from a Camel message to and from a Mail message. The option is a: <code>org.apache.camel.component.mail.MailBinding</code> type. Group: advanced- Parameters:
binding
- the value to set- Returns:
- the dsl builder
-
binding
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder binding(String binding)
Sets the binding used to convert from a Camel message to and from a Mail message. The option will be converted to a <code>org.apache.camel.component.mail.MailBinding</code> type. Group: advanced- Parameters:
binding
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder connectionTimeout(int connectionTimeout)
The connection timeout in milliseconds. The option is a: <code>int</code> type. Default: 30000 Group: advanced- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder connectionTimeout(String connectionTimeout)
The connection timeout in milliseconds. The option will be converted to a <code>int</code> type. Default: 30000 Group: advanced- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
contentType
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder contentType(String contentType)
The mail message content type. Use text/html for HTML mails. The option is a: <code>java.lang.String</code> type. Default: text/plain Group: advanced- Parameters:
contentType
- the value to set- Returns:
- the dsl builder
-
contentTypeResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder contentTypeResolver(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver)
Resolver to determine Content-Type for file attachments. The option is a: <code>org.apache.camel.component.mail.ContentTypeResolver</code> type. Group: advanced- Parameters:
contentTypeResolver
- the value to set- Returns:
- the dsl builder
-
contentTypeResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder contentTypeResolver(String contentTypeResolver)
Resolver to determine Content-Type for file attachments. The option will be converted to a <code>org.apache.camel.component.mail.ContentTypeResolver</code> type. Group: advanced- Parameters:
contentTypeResolver
- the value to set- Returns:
- the dsl builder
-
debugMode
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: advanced- Parameters:
debugMode
- the value to set- Returns:
- the dsl builder
-
debugMode
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder debugMode(String debugMode)
Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced- Parameters:
debugMode
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
ignoreUnsupportedCharset
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: advanced- Parameters:
ignoreUnsupportedCharset
- the value to set- Returns:
- the dsl builder
-
ignoreUnsupportedCharset
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder ignoreUnsupportedCharset(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced- Parameters:
ignoreUnsupportedCharset
- the value to set- Returns:
- the dsl builder
-
ignoreUriScheme
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: advanced- Parameters:
ignoreUriScheme
- the value to set- Returns:
- the dsl builder
-
ignoreUriScheme
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder ignoreUriScheme(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced- Parameters:
ignoreUriScheme
- the value to set- Returns:
- the dsl builder
-
javaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>java.util.Properties</code> type. Group: advanced- Parameters:
javaMailProperties
- the value to set- Returns:
- the dsl builder
-
javaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder javaMailProperties(String javaMailProperties)
Sets the java mail options. Will clear any default properties and only use the properties provided for this method. The option will be converted to a <code>java.util.Properties</code> type. Group: advanced- Parameters:
javaMailProperties
- the value to set- Returns:
- the dsl builder
-
session
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder 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: <code>javax.mail.Session</code> type. Group: advanced- Parameters:
session
- the value to set- Returns:
- the dsl builder
-
session
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder session(String 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 will be converted to a <code>javax.mail.Session</code> type. Group: advanced- Parameters:
session
- the value to set- Returns:
- the dsl builder
-
useInlineAttachments
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder useInlineAttachments(boolean useInlineAttachments)
Whether to use disposition inline or attachment. The option is a: <code>boolean</code> type. Default: false Group: advanced- Parameters:
useInlineAttachments
- the value to set- Returns:
- the dsl builder
-
useInlineAttachments
default MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder useInlineAttachments(String useInlineAttachments)
Whether to use disposition inline or attachment. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced- Parameters:
useInlineAttachments
- the value to set- Returns:
- the dsl builder
-
-