AWS 2 Simple Email Service (SES)

Since Camel 3.1

Only producer is supported

The AWS2 SES component supports sending emails with Amazon’s SES service.

Prerequisites

You must have a valid Amazon Web Services developer account, and be signed up to use Amazon SES. More information is available at Amazon SES.

URI Format

aws2-ses://from[?options]

You can append query options to the URI in the following format, ?options=value&option2=value&…​

URI Options

The AWS 2 Simple Email Service (SES) component supports 16 options, which are listed below.

Name Description Default Type

amazonSESClient (producer)

To use the AmazonSimpleEmailService as the client

SesClient

autoDiscoverClient (common)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

boolean

configuration (producer)

component configuration

Ses2Configuration

lazyStartProducer (producer)

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

boolean

proxyHost (producer)

To define a proxy host when instantiating the SES client

String

proxyPort (producer)

To define a proxy port when instantiating the SES client

Integer

proxyProtocol (producer)

To define a proxy protocol when instantiating the SES client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

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()

String

replyToAddresses (producer)

List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header.

List

returnPath (producer)

The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header.

String

subject (producer)

The subject which is used if the message header 'CamelAwsSesSubject' is not present.

String

to (producer)

List of destination email address. Can be overriden with 'CamelAwsSesTo' header.

List

trustAllCertificates (producer)

If we want to trust all certificates in case of overriding the endpoint

false

boolean

basicPropertyBinding (advanced)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

accessKey (security)

Amazon AWS Access Key

String

secretKey (security)

Amazon AWS Secret Key

String

The AWS 2 Simple Email Service (SES) endpoint is configured using URI syntax:

aws2-ses:from

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

from

Required The sender’s email address.

String

Query Parameters (16 parameters):

Name Description Default Type

amazonSESClient (producer)

To use the AmazonSimpleEmailService as the client

SesClient

autoDiscoverClient (common)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

boolean

lazyStartProducer (producer)

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

boolean

proxyHost (producer)

To define a proxy host when instantiating the SES client

String

proxyPort (producer)

To define a proxy port when instantiating the SES client

Integer

proxyProtocol (producer)

To define a proxy protocol when instantiating the SES client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

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()

String

replyToAddresses (producer)

List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header.

List

returnPath (producer)

The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header.

String

subject (producer)

The subject which is used if the message header 'CamelAwsSesSubject' is not present.

String

to (producer)

List of destination email address. Can be overriden with 'CamelAwsSesTo' header.

List

trustAllCertificates (producer)

If we want to trust all certificates in case of overriding the endpoint

false

boolean

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

accessKey (security)

Amazon AWS Access Key

String

secretKey (security)

Amazon AWS Secret Key

String

Required SES component options

You have to provide the amazonSESClient in the Registry or your accessKey and secretKey to access the Amazon’s SES.

Usage

Message headers evaluated by the SES producer

Header Type Description

CamelAwsSesFrom

String

The sender’s email address.

CamelAwsSesTo

List<String>

The destination(s) for this email.

CamelAwsSesSubject

String

The subject of the message.

CamelAwsSesReplyToAddresses

List<String>

The reply-to email address(es) for the message.

CamelAwsSesReturnPath

String

The email address to which bounce notifications are to be forwarded.

CamelAwsSesHtmlEmail

Boolean

The flag to show if email content is HTML.

Message headers set by the SES producer

Header Type Description

CamelAwsSesMessageId

String

The Amazon SES message ID.

Advanced SesClient configuration

If you need more control over the SesClient instance configuration you can create your own instance and refer to it from the URI:

from("direct:start")
.to("aws2-ses://example@example.com?amazonSESClient=#client");

The #client refers to a SesClient in the Registry.

Automatic detection of SesClient client in registry

The component is capable of detecting the presence of an SesClient bean into the registry. If it’s the only instance of that type it will be used as client and you won’t have to define it as uri parameter. This may be really useful for smarter configuration of the endpoint.

Producer Examples

from("direct:start")
    .setHeader(SesConstants.SUBJECT, constant("This is my subject"))
    .setHeader(SesConstants.TO, constant(Collections.singletonList("to@example.com"))
    .setBody(constant("This is my message text."))
    .to("aws2-ses://from@example.com?accessKey=xxx&secretKey=yyy");

Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-ses</artifactId>
    <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel.

Spring Boot Auto-Configuration

When using aws2-ses with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-aws2-ses-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 17 options, which are listed below.

Name Description Default Type

camel.component.aws2-ses.access-key

Amazon AWS Access Key

String

camel.component.aws2-ses.amazon-s-e-s-client

To use the AmazonSimpleEmailService as the client. The option is a software.amazon.awssdk.services.ses.SesClient type.

String

camel.component.aws2-ses.auto-discover-client

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

Boolean

camel.component.aws2-ses.basic-property-binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.aws2-ses.configuration

component configuration. The option is a org.apache.camel.component.aws2.ses.Ses2Configuration type.

String

camel.component.aws2-ses.enabled

Whether to enable auto configuration of the aws2-ses component. This is enabled by default.

Boolean

camel.component.aws2-ses.lazy-start-producer

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

Boolean

camel.component.aws2-ses.proxy-host

To define a proxy host when instantiating the SES client

String

camel.component.aws2-ses.proxy-port

To define a proxy port when instantiating the SES client

Integer

camel.component.aws2-ses.proxy-protocol

To define a proxy protocol when instantiating the SES client

Protocol

camel.component.aws2-ses.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()

String

camel.component.aws2-ses.reply-to-addresses

List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header.

List

camel.component.aws2-ses.return-path

The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header.

String

camel.component.aws2-ses.secret-key

Amazon AWS Secret Key

String

camel.component.aws2-ses.subject

The subject which is used if the message header 'CamelAwsSesSubject' is not present.

String

camel.component.aws2-ses.to

List of destination email address. Can be overriden with 'CamelAwsSesTo' header.

List

camel.component.aws2-ses.trust-all-certificates

If we want to trust all certificates in case of overriding the endpoint

false

Boolean
Back to top