SendGrid からの移行

SendGrid から
OpenEmail へ移る。

Personalizations、ダイナミックテンプレート、カテゴリ、イベント Webhook のフィールドごとの対応と、コードを書き換えるコンバーター。

同じメールを、
両方の書き方で。

返信先アドレスとタグを 1 つずつ付けたメッセージを、まず SendGrid で、次に OpenEmail で送ります。

SendGrid
import sgMail from '@sendgrid/mail' sgMail.setApiKey(process.env.SENDGRID_API_KEY) try {  const [response] = await sgMail.send({    from: { email: '[email protected]', name: 'Acme' },    to: '[email protected]',    replyTo: '[email protected]',    subject: 'Your invoice is ready',    html: '<p>Thanks for your order.</p>',    categories: ['invoice'],  })  console.log(response.statusCode)} catch (error) {  console.error(error.response?.body ?? error)}
OpenEmail のコード
import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) try {  const email = await openemail.emails.send({    from: { email: '[email protected]', name: 'Acme' },    to: '[email protected]',    replyTo: '[email protected]',    subject: 'Your invoice is ready',    html: '<p>Thanks for your order.</p>',    tags: { category: 'invoice' },  })  console.log(email.status)} catch (error) {  console.error(error.message)}

フィールドごとに、
何がどこへ行くか。

SendGrid が受け付ける各オプションと、OpenEmail での置き場所。

SendGridOpenEmail備考
personalizations[].totopersonalization 1 件につきメッセージ 1 通。
reply_toreplyTo1 通につきアドレスは 1 つ。
content[]html, textコンテンツタイプごとにフィールドが 1 つ。
template_id, dynamic_template_datatemplate: { id, props }先に OpenEmail でテンプレートを作り直してください。
categories, custom_argstagsキーと値のペアを最大 10 個。
send_atscheduledAtUnix 秒ではなく日付。
tracking_settingstracking: { opens, clicks }メッセージごとに 2 つのスイッチ。
attachments[].typeattachments[].contentTypeBase64 またはバイト列で、合計 5 MB まで。
batch_idemails.cancel(id)メッセージごとに、その ID でキャンセルします。
asm.group_idsuppressions.add配信停止は 1 つの抑制リストにまとまります。

コンバーター

SendGrid のコードを貼り付けて、
OpenEmail 用のコードを受け取る。

コードの移行元と言語を選んでください。検出したキーはブラウザ内で取り除き、貼り付けた内容は保存しません。

SendGrid から
SendGrid のコード
OpenEmail のコード

OpenEmail のコードがここに表示されます

ファイルを貼り付けるかサンプルを読み込んでから、変換してください。

0 / 12,000 文字検出したキーは送信前に取り除きます。

コードのほかに、
あと 4 つのステップ。

  1. 01

    送信ドメインを追加する

    OpenEmail でドメインを追加し、表示される DNS レコードを公開します。署名レコードが応答すると、送信が始まります。

  2. 02

    API キーを作成する

    キーは oe_live_ で始まり、付与したスコープだけを持ちます。

  3. 03

    Webhook を移す

    下に挙げたイベント用のエンドポイントを作成し、すべてのリクエストで X-OpenEmail-Signature ヘッダーを確認してください。

  4. 04

    連絡先と抑制リストを移す

    連絡先はオーディエンスのページで CSV としてインポートし、SendGrid で抑制されていたアドレスは抑制リストに追加します。

Webhook イベントを、
新しい名前で。

SendGrid の各イベントと、それに代わる OpenEmail のイベント。どのリクエストにも、署名付きのイベントが 1 つ入っています。

SendGridOpenEmail
processedemail.sent
deliveredemail.delivered
deferredemail.delivery_delayed
bounceemail.bounced
droppedemail.suppressed
spamreportemail.complained
openemail.opened
clickemail.clicked
unsubscribesuppression.added

SendGrid からの移行について、
お答えします。

変換できましたか?
コードが読み込むキーを作りましょう。

ワークスペースは 1 分で作れます。ドメインを追加し、API キーを作成して、OPENEMAIL_API_KEY を設定してください。