blob: 6892f020517b6ba13844aa9c9f6e726929d552d0 [file] [log] [blame]
// kafka-connector options: START
[[camel-aws2-ses-kafka-connector-sink]]
= camel-aws2-ses-kafka-connector sink configuration
When using camel-aws2-ses-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-aws2-ses-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-aws2-ses sink connector supports 21 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.from* | The sender's email address. | null | HIGH
| *camel.sink.endpoint.amazonSESClient* | To use the AmazonSimpleEmailService as the client | null | 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 | MEDIUM
| *camel.sink.endpoint.proxyHost* | To define a proxy host when instantiating the SES client | null | MEDIUM
| *camel.sink.endpoint.proxyPort* | To define a proxy port when instantiating the SES client | null | MEDIUM
| *camel.sink.endpoint.proxyProtocol* | To define a proxy protocol when instantiating the SES client One of: [HTTP] [HTTPS] | "HTTPS" | MEDIUM
| *camel.sink.endpoint.region* | The region in which SES client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | null | MEDIUM
| *camel.sink.endpoint.replyToAddresses* | List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | null | MEDIUM
| *camel.sink.endpoint.returnPath* | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | null | MEDIUM
| *camel.sink.endpoint.subject* | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | null | MEDIUM
| *camel.sink.endpoint.to* | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | null | 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 | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.accessKey* | Amazon AWS Access Key | null | MEDIUM
| *camel.sink.endpoint.secretKey* | Amazon AWS Secret Key | null | MEDIUM
| *camel.component.aws2-ses.accessKey* | Amazon AWS Access Key | null | MEDIUM
| *camel.component.aws2-ses.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 | MEDIUM
| *camel.component.aws2-ses.region* | The region in which SES client needs to work | null | MEDIUM
| *camel.component.aws2-ses.secretKey* | Amazon AWS Secret Key | null | MEDIUM
| *camel.component.aws2-ses.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.aws2-ses.configuration* | The AWS SES default configuration | null | MEDIUM
|===
// kafka-connector options: END