Migrar do Amazon SES

Este guia mostra a correspondência entre os conceitos, as chamadas à API, as notificações de eventos, as supressões e os templates do Amazon SES e os equivalentes no Emailit. Leia antes Migrar para o Emailit para conhecer a ordem geral e saber como usar os dois provedores em paralelo.

Conceitos

Atualizar as chamadas à API

As chamadas ao SES são assinadas com as suas credenciais da AWS, então normalmente você as faz por um SDK da AWS. Com o Emailit, você envia uma requisição JSON com uma chave de API ou usa o SDK do Emailit para a sua linguagem. Em Node.js:

import { SESv2Client, SendEmailCommand } from '@aws-sdk/client-sesv2';

const ses = new SESv2Client({ region: 'eu-west-1' });

await ses.send(new SendEmailCommand({
  FromEmailAddress: 'Acme <hello@acme.com>',
  Destination: { ToAddresses: ['ada@example.com'] },
  Content: {
    Simple: {
      Subject: { Data: 'Your receipt' },
      Body: {
        Text: { Data: 'Thanks for your order.' },
        Html: { Data: '<p>Thanks for your order.</p>' },
      },
    },
  },
}));

import { Emailit } from '@emailit/node';

const emailit = new Emailit(process.env.EMAILIT_API_KEY);

await emailit.emails.send({
  from: 'Acme <hello@acme.com>',
  to: 'ada@example.com',
  subject: 'Your receipt',
  text: 'Thanks for your order.',
  html: '<p>Thanks for your order.</p>',
});

O Emailit também oferece agendamento com scheduled_at e novas tentativas seguras com um cabeçalho Idempotency-Key, o que o SES não oferece no envio. Consulte Enviar um e-mail.

Mudar as configurações SMTP

O Emailit não lê cabeçalhos do SES como X-SES-CONFIGURATION-SET. Remova-os. Consulte Configurações SMTP.

Correspondência das notificações de eventos

O SES publica os eventos por meio de configuration sets no SNS, no EventBridge ou no Firehose. O Emailit os envia diretamente para o seu endpoint HTTPS como webhooks, então não há tópico para assinar nem confirmar.

O payload também muda:

• Cada requisição do Emailit é um array JSON de até 100 eventos, com o nome em type e o e-mail em data.object.
• Use data.object.id, o ID em_ da resposta do envio, em vez do messageId do SES. Os seus valores de meta ficam em data.object.meta.
• Em vez de conferir as assinaturas das mensagens do SNS, verifique X-Emailit-Signature com X-Emailit-Timestamp e o seu segredo whsec_. Consulte Assinatura das requisições.

for (const event of req.body) {
  const email = event.data.object;
  if (event.type === 'email.bounced') markBounced(email.to, email.id);
  if (event.type === 'email.complained') unsubscribe(email.to);
}

Migrar as supressões

1. Exporte a account-level suppression list do SES com a AWS CLI. Se a saída incluir um NextToken, repita o comando com --next-token até ter todas as páginas.

   Terminal

   aws sesv2 list-suppressed-destinations --output json \
     | jq -r '(["email","type","reason"] | @csv),
              (.SuppressedDestinationSummaries[] | [.EmailAddress, "recipient", ("ses " + .Reason)] | @csv)' \
     > suppressions.csv

   Isso grava um CSV com as colunas email,type,reason. Todas as linhas usam o tipo recipient, que bloqueia envios pela API, por SMTP e de campanhas para o endereço.

2. Se você mantém a sua própria lista de bounces e reclamações vindos das notificações do SNS, adicione esses endereços também.

3. Em Email API›Suppressions, selecione Import e envie o arquivo. Cada arquivo pode ter até 10.000 linhas e no máximo 8 MB. Os duplicados são ignorados.

Consulte Gerenciar supressões.

Migrar os templates

Obtenha cada template com aws sesv2 get-email-template --template-name <name> e depois importe o HTML dele em Email Marketing›Templates ou crie-o com a API de templates. Use o nome do template no SES como alias no Emailit, se ele se encaixar no formato de alias: letras minúsculas, números, - e _.

Os templates do SES usam tags no estilo Handlebars. O Temple cobre as partes mais comuns:

O Temple nunca escapa HTML, então escape o que vier dos usuários antes de passar. Consulte Temple.

Alterar o DNS

Adicione o seu domínio em Email API›Domains e publique os registros do Emailit. Eles usam nomes próprios (emailit._domainkey, emailit.<domain> e, opcionalmente, go e inbound), então não entram em conflito com os CNAMEs do Easy DKIM do SES nem com um subdomínio de custom MAIL FROM. Mantenha o seu registro DMARC. Consulte Registros DNS.

Depois da virada, remova os CNAMEs de DKIM do SES e os registros do custom MAIL FROM e exclua as identities no SES. Se você recebe e-mails com receipt rules do SES, mude antes para um subdomínio de recebimento do Emailit.

Próximos passos

• Checklist para entrar em produção
• Configurar webhooks
• Migração prioritária: deixe os engenheiros do Emailit fazerem a migração com você