Leitfaden
Von Elastic Email migrieren
Wechseln Sie von Elastic Email zu Emailit. Aufrufe der API v4 und v2, SMTP-Zugangsdaten und Benachrichtigungen zuordnen, Merge Fields umwandeln und Sperrungen, Kontakte und Kampagnen umziehen.
Diese Anleitung ordnet Konzepte, API-Aufrufe, Benachrichtigungen, Sperrungen, Vorlagen und Kontakte von Elastic Email ihren Entsprechungen in Emailit zu. Lesen Sie zuerst Zu Emailit migrieren für die allgemeine Reihenfolge und den parallelen Betrieb beider Anbieter.
Konzepte
| Elastic Email | Emailit |
|---|---|
| Konto und Unterkonten | Konto und Workspaces. Jeder Workspace hat eigene Domains, Schlüssel, Mitglieder und Credits. |
| API-Schlüssel mit Zugriffsstufen | API-Schlüssel: Full Access oder Sending Only, optional auf eine Domain beschränkt |
| SMTP-Zugangsdaten | Ihr API-Schlüssel, als SMTP-Passwort verwendet |
| Verifizierte Domains und verifizierte Absenderadressen | Versanddomains. Einzelne Absenderadressen sind nicht verfügbar. |
| Channels und Postback-Werte | meta |
| Vorlagen, über ihren Namen angesprochen | Vorlagen mit Alias und Versionen |
| Merge Fields und Template-Scripting | Temple: Variablen, Standardwerte und Bedingungen |
| HTTP Web Notifications | Webhooks |
| Inbound-Routen | Eingehende E-Mails |
| Sperrungen und blockierende Kontaktstatus | Sperrungen |
| Kontakte und Listen | Kontakte und Kontaktlisten |
| Segmente | Wählen Sie in jeder Kampagne die einzuschließenden und auszuschließenden Kontaktlisten. Segmente sind in der Alpha und stehen nur dem Emailit-Team offen. |
| Kampagnen und Automatisierungen | Kampagnen und Automatisierungen (Beta) |
| Formulare | Formulare (Early Access) oder die Anmelde-URL einer Kontaktliste |
| E-Mail-Verifizierung | E-Mail-Verifizierung |
| Private IPs und IP-Pools | Dedizierte IPs auf Anfrage |
Elastic Email fügt jeder E-Mail einen Abmeldelink hinzu, auch bei Versänden per API und SMTP. Emailit fügt List-Unsubscribe-Header nur Kampagnen und Marketing-E-Mails aus Automatisierungen hinzu, und den sichtbaren Link fügen Sie selbst mit {{unsubscribe_url}} ein. Wenn Sie Newsletter oder andere Massen-E-Mails per API oder SMTP senden, fügen Sie Ihren eigenen Link und List-Unsubscribe-Header hinzu. Siehe Header und Metadaten.
API-Aufrufe anpassen
Aus POST /v4/emails/transactional von Elastic Email wird POST /v2/emails. Der Body ist flach, die Feldnamen sind kleingeschrieben, und der Schlüssel wandert in einen Header Authorization:
curl https://api.elasticemail.com/v4/emails/transactional \
-H "X-ElasticEmail-ApiKey: $ELASTICEMAIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"Recipients": { "To": ["ada@example.com"] },
"Content": {
"From": "Acme <hello@acme.com>",
"Subject": "Your receipt",
"Body": [
{ "ContentType": "HTML", "Content": "<p>Thanks for your order.</p>" },
{ "ContentType": "PlainText", "Content": "Thanks for your order." }
]
}
}'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>"
}'| Elastic Email (API v4) | Emailit |
|---|---|
Header X-ElasticEmail-ApiKey |
Authorization: Bearer secret_… |
Content.From |
from |
Recipients.To, CC, BCC |
to, cc, bcc, jeweils bis zu 50 |
Content.ReplyTo |
reply_to |
Content.Subject |
subject |
Content.Body[] mit ContentType HTML und PlainText |
html und text |
Content.Headers |
headers |
Content.Attachments[] mit BinaryContent, Name, ContentType |
attachments[] mit content, filename, content_type |
Content.AttachFiles (zuvor hochgeladene Dateien) |
attachments[] mit einer url, die Emailit herunterlädt |
Content.TemplateName |
template, ein Alias oder eine ID der Vorlage |
Content.Merge |
variables |
Options.ChannelName, Content.Postback |
meta, in Webhook-Events zurückgegeben |
Options.TrackOpens, Options.TrackClicks |
tracking: { "loads": true, "clicks": true } |
Options.TimeOffset (Minuten) |
scheduled_at (ISO 8601 oder englischer Klartext) |
Options.PoolName |
Nicht nötig. Eine dedizierte IP sendet alle E-Mails ihres Workspace. |
Content.Utm |
Fügen Sie Ihren Links UTM-Parameter hinzu. Kampagnen fügen sie für Sie hinzu. |
POST /v4/emails mit Recipients[].Fields (Bulk-Merge) |
Eine Anfrage pro Empfänger, jeweils mit eigenen variables |
Header Idempotency-Key |
Header Idempotency-Key, 24 Stunden lang gespeichert |
Antwort mit TransactionID und MessageID |
200 mit id (em_…), status: "accepted" und, bei mehreren Empfängern, ids mit einer ID pro Empfänger |
Wenn Sie noch die API v2 nutzen (/v2/email/send mit einem Parameter apikey), ordnen Sie deren Formularfelder auf dieselbe Weise zu: Aus from und fromName wird from, aus bodyHtml und bodyText werden html und text, aus den Feldern merge_* wird variables, und aus template wird template. In v2 erhält jede Adresse in to eine eigene Nachricht, wie bei Bcc. In Emailit sehen sich die Empfänger in to gegenseitig im Header To. Senden Sie daher eine Anfrage pro Empfänger, um sie voneinander zu trennen. Siehe E-Mail senden.
SMTP-Einstellungen umstellen
| Einstellung | Elastic Email | Emailit |
|---|---|---|
| Host | smtp.elasticemail.com |
smtp.emailit.com |
| Port | 2525, 587 oder 25 (STARTTLS), 465 (TLS) |
587, 2587, 2525 oder 25 (STARTTLS), 465 (TLS) |
| Benutzername | Der Name der SMTP-Zugangsdaten, eine E-Mail-Adresse | emailit |
| Passwort | Das Token der SMTP-Zugangsdaten | Ihr Emailit-API-Schlüssel |
Emailit liest die Steuer-Header von Elastic Email nicht, etwa X-ElasticEmail-Channel, X-ElasticEmail-Postback, IsTransactional, trackopens oder trackclicks. Entfernen Sie sie und legen Sie das Tracking stattdessen bei der Domain fest. Siehe SMTP-Einstellungen.
Webhook-Events zuordnen
| Benachrichtigung von Elastic Email | Emailit-Event |
|---|---|
Sent (der Server des Empfängers hat die Nachricht angenommen) |
email.delivered |
Opened |
email.loaded |
Clicked |
email.clicked |
Error |
email.bounced bei dauerhaften Fehlern. Vorübergehende Fehler lösen email.attempted aus, während Emailit es erneut versucht. |
AbuseReport |
email.complained |
Unsubscribed |
email.unsubscribed, nur für Kampagnen-E-Mails |
| Inbound-Route, die eine URL benachrichtigt | email.received, dann den Inhalt mit GET /emails/{id} abrufen |
Emailit sendet außerdem email.accepted, wenn die API eine E-Mail annimmt, und email.suppressed, wenn eine Sperrung vom Typ recipient eine Adresse blockiert. Siehe Event-Typen.
Das Anfrageformat ändert sich:
- Elastic Email sendet ein Event pro Anfrage, im Query-String oder als flaches JSON-Objekt. Emailit sendet ein JSON-Array mit bis zu 100 Events. Iterieren Sie also über den Body.
- Der Event-Name wandert von
statusnachtype, und die E-Mail steht indata.object. Verwenden Siedata.object.id, dieem_-ID aus der Antwort auf den Versand, stattmessageidunddata.object.tostattto. Ihremeta-Werte, diechannelundpostbackersetzen, stehen indata.object.meta. - Bei
email.loadedundemail.clickedistdata.objectder Ladevorgang oder der Klick. Verwenden Siedata.object.email_idfür die ID der E-Mail sowiedata.object.email.rcpt_tounddata.object.email.metafür den Empfänger und Ihremeta-Werte. - Emailit signiert jede Anfrage. Verifizieren Sie
X-Emailit-Signature, den hexadezimal kodierten HMAC-SHA256 von<timestamp>.<raw body>, anhand vonX-Emailit-Timestampund Ihremwhsec_-Secret. Die optionale Signatur von Elastic Email verwendet ebenfallswhsec_-Secrets, signiert aber einen anderen String. Passen Sie Ihren Verifizierungscode daher an. 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
-
Exportieren Sie die Adressen, die Elastic Email blockiert, unter Suppressions im Dashboard oder per API (
/v4/suppressions/bounces,/complaintsund/unsubscribes). -
Erstellen Sie eine CSV-Datei mit den Spalten
email,type,reason:Status in Elastic Email Typ in Emailit Invalid ( Bounced)recipientComplaint ( Abuse)recipientUnsubscribed unsubscribe, der Kampagnen stoppt, transaktionale E-Mails aber weiter durchlässt. Verwenden Sierecipient, um alle E-Mails zu blockieren.email,type,reason old-address@example.com,recipient,elastic email bounced left@example.com,unsubscribe,elastic email unsubscribed -
Wählen Sie unter Email APISuppressions 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. Duplikate werden übersprungen.
Siehe Sperrungen verwalten.
Kontakte und Kampagnen umziehen
Exportieren Sie Ihre Kontakte unter Contacts (markieren Sie sie und wählen Sie dann More actions > Export) oder mit POST /v4/contacts/export, und exportieren Sie jede Liste, an die Sie Kampagnen senden. Übernehmen Sie die Kontakte dann je nach Status:
| Status in Elastic Email | Wohin sie gehören |
|---|---|
| Engaged, Active | Importieren Sie sie unter Email MarketingContacts mit Import in die passende Kontaktliste. |
| Transactional | Lassen Sie sie aus Kontaktlisten heraus. Sie haben Ihre Marketing-E-Mails nie abonniert. |
| Invalid, Complaint, Unsubscribed | Die Sperrliste, wie oben beschrieben. |
| Inactive, Stale, Not Confirmed | Lassen Sie sie weg. |
Erstellen Sie vor dem Import eigene Felder für Ihre Kontaktfelder und teilen Sie Dateien in Teile mit bis zu 2.500 Zeilen auf. Der Import fügt alle Personen in der Datei als angemeldet hinzu. Importieren Sie daher nur Personen, die Ihre Kampagnen erhalten sollen. Siehe Kontakte importieren und exportieren.
Legen Sie Ihre Kampagnen und Automatisierungen unter Email MarketingCampaigns und Automations neu an, ausgehend von Ihren importierten Vorlagen.
Vorlagen umziehen
Kopieren Sie das HTML jeder Vorlage mit Edit as HTML in Elastic Email oder rufen Sie es mit GET /v4/templates/{name} ab, das es in Body zurückgibt. Importieren Sie es unter Email MarketingTemplates oder erstellen Sie die Vorlage mit der Vorlagen-API und verwenden Sie den Vorlagennamen als Alias, sofern er dem Alias-Format aus Kleinbuchstaben, Ziffern, - und _ entspricht.
Die Merge Fields von Elastic Email verwenden einfache geschweifte Klammern, Temple verwendet doppelte. Felder mit einfachen Klammern, die in einer Vorlage verbleiben, werden als Klartext gesendet. Wandeln Sie daher alle um:
| Elastic Email | Emailit (Temple) |
|---|---|
{firstname}, {lastname}, {email} |
{{first_name}}, {{last_name}}, {{email}} in Kampagnen. Bei Versänden per API die Namen, die Sie in variables übergeben. |
{firstname:friend} |
{{first_name|"friend"}} |
{company} oder ein anderes eigenes Feld |
{{cf.company}} in Kampagnen |
{unsubscribe} |
{{unsubscribe_url}} in Kampagnen |
{contactprofile} |
{{manage_subscriptions_url}} in Kampagnen |
{view} |
{{webview_url}} in Kampagnen |
{accountaddress} und andere Kontofelder |
Schreiben Sie sie in die Vorlage oder speichern Sie sie in globalen Werten |
Template-Scripting in {{ … }} |
Nicht unterstützt. Berechnen Sie Werte in Ihrem Code und verwenden Sie {{#if}} für bedingte Inhalte. |
Siehe Platzhalter und Temple.
DNS ändern
Fügen Sie Ihre Domain unter Email APIDomains 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 weder mit dem DKIM-Eintrag api._domainkey von Elastic Email noch mit dessen CNAME tracking oder einer eigenen Bounce-Domain. Behalten Sie Ihren DMARC-Eintrag. Siehe DNS-Einträge.
Entfernen Sie nach der Umstellung die DKIM- und Tracking-Einträge von Elastic Email sowie include:_spf.elasticemail.com aus Ihrem SPF-Eintrag. Wenn Sie E-Mails über Inbound-Routen von Elastic Email empfangen, verlagern Sie das zuerst auf eine Inbound-Subdomain von Emailit. Emailit empfängt auf einer Subdomain wie inbound.acme.com, daher ändern sich die Empfangsadressen.
Nächste Schritte
- Go-live-Checkliste
- Webhook einrichten
- Priority migration: Lassen Sie Engineers von Emailit den Umzug gemeinsam mit Ihnen erledigen