// kafka-connector options: START
[[camel-imaps-kafka-connector-sink]]
= camel-imaps-kafka-connector sink configuration

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

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-imaps-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

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.imaps.CamelImapsSinkConnector
----


The camel-imaps sink connector supports 58 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| 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.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | 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.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | 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.imaps.bcc* | Sets the BCC email address. Separate multiple email addresses with comma. | null | false | MEDIUM
| *camel.component.imaps.cc* | Sets the CC email address. Separate multiple email addresses with comma. | null | false | MEDIUM
| *camel.component.imaps.from* | The from email address | "camel@localhost" | false | MEDIUM
| *camel.component.imaps.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.imaps.replyTo* | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. | null | false | MEDIUM
| *camel.component.imaps.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.imaps.to* | Sets the To email address. Separate multiple email addresses with comma. | null | false | MEDIUM
| *camel.component.imaps.javaMailSender* | To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. | null | false | MEDIUM
| *camel.component.imaps.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.imaps.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.imaps.attachmentsContentTransfer EncodingResolver* | To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. | null | false | MEDIUM
| *camel.component.imaps.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.imaps.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | false | LOW
| *camel.component.imaps.configuration* | Sets the Mail configuration | null | false | MEDIUM
| *camel.component.imaps.connectionTimeout* | The connection timeout in milliseconds. | 30000 | false | MEDIUM
| *camel.component.imaps.contentType* | The mail message content type. Use text/html for HTML mails. | "text/plain" | false | MEDIUM
| *camel.component.imaps.contentTypeResolver* | Resolver to determine Content-Type for file attachments. | null | false | MEDIUM
| *camel.component.imaps.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.imaps.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.imaps.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.imaps.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.imaps.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.imaps.useInlineAttachments* | Whether to use disposition inline or attachment. | false | false | MEDIUM
| *camel.component.imaps.headerFilterStrategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | null | false | MEDIUM
| *camel.component.imaps.password* | The password for login. See also setAuthenticator(MailAuthenticator). | null | false | MEDIUM
| *camel.component.imaps.sslContextParameters* | To configure security using SSLContextParameters. | null | false | MEDIUM
| *camel.component.imaps.useGlobalSslContext Parameters* | Enable usage of global SSL context parameters. | false | false | MEDIUM
| *camel.component.imaps.username* | The username for login. See also setAuthenticator(MailAuthenticator). | null | false | MEDIUM
|===



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





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





The camel-imaps sink connector has no aggregation strategies out of the box.
// kafka-connector options: END
