Leitfaden
Von Mailtrap migrieren
Wechseln Sie von Mailtrap Email Sending zu Emailit. Streams, Tokens und Unterkonten zuordnen, API-Aufrufe und Handlebars-Vorlagen umwandeln, SMTP umstellen und Webhooks, Sperrungen und Kontakte umziehen.
Diese Anleitung ordnet Konzepte, API-Aufrufe, Webhooks, Sperrungen, Vorlagen und Kontakte von Mailtrap Email Sending ihren Entsprechungen in Emailit zu. Lesen Sie zuerst Zu Emailit migrieren für die allgemeine Reihenfolge und den parallelen Betrieb beider Anbieter.
Konzepte
| Mailtrap | Emailit |
|---|---|
| Organisation und Unterkonten | Konto und Workspaces. Jeder Workspace hat eigene Domains, Schlüssel, Mitglieder und Credits. |
| Versanddomains | Versanddomains |
| Transaktionaler Stream | Die E-Mail-API und das SMTP-Relay |
| Bulk-Stream | Kampagnen oder die API mit eigenen List-Unsubscribe-Headern |
| API-Tokens mit Berechtigungen pro Ressource | API-Schlüssel: Full Access oder Sending Only, optional auf eine Domain beschränkt |
| Demo-Domain | Neue Workspaces sind im Sandbox-Modus und können von Ihrer eigenen verifizierten Domain an Mitglieder des Workspace senden. |
| Email Sandbox (Tests) | Nicht verfügbar. Behalten Sie die Sandbox von Mailtrap für Tests oder senden Sie während der Entwicklung an Mitglieder des Workspace. |
| Vorlagen | Vorlagen mit Alias und Versionen, gerendert mit Temple |
| Webhooks pro Stream | Webhooks pro Workspace |
| Sperrungen pro Domain und Stream | Eine Sperrliste pro Workspace |
| E-Mail-Logs | Email APIEmails und Email APILogs |
category und custom_variables |
meta |
| Email Marketing: Kontakte, Listen, Kampagnen, Automatisierungen | Kontakte, Kontaktlisten, Kampagnen und Automatisierungen (Beta) |
| Eingehende E-Mails | Eingehende E-Mails |
Um die Reputation von transaktionalen und Marketing-E-Mails getrennt zu halten, wie es die beiden Streams von Mailtrap tun, senden Sie sie von unterschiedlichen Domains oder Subdomains, etwa mail.acme.com für Belege und news.acme.com für Newsletter.
API-Aufrufe anpassen
Aus POST /api/send von Mailtrap wird POST /v2/emails. Beide nehmen ein Bearer-Token und JSON an, aber Adressen sind bei Emailit einfache Strings statt Objekte:
curl https://send.api.mailtrap.io/api/send \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"from": { "email": "hello@acme.com", "name": "Acme" },
"to": [{ "email": "ada@example.com" }],
"subject": "Your receipt",
"text": "Thanks for your order.",
"html": "<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>"
}'| Mailtrap | Emailit |
|---|---|
Authorization: Bearer <token> oder Api-Token: <token> |
Authorization: Bearer secret_… |
send.api.mailtrap.io und bulk.api.mailtrap.io |
Ein Host, api.emailit.com |
from: { email, name } |
from: "Name <email>" |
to[], cc[], bcc[] mit email und name |
to, cc, bcc als String oder Array mit jeweils bis zu 50 |
reply_to: { email, name } |
reply_to |
subject, text, html, headers |
Identisch |
attachments[] mit content, filename, type, disposition und content_id |
attachments[] mit content, filename, content_type und content_id oder einer url statt content |
category |
meta, etwa meta: { "category": "password-reset" } |
custom_variables |
meta, in Webhook-Events zurückgegeben |
template_uuid und template_variables |
template (ein Alias oder eine ID) und variables |
| Tracking pro Domain festgelegt | Tracking pro Domain oder pro E-Mail mit tracking: { "loads": true, "clicks": true } festgelegt |
POST /api/batch (bis zu 500 Nachrichten) |
Nicht verfügbar. Senden Sie eine Anfrage pro Nachricht. |
Antwort mit message_ids, eine pro Empfänger |
200 mit id (em_…), status: "accepted" und, bei mehreren Empfängern, ids mit einer ID pro Empfänger |
Emailit unterstützt außerdem Planung mit scheduled_at und sichere Wiederholungen mit einem Header Idempotency-Key, was die Sende-API von Mailtrap nicht bietet. Siehe E-Mail senden.
SMTP-Einstellungen umstellen
| Einstellung | Mailtrap | Emailit |
|---|---|---|
| Host | live.smtp.mailtrap.io oder bulk.smtp.mailtrap.io für den Bulk-Stream |
smtp.emailit.com |
| Port | 587, 2525 oder 25 (STARTTLS), 465 (TLS) |
587, 2587, 2525 oder 25 (STARTTLS), 465 (TLS) |
| Benutzername | api |
emailit |
| Passwort | Ihr Mailtrap-API-Token | Ihr Emailit-API-Schlüssel |
Emailit liest die Header X-MT-Category und X-MT-Custom-Variables nicht. Entfernen Sie sie und nutzen Sie die API, wenn Sie Metadaten benötigen. Siehe SMTP-Einstellungen.
Webhook-Events zuordnen
| Mailtrap-Event | Emailit-Event |
|---|---|
delivery |
email.delivered |
soft bounce |
email.attempted, während Emailit es erneut versucht, dann email.bounced, wenn alle Wiederholungen fehlschlagen |
bounce |
email.bounced |
reject |
email.suppressed, wenn die Adresse eine Sperrung vom Typ recipient hat |
suspension |
email.held |
spam |
email.complained |
open |
email.loaded |
click |
email.clicked |
unsubscribe |
email.unsubscribed, nur für Kampagnen-E-Mails |
inbound.message_received |
email.received, dann den Inhalt mit GET /emails/{id} abrufen |
Emailit sendet außerdem email.accepted, wenn die API eine E-Mail annimmt. Siehe Event-Typen.
Das Anfrageformat ändert sich:
- Mailtrap sendet eine Liste
eventsmit bis zu 500 Events oder JSON Lines. Emailit sendet ein JSON-Array mit bis zu 100 Events als Anfrage-Body. - Der Event-Name steht in
typeund die E-Mail indata.object. Verwenden Siedata.object.id, dieem_-ID aus der Antwort auf den Versand, stattmessage_idunddata.object.tostattemail. Ihremeta-Werte, diecategoryundcustom_variablesersetzen, 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. - Der Header
Mailtrap-Signaturevon Mailtrap ist ein HMAC-SHA256 des unveränderten Bodys.X-Emailit-Signaturevon Emailit ist ein HMAC-SHA256 von<timestamp>.<raw body>mit Ihremwhsec_-Secret als Schlüssel. Lesen Sie daher auchX-Emailit-Timestampaus. 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 Ihre Sperrungen unter Suppressions in Mailtrap oder rufen Sie
GET https://mailtrap.io/api/suppressionsSeite für Seite ab, das bis zu 1.000 Einträge pro Aufruf zurückgibt. -
Erstellen Sie eine CSV-Datei mit den Spalten
email,type,reason:Typ in Mailtrap Typ in Emailit hard bounce,spam complaint,manual importrecipient, der Versände per API, SMTP und Kampagne blockiertunsubscriptionunsubscribe, der Kampagnen stoppt, transaktionale E-Mails aber weiter durchlässt. Verwenden Sierecipientfür Abmeldungen aus dem transaktionalen Stream.email,type,reason old-address@example.com,recipient,mailtrap hard bounce left@example.com,unsubscribe,mailtrap unsubscription -
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, sodass Adressen, die für mehrere Domains oder Streams von Mailtrap gesperrt sind, nur einmal hinzugefügt werden.
Siehe Sperrungen verwalten.
Kontakte umziehen
Wenn Sie Mailtrap Email Marketing nutzen, exportieren Sie Ihre Kontakte unter Contacts mit More Actions > Export oder mit POST https://mailtrap.io/api/contacts/exports, gefiltert nach subscription_status und list_id. Erstellen Sie zuerst die passenden eigenen Felder und Kontaktlisten in Emailit.
Importieren Sie nur angemeldete Kontakte, eine Kontaktliste nach der anderen, unter Email MarketingContacts mit Import. Der Import fügt alle Personen in der Datei als angemeldet hinzu. Fügen Sie abgemeldete Kontakte daher stattdessen mit dem Typ unsubscribe Ihrer CSV-Datei mit Sperrungen hinzu. Teilen Sie Dateien in Teile mit bis zu 2.500 Zeilen auf. Siehe Kontakte importieren und exportieren.
Vorlagen umziehen
Rufen Sie das HTML Ihrer Vorlagen mit GET https://mailtrap.io/api/email_templates ab, das für jede Vorlage body_html, body_text und subject zurückgibt. Importieren Sie jede unter Email MarketingTemplates oder erstellen Sie sie mit der Vorlagen-API und geben Sie ihr einen Alias, etwa receipt.
Mailtrap-Vorlagen verwenden Handlebars. Temple deckt die üblichen Teile ab:
| Mailtrap (Handlebars) | Emailit (Temple) |
|---|---|
{{name}}, {{user.name}} |
Identisch |
{{{html_block}}} |
{{html_block}}. Temple maskiert HTML nie, maskieren Sie Benutzereingaben also selbst. |
{{#if plan}}…{{else}}…{{/if}} |
Identisch |
{{#unless plan}}…{{/unless}} |
{{#if plan}}{{else}}…{{/if}} |
{{#if name}}{{name}}{{else}}Customer{{/if}} |
{{name|"Customer"}} |
{{#each items}}…{{/each}}, {{#with}} |
Nicht unterstützt. Rendern Sie die Liste in Ihrem Code und übergeben Sie sie als eine Variable. |
template_variables |
variables |
Siehe Temple und Vorlagen importieren und exportieren.
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 den DKIM-Einträgen rwmt1._domainkey und rwmt2._domainkey von Mailtrap noch mit dessen Verifizierungs-CNAME oder Tracking-CNAME mt-link. Behalten Sie Ihren DMARC-Eintrag. Siehe DNS-Einträge.
Entfernen Sie nach der Umstellung die DKIM-, Verifizierungs- und Tracking-Einträge von Mailtrap sowie include:_spf.mailtrap.io, falls Ihr SPF-Eintrag es noch enthält. Mailtrap empfängt eingehende E-Mails über den MX-Eintrag Ihrer Hauptdomain, Emailit dagegen auf einer Subdomain wie inbound.acme.com. Ziehen Sie eingehende E-Mails daher um und aktualisieren Sie Ihre Empfangsadressen, bevor Sie den MX-Eintrag ändern. 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