diff --git a/Home.md b/Home.md index 93a012c..5bf1207 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,51 @@ -# Deploy the Project on CamelX Platform +# AWS Simple Email Service (SES) -Deploy on CamelX Platform in three steps +Send e-mails through AWS SES service. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `aws2-ses` | +| Support Level | Stable | +| Labels | cloud,mail | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-aws2-ses + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `from` | string | ✓ | | The sender's email address. | +| `bcc` | string | | | List of comma-separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header. | +| `cc` | string | | | List of comma-separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header. | +| `configurationSet` | string | | | Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header. | +| `overrideEndpoint` | boolean | | `false` | Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option | +| `region` | string | | | 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() | +| `replyToAddresses` | string | | | List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | +| `returnPath` | string | | | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | +| `subject` | string | | | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | +| `to` | string | | | List of comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header. | +| `uriEndpointOverride` | string | | | Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option | +| `lazyStartProducer` | boolean | | `false` | 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. | +| `amazonSESClient` | object | | | To use the AmazonSimpleEmailService as the client | +| `proxyHost` | string | | | To define a proxy host when instantiating the SES client | +| `proxyPort` | integer | | | To define a proxy port when instantiating the SES client | +| `proxyProtocol` | object | | `HTTPS` | To define a proxy protocol when instantiating the SES client | +| `accessKey` | string | | | Amazon AWS Access Key | +| `profileCredentialsName` | string | | | If using a profile credentials provider, this parameter will set the profile name | +| `secretKey` | string | | | Amazon AWS Secret Key | +| `sessionToken` | string | | | Amazon AWS Session Token used when the user needs to assume an IAM role | +| `trustAllCertificates` | boolean | | `false` | If we want to trust all certificates in case of overriding the endpoint | +| `useDefaultCredentialsProvider` | boolean | | `false` | Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. | +| `useProfileCredentialsProvider` | boolean | | `false` | Set whether the SES client should expect to load credentials through a profile credentials provider. | +| `useSessionCredentials` | boolean | | `false` | 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. |