AWS SES Component

Table of Contents

URI Format
URI Options
Usage
Dependencies
See Also

Available as of Camel 2.8.4

The 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 are available at Amazon SES.

URI Format

aws-ses://from[?options]

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

URI Options

The AWS Simple Email Service component has no options.

The AWS Simple Email Service component supports 12 endpoint options which are listed below:

{% raw %}

Name	Group	Default	Java Type	Description
from	producer		`String`	Required The sender’s email address.
accessKey	producer		`String`	Amazon AWS Access Key
amazonSESClient	producer		`AmazonSimpleEmailService`	To use the AmazonSimpleEmailService as the client
amazonSESEndpoint	producer		`String`	The region with which the AWS-SES client wants to work with.
proxyHost	producer		`String`	To define a proxy host when instantiating the SQS client
proxyPort	producer		`Integer`	To define a proxy port when instantiating the SQS client
replyToAddresses	producer		`List`	List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header.
returnPath	producer		`String`	The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header.
secretKey	producer		`String`	Amazon AWS Secret Key
subject	producer		`String`	The subject which is used if the message header 'CamelAwsSesSubject' is not present.
to	producer		`List`	List of destination email address. Can be overriden with 'CamelAwsSesTo' header.
synchronous	advanced	`false`	`boolean`	Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

{% endraw %}

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

Table of Contents

Message headers evaluated by the SES producer
Message headers set by the SES producer
Advanced AmazonSimpleEmailService configuration

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`	Since Camel 2.12.3 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 AmazonSimpleEmailService configuration

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

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

The #client refers to a AmazonSimpleEmailService in the Registry.

For example if your Camel Application is running behind a firewall:

AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey");
ClientConfiguration clientConfiguration = new ClientConfiguration();
clientConfiguration.setProxyHost("http://myProxyHost");
clientConfiguration.setProxyPort(8080);
AmazonSimpleEmailService client = new AmazonSimpleEmailServiceClient(awsCredentials, clientConfiguration);

registry.bind("client", client);

Dependencies

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

pom.xml

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

where ${camel-version} must be replaced by the actual version of Camel (2.8.4 or higher).