Migrate from Postmark
Move from Postmark
to OpenEmail.
Server tokens, message streams, templates and webhooks, 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 Postmark and then through OpenEmail.
import * as postmark from 'postmark'const client = new postmark.ServerClient(process.env.POSTMARK_SERVER_TOKEN)const result = await client.sendEmail({From: 'Acme <[email protected]>',To: '[email protected]',ReplyTo: '[email protected]',Subject: 'Your invoice is ready',HtmlBody: '<p>Thanks for your order.</p>',Tag: 'invoice',MessageStream: 'outbound',})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: { tag: 'invoice' },})console.log(email.id)
Field by field,
what goes where.
Each option Postmark takes, and its place in OpenEmail.
| Postmark | OpenEmail | Notes |
|---|---|---|
From, To, Cc, Bcc | from, to, cc, bcc | Lists instead of comma separated strings. |
HtmlBody, TextBody | html, text | Plain names for the two bodies. |
ReplyTo | replyTo | One address per message. |
Tag, Metadata | tags | Up to 10 key and value pairs. |
TrackOpens, TrackLinks | tracking: { opens, clicks } | Two switches on each message. |
TemplateAlias, TemplateModel | template: { id, props } | Recreate the template in OpenEmail first. |
Attachments[].Name | attachments[].filename | Base64 or bytes, 5 MB in total. |
Headers: [{ Name, Value }] | headers: { Name: Value } | One object of names and values. |
MessageStream | broadcasts.send | Broadcasts have a call of their own. |
sendEmailBatch | emails.sendBatch | Up to 100 emails, each sent on its own. |
Converter
Paste your Postmark 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 Postmark suppressed to the suppression list.
Webhook events,
renamed.
Each Postmark event and the OpenEmail event that replaces it. Every request carries one event, signed.
| Postmark | OpenEmail |
|---|---|
Delivery | email.delivered |
Bounce | email.bounced |
SpamComplaint | email.complained |
Open | email.opened |
Click | email.clicked |
SubscriptionChange | suppression.added |
Moving from Postmark,
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.