Interface MailEndpointBuilderFactory.AdvancedMailEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
,MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Enclosing interface:
- MailEndpointBuilderFactory
public static interface MailEndpointBuilderFactory.AdvancedMailEndpointBuilder
extends MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder, MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
Advanced builder for endpoint for the IMAP component.
-
Method Summary
Modifier and TypeMethodDescriptionadditionalJavaMailProperties
(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.additionalJavaMailProperties
(Map values) Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.alternativeBodyHeader
(String alternativeBodyHeader) Specifies the key to an IN message header that contains an alternative email body.attachmentsContentTransferEncodingResolver
(String attachmentsContentTransferEncodingResolver) To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.attachmentsContentTransferEncodingResolver
(org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver attachmentsContentTransferEncodingResolver) To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.authenticator
(String authenticator) The authenticator for login.authenticator
(org.apache.camel.component.mail.MailAuthenticator authenticator) The authenticator for login.basic()
Sets the binding used to convert from a Camel message to and from a Mail message.binding
(org.apache.camel.component.mail.MailBinding binding) Sets the binding used to convert from a Camel message to and from a Mail message.connectionTimeout
(int connectionTimeout) The connection timeout in milliseconds.connectionTimeout
(String connectionTimeout) The connection timeout in milliseconds.contentType
(String contentType) The mail message content type.contentTypeResolver
(String contentTypeResolver) Resolver to determine Content-Type for file attachments.contentTypeResolver
(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver) Resolver to determine Content-Type for file attachments.debugMode
(boolean debugMode) Enable debug mode on the underlying mail framework.Enable debug mode on the underlying mail framework.headerFilterStrategy
(String headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.headerFilterStrategy
(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.ignoreUnsupportedCharset
(boolean ignoreUnsupportedCharset) Option to let Camel ignore unsupported charset in the local JVM when sending mails.ignoreUnsupportedCharset
(String ignoreUnsupportedCharset) Option to let Camel ignore unsupported charset in the local JVM when sending mails.ignoreUriScheme
(boolean ignoreUriScheme) Option to let Camel ignore unsupported charset in the local JVM when sending mails.ignoreUriScheme
(String ignoreUriScheme) Option to let Camel ignore unsupported charset in the local JVM when sending mails.javaMailProperties
(String javaMailProperties) Sets the java mail options.javaMailProperties
(Properties javaMailProperties) Sets the java mail options.session
(jakarta.mail.Session session) Specifies the mail session that camel should use for all mail interactions.Specifies the mail session that camel should use for all mail interactions.useInlineAttachments
(boolean useInlineAttachments) Whether to use disposition inline or attachment.useInlineAttachments
(String useInlineAttachments) Whether to use disposition inline or attachment.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, failOnDuplicateFileAttachment, failOnDuplicateFileAttachment, fetchSize, fetchSize, folderName, generateMissingAttachmentNames, handleDuplicateAttachmentNames, mailUidGenerator, mailUidGenerator, mapMailMessage, mapMailMessage, pollStrategy, pollStrategy, postProcessAction, postProcessAction
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
javaMailSender, javaMailSender, lazyStartProducer, lazyStartProducer
-
Method Details
-
basic
- Specified by:
basic
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
basic
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
-
additionalJavaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
additionalJavaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
additionalJavaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
additionalJavaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
additionalJavaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
additionalJavaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
values
- the values- Returns:
- the dsl builder
-
alternativeBodyHeader
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
alternativeBodyHeader
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
alternativeBodyHeader
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
alternativeBodyHeader
- the value to set- Returns:
- the dsl builder
-
attachmentsContentTransferEncodingResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
attachmentsContentTransferEncodingResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
attachmentsContentTransferEncodingResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
attachmentsContentTransferEncodingResolver
- the value to set- Returns:
- the dsl builder
-
attachmentsContentTransferEncodingResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
attachmentsContentTransferEncodingResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
attachmentsContentTransferEncodingResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
attachmentsContentTransferEncodingResolver
- the value to set- Returns:
- the dsl builder
-
authenticator
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
authenticator
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
authenticator
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
authenticator
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
authenticator
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
authenticator
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
authenticator
- the value to set- Returns:
- the dsl builder
-
binding
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
binding
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
binding
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
binding
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
binding
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
binding
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
binding
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder connectionTimeout(int connectionTimeout) The connection timeout in milliseconds. The option is a: <code>int</code> type. Default: 30000 Group: advanced- Specified by:
connectionTimeout
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
connectionTimeout
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder connectionTimeout(String connectionTimeout) The connection timeout in milliseconds. The option will be converted to a <code>int</code> type. Default: 30000 Group: advanced- Specified by:
connectionTimeout
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
connectionTimeout
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
connectionTimeout
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
contentType
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
contentType
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
contentType
- the value to set- Returns:
- the dsl builder
-
contentTypeResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
contentTypeResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
contentTypeResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
contentTypeResolver
- the value to set- Returns:
- the dsl builder
-
contentTypeResolver
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
contentTypeResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
contentTypeResolver
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
contentTypeResolver
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
debugMode
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
debugMode
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
debugMode
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
debugMode
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
debugMode
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
debugMode
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
ignoreUnsupportedCharset
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
ignoreUnsupportedCharset
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
ignoreUnsupportedCharset
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
ignoreUnsupportedCharset
- the value to set- Returns:
- the dsl builder
-
ignoreUnsupportedCharset
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
ignoreUnsupportedCharset
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
ignoreUnsupportedCharset
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
ignoreUnsupportedCharset
- the value to set- Returns:
- the dsl builder
-
ignoreUriScheme
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
ignoreUriScheme
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
ignoreUriScheme
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
ignoreUriScheme
- the value to set- Returns:
- the dsl builder
-
ignoreUriScheme
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
ignoreUriScheme
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
ignoreUriScheme
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
ignoreUriScheme
- the value to set- Returns:
- the dsl builder
-
javaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
javaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
javaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
javaMailProperties
- the value to set- Returns:
- the dsl builder
-
javaMailProperties
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
javaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
javaMailProperties
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
javaMailProperties
- the value to set- Returns:
- the dsl builder
-
session
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder session(jakarta.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>jakarta.mail.Session</code> type. Group: advanced- Specified by:
session
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
session
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
session
- the value to set- Returns:
- the dsl builder
-
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>jakarta.mail.Session</code> type. Group: advanced- Specified by:
session
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
session
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
session
- the value to set- Returns:
- the dsl builder
-
useInlineAttachments
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder useInlineAttachments(boolean useInlineAttachments) Whether to use disposition inline or attachment. The option is a: <code>boolean</code> type. Default: false Group: advanced- Specified by:
useInlineAttachments
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
useInlineAttachments
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
useInlineAttachments
- the value to set- Returns:
- the dsl builder
-
useInlineAttachments
default MailEndpointBuilderFactory.AdvancedMailEndpointBuilder 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- Specified by:
useInlineAttachments
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
- Specified by:
useInlineAttachments
in interfaceMailEndpointBuilderFactory.AdvancedMailEndpointProducerBuilder
- Parameters:
useInlineAttachments
- the value to set- Returns:
- the dsl builder
-