camel-imap-kafka-connector sink configuration

Connector Description: Send and receive emails using imap, pop3 and smtp protocols.

When using camel-imap-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-imap-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.imap.CamelImapSinkConnector

The camel-imap sink connector supports 56 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.host

The mail server host name

null

true

HIGH

camel.sink.path.port

The port number of the mail server

null

false

MEDIUM

camel.sink.endpoint.bcc

Sets the BCC email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.sink.endpoint.cc

Sets the CC email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.sink.endpoint.from

The from email address

"camel@localhost"

false

MEDIUM

camel.sink.endpoint.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.

false

false

MEDIUM

camel.sink.endpoint.replyTo

The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma.

null

false

MEDIUM

camel.sink.endpoint.subject

The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option.

null

false

MEDIUM

camel.sink.endpoint.to

Sets the To email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.sink.endpoint.javaMailSender

To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.

null

false

MEDIUM

camel.sink.endpoint.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.

null

false

MEDIUM

camel.sink.endpoint.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.

"CamelMailAlternativeBody"

false

MEDIUM

camel.sink.endpoint.attachmentsContentTransfer EncodingResolver

To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.

null

false

MEDIUM

camel.sink.endpoint.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.

null

false

MEDIUM

camel.sink.endpoint.binding

Sets the binding used to convert from a Camel message to and from a Mail message

null

false

MEDIUM

camel.sink.endpoint.connectionTimeout

The connection timeout in milliseconds.

30000

false

MEDIUM

camel.sink.endpoint.contentType

The mail message content type. Use text/html for HTML mails.

"text/plain"

false

MEDIUM

camel.sink.endpoint.contentTypeResolver

Resolver to determine Content-Type for file attachments.

null

false

MEDIUM

camel.sink.endpoint.debugMode

Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default.

false

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.

null

false

MEDIUM

camel.sink.endpoint.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.

false

false

MEDIUM

camel.sink.endpoint.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.

false

false

MEDIUM

camel.sink.endpoint.javaMailProperties

Sets the java mail options. Will clear any default properties and only use the properties provided for this method.

null

false

MEDIUM

camel.sink.endpoint.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).

null

false

MEDIUM

camel.sink.endpoint.useInlineAttachments

Whether to use disposition inline or attachment.

false

false

MEDIUM

camel.sink.endpoint.password

The password for login. See also setAuthenticator(MailAuthenticator).

null

false

MEDIUM

camel.sink.endpoint.sslContextParameters

To configure security using SSLContextParameters.

null

false

MEDIUM

camel.sink.endpoint.username

The username for login. See also setAuthenticator(MailAuthenticator).

null

false

MEDIUM

camel.component.imap.bcc

Sets the BCC email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.component.imap.cc

Sets the CC email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.component.imap.from

The from email address

"camel@localhost"

false

MEDIUM

camel.component.imap.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.

false

false

MEDIUM

camel.component.imap.replyTo

The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma.

null

false

MEDIUM

camel.component.imap.subject

The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option.

null

false

MEDIUM

camel.component.imap.to

Sets the To email address. Separate multiple email addresses with comma.

null

false

MEDIUM

camel.component.imap.javaMailSender

To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.

null

false

MEDIUM

camel.component.imap.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.

null

false

MEDIUM

camel.component.imap.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.

"CamelMailAlternativeBody"

false

MEDIUM

camel.component.imap.attachmentsContentTransfer EncodingResolver

To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.

null

false

MEDIUM

camel.component.imap.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.

null

false

MEDIUM

camel.component.imap.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

false

MEDIUM

camel.component.imap.configuration

Sets the Mail configuration

null

false

MEDIUM

camel.component.imap.connectionTimeout

The connection timeout in milliseconds.

30000

false

MEDIUM

camel.component.imap.contentType

The mail message content type. Use text/html for HTML mails.

"text/plain"

false

MEDIUM

camel.component.imap.contentTypeResolver

Resolver to determine Content-Type for file attachments.

null

false

MEDIUM

camel.component.imap.debugMode

Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default.

false

false

MEDIUM

camel.component.imap.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.

false

false

MEDIUM

camel.component.imap.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.

false

false

MEDIUM

camel.component.imap.javaMailProperties

Sets the java mail options. Will clear any default properties and only use the properties provided for this method.

null

false

MEDIUM

camel.component.imap.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).

null

false

MEDIUM

camel.component.imap.useInlineAttachments

Whether to use disposition inline or attachment.

false

false

MEDIUM

camel.component.imap.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

camel.component.imap.password

The password for login. See also setAuthenticator(MailAuthenticator).

null

false

MEDIUM

camel.component.imap.sslContextParameters

To configure security using SSLContextParameters.

null

false

MEDIUM

camel.component.imap.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

false

MEDIUM

camel.component.imap.username

The username for login. See also setAuthenticator(MailAuthenticator).

null

false

MEDIUM

The camel-imap sink connector has no converters out of the box.

The camel-imap sink connector has no transforms out of the box.

The camel-imap sink connector has no aggregation strategies out of the box.

Back to top