This content originally appeared on DEV Community and was authored by Jones Zachariah Noel
Amazon Simple Email Service (SES) is a AWS provisioned Email service which is available for cloud native applications to integrate and implementing use-cases which requires email messages to be sent.
Key takeaways from the blog -
- Features of SES
- Common use-cases with SES
- Setting up SES on your AWS Account
- Working with SES
Features of SES
- Sending emails to targeted audience.
- Analytics and monitoring of emails which are delivered, failed, bounced.
- Ease of integration with CLI and SDK.
- Verified the identities - email and domain which has permission to send emails.
- Highly scalable.
Common use-cases with SES
- Targeted email messages based on events or programmatically invoked from your application in Lambda Functions, EC2 instances or containers.
- Valid email templates which could be reused.
- With Amazon Pinpoint and Amazon Personalize sending marketing emails with content customized to user's preference.
- Bulk emails for easier communications with user specific data.
Setting up SES on your AWS Account
To get started with SES, you would have to move your SES account out of sandbox environment to production so that you can send emails to any email address. Note, if your SES account is in sandbox environment then you would be able to send emails only to verified identities only.
To move your SES account out of the sandbox, you would have to raise a support request with AWS and the use-case would evaluated based on which the account is moved to production access.
You can rase the support directly by clicking on Edit your account details button. And you would be prompted with the below screen, where you would have provide the email type and use-case description.
Another way to do it is, from the support page raising the limit increase support.
You can find the detailed steps to move SES out of Sandbox in the link.
And once, the support request is approved, your SES account would be moved out of Sandbox environment. The sending quota would also be reflected for your account.
SES uses verified identities to send emails. The two type of identities supported by SES are -
Email addresses : a valid email address should be verified by Amazon's verification process where the email identity would be receiving an email with a verification link.
Once your email is verified, you can send a test email from the console.
Domains : a particular domain would be verified if the domain is on Route53, it automatically adds up DNS records for sending emails. Otherwise, it will prompt you with the DNS records which has to be added to your domain.
Similar to email identities, once your domain is added and verified, you can send a test message. Now since your domain is enabled with email you can choose any email address of that domain.
Note, even though the domain is verified and the email address is also part of the same verified domain, the emails will have the from header asamazonses.com.
Working with SES
For sending emails with SES you can use both AWS CLI and AWS SDK. SDK also supports various languages, in this blog we will be using NodeJS SDK.
Creation of SES Email templates
To create a template on SES for that we would have to define a HTML and text content for the email along with parameters which would be sent when invoking a templated Email message. Create, update and delete of templates is only supported on CLI and SDK. Since this is a one-time execution, we would be doing it from the CLI.
template.json
{
"Template": {
"TemplateName": "SampleTemplate",
"SubjectPart": "Greetings, {{name}}!",
"HtmlPart": "<h1>Hello {{name}},</h1><p>this is a sample email with parameters -<br/> Name : {{name}}<br/>Email: {{email}}<br/></p>",
"TextPart": "Dear {{name}},\r\nYour email is {{email}}."
}
}
aws ses create-template --cli-input-json file://template.json
API reference : JavaScript, Python
Different ways of sending SES emails -
-
Formatted email : The email body is constructed and sent with
SendEmailAPI. This supports raw text format and also formatted HTML based content. Here we can define multiple recipients (to,ccandbcc) with email address separated with comma but this is limited to 50 recipients per email.
var params = {
Destination: {
CcAddresses: [
"test@zachjonesnoel.com"
],
ToAddresses: [
"example@zachjonesnoel.com",
"demo@zachjonesnoel.com"
]
},
Message: {
Body: {
Html: {
Charset: "UTF-8",
Data: "<p>This message body contains <b>HTML</b> formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"https://zachjonesnoel.com/\" target=\"_blank\">zachjonesnoel</a>.</p>"
},
Text: {
Charset: "UTF-8",
Data: "This is the demo message."
}
},
Subject: {
Charset: "UTF-8",
Data: "Test email"
}
},
ReplyToAddresses: [
"ro-repy@zachjonesnoel.com",
],
Source: "ro-repy@zachjonesnoel.com",
SourceArn: ""
};
await ses.sendEmail(params).promise()
API reference : JavaScript, Python
- Raw email : This is more flexible than Simple Email and additionally we can also send attachments with this. The rest of the functionalities are same. The message is a base64 encoded string.
var params = {
Destinations: [
"test@zachjonesnoel.com"
],
FromArn: "arn:aws:ses:us-east-1:xxxxxxxxx:identity/ro-repy@zachjonesnoel.com",
RawMessage: {
Data: <Binary String>
},
Source: "ro-repy@zachjonesnoel.com",
SourceArn: "arn:aws:ses:us-east-1:xxxxxxxxx:identity/ro-repy@zachjonesnoel.com"
}
await ses.sendRawEmail(params).promise()
API reference : JavaScript, Python
- Templated email : The template of email is defined and the respective template is also created with API or CLI. And whenever the emails are programmatically sent, you would have pass the parameters which are defined in the email template.
var params= {
"Source": "no-reply@zachjonesnoel.com",
"Template": "SampleTemplate",
"Destination": {
"ToAddresses": [
"test@zachjonesnoel.com"
]
},
"TemplateData": JSON.stringify({ "name": "zachjonesnoel", "email": "test@zachjonesnoel.com" })
}
await ses.sendTemplatedEmail(params).promise();
API reference : JavaScript, Python
- Bulk templated emails : Bulk emails also use templates where the same template would be used for multiple emails where the parameters are specific to the users. This would send dedicated emails to each user.
var params= {
"Source": "no-reply@zachjonesnoel.com",
"Template": "SampleTemplate",
"Destinations": [
{
"Destination": {
"ToAddresses": [
"test@zachjonesnoel.com"
]
},
"ReplacementTags": [
{
"Name": "name",
"Value": "zach"
},
{
"Name": "email",
"Value": "test@zachjonesnoel.com"
}
]
},
{
"Destination": {
"ToAddresses": [
"demo@zachjonesnoel.com"
]
},
"ReplacementTags": [
{
"Name": "name",
"Value": "jones"
},
{
"Name": "email",
"Value": "demo@zachjonesnoel.com"
}
]
}
]
}
await ses.sendBulkTemplatedEmail(params).promise();
API reference : JavaScript, Python
Conclusion
AWS SES provides simplistic integration methods where application developers can leverage the SDK based APIs for sendRawEmail, sendEmail, sendTemplatedEmail, sendBulkTemplatedEmail available in JavaScript, Python, PHP, Go, Java and .NET. SES provides APIs where it eases sending emails from a verified email or domain so the authenticity of the sender is verified. This also provides good feasibility with HTML based templates and formatting of email content.
Before getting started, don't forget to look into SES pricing.
This sample requires identities to be verified on AWS before sending emails, so haven't provided GitHub repository references. If you encounter any issues, don't hesitate to ping me on Twitter or LinkedIn.
This content originally appeared on DEV Community and was authored by Jones Zachariah Noel
Jones Zachariah Noel | Sciencx (2021-09-12T19:20:19+00:00) Amazon SES and everything to set it up. Retrieved from https://www.scien.cx/2021/09/12/amazon-ses-and-everything-to-set-it-up/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.