AWS 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&…​

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

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

Name Description Default Type

bcc (producer)

List of comma-separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header.

String

cc (producer)

List of comma-separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header.

String

configuration (producer)

component configuration.

Ses2Configuration

configurationSet (producer)

Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header.

String

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

overrideEndpoint (producer)

Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option.

false

boolean

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

Enum values:

  • ap-south-2

  • ap-south-1

  • eu-south-1

  • eu-south-2

  • us-gov-east-1

  • me-central-1

  • il-central-1

  • ca-central-1

  • eu-central-1

  • us-iso-west-1

  • eu-central-2

  • us-west-1

  • us-west-2

  • af-south-1

  • eu-north-1

  • eu-west-3

  • eu-west-2

  • eu-west-1

  • ap-northeast-3

  • ap-northeast-2

  • ap-northeast-1

  • me-south-1

  • sa-east-1

  • ap-east-1

  • cn-north-1

  • us-gov-west-1

  • ap-southeast-1

  • ap-southeast-2

  • us-iso-east-1

  • ap-southeast-3

  • ap-southeast-4

  • us-east-1

  • us-east-2

  • cn-northwest-1

  • us-isob-east-1

  • aws-global

  • aws-cn-global

  • aws-us-gov-global

  • aws-iso-global

  • aws-iso-b-global

String

replyToAddresses (producer)

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

String

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 comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header.

String

uriEndpointOverride (producer)

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.

String

amazonSESClient (advanced)

Autowired To use the AmazonSimpleEmailService as the client.

SesClient

autowiredEnabled (advanced)

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

boolean

healthCheckConsumerEnabled (health)

Used for enabling or disabling all consumer based health checks from this component.

true

boolean

healthCheckProducerEnabled (health)

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

boolean

proxyHost (proxy)

To define a proxy host when instantiating the SES client.

String

proxyPort (proxy)

To define a proxy port when instantiating the SES client.

Integer

proxyProtocol (proxy)

To define a proxy protocol when instantiating the SES client.

Enum values:

  • HTTP

  • HTTPS

HTTPS

Protocol

accessKey (security)

Amazon AWS Access Key.

String

profileCredentialsName (security)

If using a profile credentials provider, this parameter will set the profile name.

String

secretKey (security)

Amazon AWS Secret Key.

String

sessionToken (security)

Amazon AWS Session Token used when the user needs to assume an IAM role.

String

trustAllCertificates (security)

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

false

boolean

useDefaultCredentialsProvider (security)

Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

false

boolean

useProfileCredentialsProvider (security)

Set whether the SES client should expect to load credentials through a profile credentials provider.

false

boolean

useSessionCredentials (security)

Set whether the SES client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SES.

false

boolean

Endpoint Options

The AWS 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 (producer)

Required The sender’s email address.

String

Query Parameters (23 parameters)

Name Description Default Type

bcc (producer)

List of comma-separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header.

String

cc (producer)

List of comma-separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header.

String

configurationSet (producer)

Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header.

String

overrideEndpoint (producer)

Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option.

false

boolean

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

Enum values:

  • ap-south-2

  • ap-south-1

  • eu-south-1

  • eu-south-2

  • us-gov-east-1

  • me-central-1

  • il-central-1

  • ca-central-1

  • eu-central-1

  • us-iso-west-1

  • eu-central-2

  • us-west-1

  • us-west-2

  • af-south-1

  • eu-north-1

  • eu-west-3

  • eu-west-2

  • eu-west-1

  • ap-northeast-3

  • ap-northeast-2

  • ap-northeast-1

  • me-south-1

  • sa-east-1

  • ap-east-1

  • cn-north-1

  • us-gov-west-1

  • ap-southeast-1

  • ap-southeast-2

  • us-iso-east-1

  • ap-southeast-3

  • ap-southeast-4

  • us-east-1

  • us-east-2

  • cn-northwest-1

  • us-isob-east-1

  • aws-global

  • aws-cn-global

  • aws-us-gov-global

  • aws-iso-global

  • aws-iso-b-global

String

replyToAddresses (producer)

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

String

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 comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header.

String

uriEndpointOverride (producer)

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.

String

lazyStartProducer (producer (advanced))

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

amazonSESClient (advanced)

Autowired To use the AmazonSimpleEmailService as the client.

SesClient

proxyHost (proxy)

To define a proxy host when instantiating the SES client.

String

proxyPort (proxy)

To define a proxy port when instantiating the SES client.

Integer

proxyProtocol (proxy)

To define a proxy protocol when instantiating the SES client.

Enum values:

  • HTTP

  • HTTPS

HTTPS

Protocol

accessKey (security)

Amazon AWS Access Key.

String

profileCredentialsName (security)

If using a profile credentials provider, this parameter will set the profile name.

String

secretKey (security)

Amazon AWS Secret Key.

String

sessionToken (security)

Amazon AWS Session Token used when the user needs to assume an IAM role.

String

trustAllCertificates (security)

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

false

boolean

useDefaultCredentialsProvider (security)

Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

false

boolean

useProfileCredentialsProvider (security)

Set whether the SES client should expect to load credentials through a profile credentials provider.

false

boolean

useSessionCredentials (security)

Set whether the SES client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in SES.

false

boolean

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

Static credentials, Default Credential Provider and Profile Credentials Provider

You have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

  • Java system properties - aws.accessKeyId and aws.secretKey.

  • Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

  • Web Identity Token from AWS STS.

  • The shared credentials and config files.

  • Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.

  • Amazon EC2 Instance profile credentials.

You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of static, default and profile credentials could be used at the same time.

For more information about this you can look at AWS credentials documentation

Message Headers

The AWS Simple Email Service (SES) component supports 10 message header(s), which is/are listed below:

Name Description Default Type

CamelAwsSesFrom (producer)

Constant: FROM

The sender’s email address.

String

CamelAwsSesMessageId (producer)

Constant: MESSAGE_ID

The Amazon SES message ID.

String

CamelAwsSesReplyToAddresses (producer)

Constant: REPLY_TO_ADDRESSES

The reply-to email address(es) for the message. Use comma to separate multiple values.

String

CamelAwsSesReturnPath (producer)

Constant: RETURN_PATH

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

String

CamelAwsSesSubject (producer)

Constant: SUBJECT

The subject of the message.

String

CamelAwsSesTo (producer)

Constant: TO

List of comma separated destination email address.

String

CamelAwsSesCc (producer)

Constant: CC

List of comma separated destination carbon copy (cc) email address.

String

CamelAwsSesBcc (producer)

Constant: BCC

List of comma separated destination blind carbon copy (bcc) email address.

String

CamelAwsSesHtmlEmail (producer)

Constant: HTML_EMAIL

The flag to show if email content is HTML.

Boolean

CamelAwsSesConfigurationSet (producer)

Constant: CONFIGURATION_SET

TThe configuration set to send.

String

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.

Examples

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.