[CONF] Apache Camel AWS-SES

2014-01-10 Thread willem jiang (Confluence)














  


willem jiang edited the page:
 


AWS-SES   






...



 Info








title
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



 Code Block




 

aws-ses://from[?options]
 



You can append query options to the URI in the following format, ?options=valueoption2=value...
...
Message headers evaluated by the SES producer



 Wiki Markup




 
{div:class=confluenceTableSmall}
|| Header || Type || Description ||
| {{CamelAwsSesFrom}} | {{String}} | The sender's email address. |
| {{CamelAwsSesTo}} | {{ListString}} | The destination(s) for this email. |
| {{CamelAwsSesSubject}} | {{String}} | The subject of the message. |
| {{CamelAwsSesReplyToAddresses}} | {{ListString}} | The reply-to email address(es) for the message. |
| {{CamelAwsSesReturnPath}} | 

[CONF] Apache Camel AWS-SES

2013-03-20 Thread confluence







AWS-SES
Page edited by Christian Mueller


 Changes (5)
 




...
h3. URI Options || Name || Default Value || Context || Description || 
|amazonSESClient | {{null}} | Producer | Reference to a {{com.amazonaws.services.simpleemail.AmazonSimpleEmailServiceClient}} in the [Registry]. | 
|accessKey | {{null}} | Producer | Amazon AWS Access Key | |secretKey | {{null}} | Producer | Amazon AWS Secret Key | 
...
 h4. Advanced AmazonSimpleEmailServiceClient configuration 
If you need more control over the {{AmazonSimpleEmailServiceClient}} {{AmazonSimpleEmailService}} instance configuration you can create your own instance and refer to it from the URI: 
{code} from(direct:start) .to(aws-ses://exam...@example.com?amazonSESClient=#amazonSESClient); {code} 
The {{#amazonSESClient}} {{#client}} refers to a {{AmazonSimpleEmailServiceClient}} in the [Registry]. 
 For example if your Camel Application is running behind a firewall: 
...
clientConfiguration.setProxyHost(http://myProxyHost); clientConfiguration.setProxyPort(8080); 
AmazonSimpleEmailServiceClient amazonSESClient AmazonSimpleEmailService client = new AmazonSimpleEmailServiceClient(awsCredentials, clientConfiguration); 
 registry.bind(client, client); 
{code}  
...


Full Content

SES Component
Available as of Camel 2.8.4

The ses component supports sending emails with Amazon's SES service.

PrerequisitesYou 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=valueoption2=value...

URI Options



 Name 
 Default Value 
 Context 
 Description 


amazonSESClient 
 null 
 Producer 
 Reference to a com.amazonaws.services.simpleemail.AmazonSimpleEmailService in the Registry. 


accessKey 
 null 
 Producer 
 Amazon AWS Access Key 


secretKey 
 null 
 Producer 
 Amazon AWS Secret Key 


amazonSESEndpoint 
 null 
 Producer 
 The region with which the AWS-SES client wants to work with. 


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


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


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


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





Required SES component optionsYou 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 
 ListString 
 The destination(s) for this email. 


 CamelAwsSesSubject 
 String 
 The subject of the message. 


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


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





Message headers set by the SES producer



 Header 
 Type 
 Description 


 CamelAwsSesMessageId 
 String 
 The Amazon SES message ID. 





Advanced AmazonSimpleEmailServiceClient 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://exam...@example.com?amazonSESClient=#amazonSESClient");


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
groupIdorg.apache.camel/groupId
artifactIdcamel-aws/artifactId
version${camel-version}/version
/dependency



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

See Also

	Configuring Camel
	Component
	Endpoint
	Getting Started



	AWS Component





[CONF] Apache Camel AWS-SES

2013-03-20 Thread confluence







AWS-SES
Page edited by Christian Mueller


 Changes (2)
 




...
{div}  
h4. Advanced AmazonSimpleEmailServiceClient configuration 
If you need more control over the {{AmazonSimpleEmailService}} instance configuration you can create your own instance and refer to it from the URI: {code} from(direct:start) 
.to(aws-ses://exam...@example.com?amazonSESClient=#amazonSESClient); .to(aws-ses://exam...@example.com?amazonSESClient=#client); 
{code} The {{#client}} refers to a {{AmazonSimpleEmailService}} in the [Registry]. 
...


Full Content

SES Component
Available as of Camel 2.8.4

The ses component supports sending emails with Amazon's SES service.

PrerequisitesYou 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=valueoption2=value...

URI Options



 Name 
 Default Value 
 Context 
 Description 


amazonSESClient 
 null 
 Producer 
 Reference to a com.amazonaws.services.simpleemail.AmazonSimpleEmailService in the Registry. 


accessKey 
 null 
 Producer 
 Amazon AWS Access Key 


secretKey 
 null 
 Producer 
 Amazon AWS Secret Key 


amazonSESEndpoint 
 null 
 Producer 
 The region with which the AWS-SES client wants to work with. 


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


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


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


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





Required SES component optionsYou 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 
 ListString 
 The destination(s) for this email. 


 CamelAwsSesSubject 
 String 
 The subject of the message. 


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


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





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://exam...@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
groupIdorg.apache.camel/groupId
artifactIdcamel-aws/artifactId
version${camel-version}/version
/dependency



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

See Also

	Configuring Camel
	Component
	Endpoint
	Getting Started



	AWS Component





Change Notification Preferences

View Online
|
View Changes
|
Add Comment