Von SendGrid migrieren

Diese Anleitung ordnet Konzepte, API-Aufrufe, Webhooks, Sperrungen und Vorlagen von SendGrid ihren Entsprechungen in Emailit zu. Lesen Sie zuerst Zu Emailit migrieren für die allgemeine Reihenfolge und den parallelen Betrieb beider Anbieter.

Konzepte

API-Aufrufe anpassen

Aus POST /v3/mail/send von SendGrid wird POST /v2/emails. Die Anfrage ist flacher: Es gibt keine personalizations, und Adressen sind einfache Strings.

curl https://api.sendgrid.com/v3/mail/send \
  -H "Authorization: Bearer $SENDGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "personalizations": [{ "to": [{ "email": "ada@example.com" }] }],
    "from": { "email": "hello@acme.com", "name": "Acme" },
    "subject": "Your receipt",
    "content": [
      { "type": "text/plain", "value": "Thanks for your order." },
      { "type": "text/html", "value": "<p>Thanks for your order.</p>" }
    ]
  }'

curl https://api.emailit.com/v2/emails \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <hello@acme.com>",
    "to": "ada@example.com",
    "subject": "Your receipt",
    "text": "Thanks for your order.",
    "html": "<p>Thanks for your order.</p>"
  }'

Jeder Empfänger in einer Anfrage an Emailit wird zu einer eigenen E-Mail mit eigener ID. Um unterschiedlichen Personen unterschiedliche Variablen zu senden, was SendGrid mit mehreren personalizations erledigt, senden Sie eine Anfrage pro Empfänger. Fügen Sie einen Header Idempotency-Key hinzu, damit Wiederholungen sicher sind. Siehe E-Mail senden.

SMTP-Einstellungen umstellen

Emailit liest den Header X-SMTPAPI nicht. Entfernen Sie ihn und legen Sie das Tracking stattdessen bei der Domain fest. Siehe SMTP-Einstellungen.

Webhook-Events zuordnen

Wie SendGrid sendet Emailit ein JSON-Array von Events. Die Felder unterscheiden sich:

• Der Event-Name steht in type und die E-Mail in data.object. Verwenden Sie data.object.id (die em_-ID aus der Antwort auf den Versand) statt sg_message_id und data.object.to statt email.
• Ihre meta-Werte kommen in data.object.meta zurück.
• Emailit signiert Anfragen mit HMAC-SHA256 statt mit dem öffentlichen ECDSA-Schlüssel von SendGrid. Verifizieren Sie X-Emailit-Signature mit Ihrem whsec_-Secret. Siehe Anfragesignatur.

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);
}

Sperrungen umziehen

1. Exportieren Sie in SendGrid Ihre Bounces, Spam Reports, Invalid Emails und Global Unsubscribes, über die Suppression-Seiten oder mit den API-Endpunkten /v3/suppression/*. Blocks sind meist vorübergehend, Sie können sie also weglassen.

2. Erstellen Sie eine CSV-Datei mit den Spalten email,type,reason:

   CSV

   email,type,reason
   old-address@example.com,recipient,sendgrid bounce
   angry@example.com,recipient,sendgrid spam report

   Verwenden Sie den Typ recipient für Adressen, die nie E-Mails erhalten dürfen. Er blockiert Versände per API, SMTP und Kampagne. Die Typen bounce, complaint und unsubscribe stoppen nur Kampagnen.

3. Wählen Sie unter Email API›Suppressions die Option Import und laden Sie die Datei hoch. Jede Datei darf bis zu 10.000 Zeilen haben und höchstens 8 MB groß sein, teilen Sie größere Listen also auf. Duplikate werden übersprungen.

Importieren Sie Personen, die sich über Gruppen von Marketing-E-Mails abgemeldet haben, als Kontakte mit gesetztem unsubscribed, statt sie für alle E-Mails zu sperren. Siehe Sperrungen verwalten.

Vorlagen umziehen

Exportieren Sie das HTML jedes Dynamic Template aus SendGrid und importieren Sie es dann unter Email Marketing›Templates oder erstellen Sie die Vorlage mit der Vorlagen-API. Geben Sie jeder Vorlage einen Alias, etwa receipt, und senden Sie sie mit "template": "receipt".

Beide verwenden doppelte geschweifte Klammern, aber Temple ist kleiner als Handlebars:

Siehe Temple und Vorlagen importieren und exportieren.

DNS ändern

Fügen Sie Ihre Domain unter Email API›Domains hinzu und legen Sie die Einträge von Emailit an. Sie verwenden eigene Namen (emailit._domainkey, emailit.<domain> und optional go und inbound) und kollidieren daher nicht mit den CNAMEs für Domain Authentication oder Link Branding von SendGrid. Behalten Sie Ihren DMARC-Eintrag. Entfernen Sie nach der Umstellung die CNAMEs von SendGrid. Siehe DNS-Einträge.

Wenn Sie Inbound Parse genutzt haben, richten Sie den MX-Eintrag Ihres Parse-Hostnamens stattdessen auf Emailit. Um denselben Hostnamen zu behalten, etwa parse.acme.com, setzen Sie den inbound_key der Domain per API auf parse. Siehe Eingehende E-Mails einrichten.

Nächste Schritte

• Go-live-Checkliste
• Webhook einrichten
• Priority migration: Lassen Sie Engineers von Emailit den Umzug gemeinsam mit Ihnen erledigen