Amazon SES Component
Send Emails through Amazon (AWS) SES
Component key: aws-ses
Description
Amazon SES is a service that enables developers to send mail from within any application. The Amazon SES component allows you to list identities, and send emails to those identities.
Before you can send an email using Amazon SES, you must verify that you are the owner of the email address or domain that you want to send email from. You can do that from the SES admin page on the AWS console.
Connections
AWS SES Access Key and Secret
An AWS IAM access key pair is required to interact with Amazon SES. Make sure that the key pair you generate in AWS has proper permissions to the SES resources you want to access. Read about Amazon SES IAM policies in the AWS docs.
Input | Notes | Example |
---|---|---|
Access Key ID string / Required accessKeyId | An AWS IAM Access Key ID | AKIAIOSFODNN7EXAMPLE |
Secret Access Key password / Required secretAccessKey | An AWS IAM Secret Access Key | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
AWS Role ARN
To enable the IAM role authentication begin by logging into the AWS Console and navigate to Identity and Access Management (IAM).
To create a user and generate credentials:
- Navigate to Users and select Create User.
- Provide a User name and check the box providing them user access to the AWS Managment Console if needed.
- Once completed with the User creation, copy the ARN provided in the summary for a later step.
-
To obtain the ARN for an existing User, click on the designated username from the Users page and the ARN will be provided in the summary section.
-
From the summary section, select Create access key
- Select Third-party service as the access key type and select next.
- Set a description and select create access key.
- Copy the Access Key and Secret access key and enter those into the connection configuration of your integration along with the ARN.
To create and assign a user a role:
- Navigate to Roles and select Create Role.
- Select Custom Trust Policy for the Trusted entity types
- Copy the following statement into the statement console. Making sure to replace the ARN with the user's actual ARN from the previous section
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "ARN"
},
"Action": "sts:AssumeRole"
}
]
}
- When adding permissions provide the AmazonSESFullAccess permission
- Complete remaining steps and select Create Role
Input | Notes | Example |
---|---|---|
Access Key ID string / Required accessKeyId | An AWS IAM Access Key ID | AKIAIOSFODNN7EXAMPLE |
Role ARN string / Required roleARN | An AWS IAM Role ARN | arn:aws:iam::OtherAccount-ID:role/assumed-role-name |
Secret Access Key password / Required secretAccessKey | An AWS IAM Secret Access Key | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
Actions
List Identities
List Identities available in Amazon SES | key: listIdentities
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required awsConnection | |||
AWS Region string awsRegion | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 | |
Identity Type string / Required identityType | EmailAddress | Provide the type of identity you want to list. | |
Next Token string nextToken | Specify the pagination token that's returned by a previous request to retrieve the next page of results | lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Example Payload for List Identities
{
"data": {
"$metadata": {
"httpStatusCode": 200,
"requestId": "4d41a619-b699-444b-9b09-7edbb92fc867",
"attempts": 1,
"totalRetryDelay": 0
},
"Identities": [
"example@example.com"
],
"NextToken": "exampleToken"
}
}
Send Email
Send an email through Amazon SES | key: sendEmail
Input | Notes | Example |
---|---|---|
Attachments string Key Value List attachments | Specify a file name as the key (i.e. 'my-file.pdf'), and the file as the value | |
Connection connection / Required awsConnection | ||
AWS Region string awsRegion | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
Bcc Address string Value List bcc | The destination for this email. The recipients to place on the BCC: line of the message. | example@example.com |
Cc Address string Value List cc | The destination for this email. The recipients to place on the CC: line of the message. | example@example.com |
Html string html | The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message. | <p>Hello World!</p> |
Reply To string Value List replyTo | The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. | example@example.com |
Sender Email string / Required sender | The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. | example@example.com |
Subject string / Required subject | The subject of the message: A short summary of the content, which will appear in the recipient's inbox. | My Email Subject |
Text string / Required text | The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices). | Hello World! |
To Address string / Required Value List to | The destination for this email. The recipients to place on the To: line of the message. | example@example.com |
Example Payload for Send Email
{
"data": {
"$metadata": {
"httpStatusCode": 200,
"requestId": "00000000-0000-0000-0000-000000000000",
"attempts": 1,
"totalRetryDelay": 0
},
"MessageId": "0000000000000000-00000000-0000-0000-0000-000000000000-000000"
}
}