Průvodce
Přechod z Elastic Emailu
Přejděte z Elastic Emailu na Emailit. Namapujte volání API v4 a v2, přístupové údaje k SMTP a oznámení, převeďte slučovací pole a přesuňte blokované adresy, kontakty a kampaně.
Tento průvodce mapuje pojmy, volání API, oznámení, blokované adresy, šablony a kontakty z Elastic Emailu 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
| Elastic Email | Emailit |
|---|---|
| Účet a subaccounts | Účet a workspace. Každý workspace má vlastní domény, klíče, členy a kredity. |
| API keys s úrovněmi přístupu | API klíče: Full Access, nebo Sending Only, volitelně omezený na jednu doménu |
| SMTP credentials | Váš API klíč použitý jako heslo k SMTP |
| Ověřené domény a ověřené adresy odesílatelů | Odesílací domény. Jednotlivé adresy odesílatelů nejsou dostupné. |
| Channels a postback values | meta |
| Templates, na které se odkazuje názvem | Šablony s aliasem a verzemi |
| Merge fields a template scripting | Temple: proměnné, výchozí hodnoty a podmínky |
| HTTP web notifications | Webhooky |
| Inbound routes | Příchozí e-maily |
| Suppressions a blokující stavy kontaktů | Blokované adresy |
| Contacts a lists | Kontakty a seznamy kontaktů |
| Segments | V každé kampani vyberte zahrnuté a vyloučené seznamy kontaktů. Segmenty jsou v alfaverzi a otevřené jen týmu Emailitu. |
| Campaigns a automations | Kampaně a automatizace (betaverze) |
| Forms | Formuláře (předběžný přístup), nebo URL pro přihlášení seznamu kontaktů |
| Email verification | Ověřování e-mailů |
| Private IPs a IP pools | Dedikované IP adresy na vyžádání |
Elastic Email přidává odkaz pro odhlášení do každého e-mailu, včetně e-mailů odeslaných přes API a SMTP. Emailit přidává hlavičky List-Unsubscribe jen do kampaní a do marketingových e-mailů z automatizací a viditelný odkaz přidáte sami pomocí {{unsubscribe_url}}. Pokud přes API nebo SMTP odesíláte newslettery nebo jinou hromadnou poštu, přidejte vlastní odkaz a hlavičky List-Unsubscribe. Viz Hlavičky a metadata.
Upravte volání API
Z POST /v4/emails/transactional v Elastic Emailu se stane POST /v2/emails. Tělo je ploché, názvy polí jsou malými písmeny a klíč se přesune do hlavičky 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 |
|---|---|
Hlavička X-ElasticEmail-ApiKey |
Authorization: Bearer secret_… |
Content.From |
from |
Recipients.To, CC, BCC |
to, cc, bcc, každé až 50 |
Content.ReplyTo |
reply_to |
Content.Subject |
subject |
Content.Body[] s ContentType HTML a PlainText |
html a text |
Content.Headers |
headers |
Content.Attachments[] s BinaryContent, Name, ContentType |
attachments[] s content, filename, content_type |
Content.AttachFiles (dříve nahrané soubory) |
attachments[] s url, odkud Emailit soubor stáhne |
Content.TemplateName |
template, alias nebo ID šablony |
Content.Merge |
variables |
Options.ChannelName, Content.Postback |
meta, vrací se v událostech webhooků |
Options.TrackOpens, Options.TrackClicks |
tracking: { "loads": true, "clicks": true } |
Options.TimeOffset (minuty) |
scheduled_at (ISO 8601 nebo běžná angličtina) |
Options.PoolName |
Není potřeba. Dedikovaná IP adresa odesílá všechny e-maily svého workspace. |
Content.Utm |
Přidejte do svých odkazů UTM parametry. Kampaně je přidávají za vás. |
POST /v4/emails s Recipients[].Fields (hromadné slučování) |
Jeden požadavek na příjemce, každý s vlastními variables |
Hlavička Idempotency-Key |
Hlavička Idempotency-Key, uchovává se 24 hodin |
Odpověď s TransactionID a MessageID |
200 s id (em_…), status: "accepted" a u více příjemců ids s jedním ID pro každého |
Pokud stále používáte API v2 (/v2/email/send s parametrem apikey), namapujte jeho pole formuláře stejně: z from a fromName se stane from, z bodyHtml a bodyText se stanou html a text, z polí merge_* se stanou variables a z template se stane template. Ve v2 dostane každá adresa v to samostatnou zprávu, podobně jako u skryté kopie. V Emailitu se příjemci z to navzájem vidí v hlavičce To, proto pro každého příjemce odešlete samostatný požadavek, aby zůstali oddělení. Viz Odeslání e-mailu.
Změňte nastavení SMTP
| Nastavení | Elastic Email | Emailit |
|---|---|---|
| Server | smtp.elasticemail.com |
smtp.emailit.com |
| Port | 2525, 587 nebo 25 (STARTTLS), 465 (TLS) |
587, 2587, 2525 nebo 25 (STARTTLS), 465 (TLS) |
| Uživatelské jméno | Název přístupových údajů SMTP, e-mailová adresa | emailit |
| Heslo | Token přístupových údajů SMTP | Váš API klíč Emailitu |
Emailit nečte řídicí hlavičky Elastic Emailu, například X-ElasticEmail-Channel, X-ElasticEmail-Postback, IsTransactional, trackopens nebo trackclicks. Odstraňte je a měření místo toho nastavte na doméně. Viz Nastavení SMTP.
Namapujte události webhooků
| Oznámení Elastic Emailu | Událost Emailitu |
|---|---|
Sent (server příjemce zprávu přijal) |
email.delivered |
Opened |
email.loaded |
Clicked |
email.clicked |
Error |
email.bounced u trvalých selhání. Při dočasných selháních se posílá email.attempted, dokud Emailit opakuje doručení. |
AbuseReport |
email.complained |
Unsubscribed |
email.unsubscribed, jen u e-mailů z kampaní |
| Inbound route, která posílá oznámení na URL | 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, a email.suppressed, když blokace typu recipient zablokuje adresu. Viz Typy událostí.
Mění se formát požadavku:
- Elastic Email posílá jednu událost na požadavek, v parametrech dotazu nebo jako plochý objekt JSON. Emailit posílá pole JSON s až 100 událostmi, proto tělo procházejte ve smyčce.
- Název události se přesune ze
statusdotypea e-mail je vdata.object. Místomessageidpoužívejtedata.object.id, IDem_z odpovědi na odeslání, a místotopoužívejtedata.object.to. Vaše hodnotymeta, které nahrazujíchannelapostback, 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. - Emailit podepisuje každý požadavek. Ověřujte
X-Emailit-Signature, hexadecimální HMAC-SHA256 z<timestamp>.<raw body>, vůčiX-Emailit-Timestampa vašemu tajnému klíčiwhsec_. Volitelné podepisování Elastic Emailu také používá tajné klíčewhsec_, ale podepisuje jiný řetězec, proto upravte svůj ověřovací kód. 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 adresy, které Elastic Email blokuje, ze stránky Suppressions v ovládacím panelu nebo přes API (
/v4/suppressions/bounces,/complaintsa/unsubscribes). -
Sestavte jedno CSV se sloupci
email,type,reason:Stav v Elastic Emailu Typ v Emailitu Invalid ( Bounced)recipientComplaint ( Abuse)recipientUnsubscribed unsubscribe, který zastaví kampaně, ale transakční e-maily propustí. Pokud chcete blokovat všechny e-maily, použijterecipient.email,type,reason old-address@example.com,recipient,elastic email bounced left@example.com,unsubscribe,elastic email unsubscribed -
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čí.
Přesuňte kontakty a kampaně
Vyexportujte kontakty z Contacts (vyberte je a pak More actions > Export) nebo přes POST /v4/contacts/export a vyexportujte každý seznam, kterému posíláte kampaně. Pak je přeneste podle stavu:
| Stav v Elastic Emailu | Kam patří |
|---|---|
| Engaged, Active | Naimportujte je přes Import do odpovídajícího seznamu kontaktů v Email MarketingContacts. |
| Transactional | Do seznamů kontaktů je nezařazujte. K odběru vašich marketingových e-mailů se nikdy nepřihlásili. |
| Invalid, Complaint, Unsubscribed | Na seznam blokovaných adres, jak je popsáno výše. |
| Inactive, Stale, Not Confirmed | Vynechte je. |
Před importem vytvořte vlastní pole pro pole svých kontaktů a soubory rozdělte na části nejvýše po 2 500 řádcích. Import přidá všechny lidi v souboru jako přihlášené odběratele, proto importujte jen ty, kteří mají dostávat vaše kampaně. Viz Import a export kontaktů.
Kampaně a automatizace znovu vytvořte v Email MarketingCampaigns a Automations a vyjděte přitom z naimportovaných šablon.
Přesuňte šablony
Zkopírujte HTML každé šablony přes Edit as HTML v Elastic Emailu, nebo ho načtěte přes GET /v4/templates/{name}, který ho vrací v Body. Naimportujte ho v Email MarketingTemplates, nebo šablonu vytvořte přes API pro šablony, a jako alias použijte název šablony, pokud odpovídá formátu aliasu: malá písmena, číslice, - a _.
Slučovací pole Elastic Emailu používají jednoduché složené závorky, Temple dvojité. Pole s jednoduchými závorkami, která v šabloně zůstanou, se odešlou jako prostý text, proto je převeďte všechna:
| Elastic Email | Emailit (Temple) |
|---|---|
{firstname}, {lastname}, {email} |
{{first_name}}, {{last_name}}, {{email}} v kampaních. Při odesílání přes API názvy, které předáte ve variables. |
{firstname:friend} |
{{first_name|"friend"}} |
{company} nebo jiné vlastní pole |
{{cf.company}} v kampaních |
{unsubscribe} |
{{unsubscribe_url}} v kampaních |
{contactprofile} |
{{manage_subscriptions_url}} v kampaních |
{view} |
{{webview_url}} v kampaních |
{accountaddress} a další pole účtu |
Napište je přímo do šablony, nebo je uložte jako globální hodnoty |
Template scripting v {{ … }} |
Nepodporuje se. Hodnoty vypočítejte ve svém kódu a pro podmíněný obsah použijte {{#if}}. |
Viz Slučovací značky a Temple.
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áznamem DKIM Elastic Emailu api._domainkey, s jeho CNAME záznamem tracking ani s vlastní doménou pro zprávy o nedoručení. Záznam DMARC ponechte. Viz DNS záznamy odesílacích domén.
Po přepnutí provozu odstraňte záznamy Elastic Emailu pro DKIM a měření a ze záznamu SPF odeberte include:_spf.elasticemail.com. Pokud přijímáte poštu přes inbound routes v Elastic Emailu, přesuňte ji nejdřív na příchozí subdoménu Emailitu. Emailit přijímá na subdoméně, například inbound.acme.com, takže se přijímací adresy změní.
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