Průvodce
Přechod z Mailtrapu
Přejděte ze služby Mailtrap Email Sending na Emailit. Namapujte streamy, tokeny a podúčty, převeďte volání API a šablony Handlebars, změňte nastavení SMTP a přesuňte webhooky, blokované adresy a kontakty.
Tento průvodce mapuje pojmy, volání API, webhooky, blokované adresy, šablony a kontakty ze služby Mailtrap Email Sending na jejich ekvivalenty v Emailitu. Celkové pořadí a souběžný provoz obou poskytovatelů popisuje stránka Přechod na Emailit, přečtěte si ji jako první.
Principy
| Mailtrap | Emailit |
|---|---|
| Organization a sub-accounts | Účet a workspace. Každý workspace má vlastní domény, klíče, členy a kredity. |
| Sending domains | Odesílací domény |
| Transactional stream | E-mailové API a SMTP relay |
| Bulk stream | Kampaně, nebo API s vlastními hlavičkami List-Unsubscribe |
| API tokens s oprávněními pro jednotlivé zdroje | API klíče: Full Access, nebo Sending Only, volitelně omezený na jednu doménu |
| Demo domain | Nové workspace jsou v režimu sandbox a mohou z vaší vlastní ověřené domény odesílat členům workspace. |
| Email Sandbox (testování) | Není dostupné. Pro testování si ponechte sandbox Mailtrapu, nebo během vývoje posílejte e-maily členům workspace. |
| Templates | Šablony s aliasem a verzemi vykreslované jazykem Temple |
| Webhooky pro každý stream | Webhooky pro celý workspace |
| Suppressions pro každou doménu a stream | Jeden seznam blokovaných adres pro každý workspace |
| Email logs | Email APIEmails a Email APILogs |
category a custom_variables |
meta |
| Email Marketing: contacts, lists, campaigns, automations | Kontakty, seznamy kontaktů, kampaně a automatizace (betaverze) |
| Inbound email | Příchozí e-maily |
Pokud chcete oddělit reputaci transakční a marketingové pošty, jak to dělají dva streamy Mailtrapu, odesílejte je z různých domén nebo subdomén, například mail.acme.com pro účtenky a news.acme.com pro newslettery.
Upravte volání API
Z POST /api/send v Mailtrapu se stane POST /v2/emails. Oba přijímají bearer token a JSON, ale adresy jsou v Emailitu prosté řetězce místo objektů:
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> nebo Api-Token: <token> |
Authorization: Bearer secret_… |
send.api.mailtrap.io a bulk.api.mailtrap.io |
Jeden server, api.emailit.com |
from: { email, name } |
from: "Name <email>" |
to[], cc[], bcc[] s email a name |
to, cc, bcc jako řetězec nebo pole, každé až 50 adres |
reply_to: { email, name } |
reply_to |
subject, text, html, headers |
Stejně |
attachments[] s content, filename, type, disposition a content_id |
attachments[] s content, filename, content_type a content_id, nebo s url místo content |
category |
meta, například meta: { "category": "password-reset" } |
custom_variables |
meta, vrací se v událostech webhooků |
template_uuid a template_variables |
template (alias nebo ID) a variables |
| Měření nastavené pro doménu | Měření nastavené pro doménu, nebo pro jednotlivý e-mail přes tracking: { "loads": true, "clicks": true } |
POST /api/batch (až 500 zpráv) |
Není dostupné. Odešlete jeden požadavek na zprávu. |
Odpověď s message_ids, jedním pro každého příjemce |
200 s id (em_…), status: "accepted" a u více příjemců ids s jedním ID pro každého |
Emailit navíc podporuje plánování přes scheduled_at a bezpečné opakování požadavků s hlavičkou Idempotency-Key, což API Mailtrapu pro odesílání nenabízí. Viz Odeslání e-mailu.
Změňte nastavení SMTP
| Nastavení | Mailtrap | Emailit |
|---|---|---|
| Server | live.smtp.mailtrap.io, nebo bulk.smtp.mailtrap.io pro hromadný stream |
smtp.emailit.com |
| Port | 587, 2525 nebo 25 (STARTTLS), 465 (TLS) |
587, 2587, 2525 nebo 25 (STARTTLS), 465 (TLS) |
| Uživatelské jméno | api |
emailit |
| Heslo | Váš API token Mailtrapu | Váš API klíč Emailitu |
Emailit nečte hlavičky X-MT-Category ani X-MT-Custom-Variables. Odstraňte je, a když potřebujete metadata, použijte API. Viz Nastavení SMTP.
Namapujte události webhooků
| Událost Mailtrapu | Událost Emailitu |
|---|---|
delivery |
email.delivered |
soft bounce |
email.attempted, dokud Emailit opakuje doručení, pak email.bounced, pokud selžou všechny pokusy |
bounce |
email.bounced |
reject |
email.suppressed, když má adresa blokaci typu recipient |
suspension |
email.held |
spam |
email.complained |
open |
email.loaded |
click |
email.clicked |
unsubscribe |
email.unsubscribed, jen u e-mailů z kampaní |
inbound.message_received |
email.received, pak načtěte obsah přes GET /emails/{id} |
Emailit navíc posílá email.accepted, když API e-mail přijme. Viz Typy událostí.
Mění se formát požadavku:
- Mailtrap posílá seznam
eventss až 500 událostmi, nebo JSON Lines. Emailit posílá jako tělo požadavku pole JSON s až 100 událostmi. - Název události je v
typea e-mail vdata.object. Místomessage_idpoužívejtedata.object.id, IDem_z odpovědi na odeslání, a místoemailpoužívejtedata.object.to. Vaše hodnotymeta, které nahrazujícategoryacustom_variables, jsou vdata.object.meta. - U událostí
email.loadedaemail.clickedje vdata.objectnačtení nebo proklik. Jako ID e-mailu používejtedata.object.email_ida pro příjemce a vaše hodnotymetapoužívejtedata.object.email.rcpt_toadata.object.email.meta. - Hlavička
Mailtrap-Signaturev Mailtrapu je HMAC-SHA256 ze surového těla požadavku. HlavičkaX-Emailit-Signaturev Emailitu je HMAC-SHA256 z<timestamp>.<raw body>, jehož klíčem je váš tajný klíčwhsec_, proto čtěte iX-Emailit-Timestamp. Viz Podpis požadavku.
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);
}Přesuňte blokované adresy
-
Vyexportujte blokované adresy ze stránky Suppressions v Mailtrapu, nebo je načtěte po stránkách přes
GET https://mailtrap.io/api/suppressions, který vrací až 1 000 záznamů na volání. -
Sestavte jedno CSV se sloupci
email,type,reason:Typ v Mailtrapu Typ v Emailitu hard bounce,spam complaint,manual importrecipient, který blokuje odeslání přes API, SMTP i kampaněunsubscriptionunsubscribe, který zastaví kampaně, ale transakční e-maily propustí. Pro odhlášení z transakčního streamu použijterecipient.email,type,reason old-address@example.com,recipient,mailtrap hard bounce left@example.com,unsubscribe,mailtrap unsubscription -
V Email APISuppressions vyberte Import a nahrajte soubor. Každý soubor může mít až 10 000 řádků a nejvýše 8 MB. Duplicity se přeskočí, takže adresy blokované pro několik domén nebo streamů v Mailtrapu se přidají jen jednou.
Přesuňte kontakty
Pokud používáte Mailtrap Email Marketing, vyexportujte kontakty z Contacts přes More Actions > Export, nebo přes POST https://mailtrap.io/api/contacts/exports s filtrem podle subscription_status a list_id. Nejdřív v Emailitu vytvořte odpovídající vlastní pole a seznamy kontaktů.
Naimportujte jen přihlášené kontakty, a to po jednotlivých seznamech, v Email MarketingContacts přes Import. Import přidá všechny lidi v souboru jako přihlášené odběratele, proto odhlášené kontakty místo toho přidejte do souboru s blokovanými adresami s typem unsubscribe. Soubory rozdělte na části nejvýše po 2 500 řádcích. Viz Import a export kontaktů.
Přesuňte šablony
HTML svých šablon získáte přes GET https://mailtrap.io/api/email_templates, který u každé šablony vrací body_html, body_text a subject. Každou naimportujte v Email MarketingTemplates, nebo ji vytvořte přes API pro šablony, a dejte jí alias, například receipt.
Šablony Mailtrapu používají Handlebars. Temple pokrývá běžné části:
| Mailtrap (Handlebars) | Emailit (Temple) |
|---|---|
{{name}}, {{user.name}} |
Stejně |
{{{html_block}}} |
{{html_block}}. Temple nikdy neescapuje HTML, proto vstupy od uživatelů escapujte sami. |
{{#if plan}}…{{else}}…{{/if}} |
Stejně |
{{#unless plan}}…{{/unless}} |
{{#if plan}}{{else}}…{{/if}} |
{{#if name}}{{name}}{{else}}Customer{{/if}} |
{{name|"Customer"}} |
{{#each items}}…{{/each}}, {{#with}} |
Nepodporuje se. Vykreslete seznam ve svém kódu a předejte ho jako jednu proměnnou. |
template_variables |
variables |
Viz Temple a Import a export šablon.
Změňte DNS
Přidejte doménu v Email APIDomains a publikujte záznamy Emailitu. Používají vlastní názvy (emailit._domainkey, emailit.<domain> a volitelně go a inbound), takže nejsou v konfliktu se záznamy DKIM Mailtrapu rwmt1._domainkey a rwmt2._domainkey, s jeho ověřovacím CNAME záznamem ani s jeho CNAME záznamem pro měření mt-link. Záznam DMARC ponechte. Viz DNS záznamy odesílacích domén.
Po přepnutí provozu odstraňte záznamy Mailtrapu pro DKIM, ověření a měření a ze záznamu SPF odeberte include:_spf.mailtrap.io, pokud ho ještě obsahuje. Příchozí pošta Mailtrapu přijímá přes MX záznam vaší hlavní domény, příchozí pošta Emailitu na subdoméně, například inbound.acme.com, proto příchozí poštu přesuňte a přijímací adresy aktualizujte dřív, než MX záznam změníte. Viz Nastavení příchozích e-mailů.
Další kroky
- Kontrolní seznam před ostrým provozem
- Nastavení webhooku
- Prioritní migrace: nechte inženýry Emailitu provést přechod s vámi