Migrate from Amazon SES
Move from Amazon SES
to OpenEmail.
SESv2 calls, configuration sets and SNS events, mapped field by field, with a converter that rewrites your code.
The same email,
written both ways.
One message with a reply-to address and a tag, sent through Amazon SES and then through OpenEmail.
import { SESv2Client, SendEmailCommand } from '@aws-sdk/client-sesv2'const ses = new SESv2Client({ region: 'us-east-1' })const result = await ses.send(new SendEmailCommand({FromEmailAddress: 'Acme <[email protected]>',Destination: { ToAddresses: ['[email protected]'] },ReplyToAddresses: ['[email protected]'],Content: {Simple: {Subject: { Data: 'Your invoice is ready' },Body: { Html: { Data: '<p>Thanks for your order.</p>' } },},},EmailTags: [{ Name: 'category', Value: 'invoice' }],}),)console.log(result.MessageId)
import { init, openemail } from '@openemail/sdk'init({ apiKey: process.env.OPENEMAIL_API_KEY })const email = await openemail.emails.send({from: 'Acme <[email protected]>',to: ['[email protected]'],replyTo: '[email protected]',subject: 'Your invoice is ready',html: '<p>Thanks for your order.</p>',tags: { category: 'invoice' },})console.log(email.id)
Field by field,
what goes where.
Each option Amazon SES takes, and its place in OpenEmail.
| Amazon SES | OpenEmail | Notes |
|---|---|---|
FromEmailAddress | from | Also takes Name and address together. |
Destination.ToAddresses | to | CcAddresses and BccAddresses become cc and bcc. |
ReplyToAddresses | replyTo | One address per message. |
Content.Simple.Subject.Data | subject | A plain string. |
Content.Simple.Body.Html.Data | html | The text body goes in text. |
EmailTags: [{ Name, Value }] | tags: { Name: Value } | Up to 10 key and value pairs. |
Content.Template.TemplateData | template: { id, props } | Props are an object, not a JSON string. |
SendBulkEmail | emails.sendBatch | Up to 100 emails, each sent on its own. |
ConfigurationSetName | webhooks.create | Events arrive through webhooks. |
AWS credentials, region | OPENEMAIL_API_KEY | One key, and no region. |
Converter
Paste your Amazon SES code,
get it back on OpenEmail.
Pick where the code comes from and its language. Recognised keys are removed in your browser, and nothing you paste is kept.
Beyond the code,
four more steps.
- 01
Add your sending domain
Add it in OpenEmail and publish the DNS records it lists. Sending starts once the signing record answers.
- 02
Create an API key
Keys start with oe_live_ and carry only the scopes you give them.
- 03
Move your webhooks
Create an endpoint for the events listed below and check the X-OpenEmail-Signature header on every request.
- 04
Bring contacts and suppressions
Import your contacts as a CSV on an audience page, and add the addresses Amazon SES suppressed to the suppression list.
Webhook events,
renamed.
Each Amazon SES event and the OpenEmail event that replaces it. Every request carries one event, signed.
| Amazon SES | OpenEmail |
|---|---|
Send | email.sent |
Delivery | email.delivered |
DeliveryDelay | email.delivery_delayed |
Bounce | email.bounced |
Complaint | email.complained |
Open | email.opened |
Click | email.clicked |
Reject | email.failed |
Moving from Amazon SES,
answered.
Moving from
somewhere else?
Every guide has the same converter, field map and checklist.
Converted?
Create the key it reads.
A workspace takes a minute. Add your domain, create an API key and set OPENEMAIL_API_KEY.