Hlavičky a metadata

Tato stránka popisuje dva způsoby, jak do e-mailu odeslaného přes e-mailové API přidat vlastní informace: headers, které se stanou součástí zprávy, kterou příjemce dostane, a meta, která Emailit uloží s e-mailem a vrací v API a ve webhoocích. Uvádí také hlavičky, které Emailit přidává, přepisuje nebo odstraňuje.

Přidejte vlastní hlavičky

Předejte headers jako objekt s názvy hlaviček a řetězcovými hodnotami:

{
  "from": "Acme <orders@acme.com>",
  "to": "ada@example.com",
  "subject": "Receipt for order 1042",
  "text": "Thanks for your order.",
  "headers": {
    "X-Entity-Ref-ID": "order-1042",
    "X-Acme-Account": "881"
  }
}

• Pro From, To, Cc, Bcc, Reply-To a Subject použijte pole požadavku, ne headers.
• Nenastavujte hlavičky, jejichž názvy začínají na X-Emailit-. Emailit je používá interně. Například zpráva, která už obsahuje X-Emailit-ID, se považuje za zpracovanou a přeskočí přepis hlaviček i podpis DKIM v Emailitu.
• Hlavičky, které Emailit nastavuje sám, například Message-ID a Date, se nahradí, i když je odešlete. Viz další sekce.

Hlavičky, které Emailit přidává nebo mění

SMTP relay stejně přepisuje i zprávy, které odešlete přes SMTP.

Přidejte List-Unsubscribe k hromadným e-mailům

Poskytovatelé schránek jako Gmail a Yahoo očekávají u propagačních a dalších hromadných e-mailů možnost odhlášení jedním kliknutím. Kampaně ji přidávají automaticky. U newsletterů nebo přehledů, které odesíláte přes API, přidejte obě hlavičky sami:

{
  "from": "Acme <news@acme.com>",
  "to": "ada@example.com",
  "subject": "Acme weekly digest",
  "html": "<p>This week at Acme…</p>",
  "headers": {
    "List-Unsubscribe": "<https://acme.com/unsubscribe?u=881&l=digest>, <mailto:unsubscribe@acme.com?subject=unsubscribe-881>",
    "List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
  }
}

• URL s https musí přijímat požadavek POST s tělem List-Unsubscribe=One-Click a odhlásit danou osobu, aniž by po ní chtěla potvrzení (RFC 8058).
• Vytvořte pro každého příjemce vlastní URL, aby váš endpoint věděl, koho má odhlásit.
• Emailit zahrnuje List-Unsubscribe a List-Unsubscribe-Post do podpisu DKIM, což poskytovatelé pro odhlášení jedním kliknutím vyžadují.

Další požadavky najdete v článku Jak splnit požadavky Gmailu a Yahoo na hromadné odesílatele?

Když se někdo odhlásí, přestaňte mu e-maily posílat. Můžete ho přidat na seznam blokovaných adres, aby Emailit další odeslání zablokoval.

Připojte metadata

meta je objekt s řetězcovými klíči a řetězcovými hodnotami, který Emailit uloží s každým e-mailem. Použijte ho k propojení e-mailu se záznamy ve vašem vlastním systému.

{
  "from": "Acme <orders@acme.com>",
  "to": "ada@example.com",
  "subject": "Receipt for order 1042",
  "text": "Thanks for your order.",
  "meta": {
    "order_id": "1042",
    "customer_id": "cus_881",
    "kind": "receipt"
  }
}

Čísla a logické hodnoty před odesláním převeďte na řetězce. Emailit vrací meta:

• V Načtení e-mailu, Načtení metadat a Výpisu e-mailů.
• V událostech webhooků pro daný e-mail: v data.object.meta u email.accepted, email.scheduled, email.canceled a událostí doručení a v data.object.email.meta u email.loaded a email.clicked.

Událost doručení s metadaty vypadá takto (zkráceno):

[
  {
    "type": "email.delivered",
    "data": {
      "object": {
        "id": "em_33VtK8mRq1xZp7LwN4cY2bHsDfa",
        "object": "email",
        "to": "ada@example.com",
        "subject": "Receipt for order 1042",
        "status": "delivered",
        "meta": { "order_id": "1042", "customer_id": "cus_881", "kind": "receipt" }
      }
    }
  }
]

Opakované odeslání e-mailu jeho metadata zachová. Přeposlání vytvoří nový e-mail bez nich.

Dohledejte e-maily později

Podle meta nelze e-maily vyhledávat ani filtrovat. Pokud chcete e-mail znovu najít:

• Ukládejte si ID. Uložte id, nebo u více příjemců mapu ids, ke svému vlastnímu záznamu a e-mail dohledejte přes Načtení e-mailu.
• Filtrujte výpis. Výpis e-mailů filtruje podle to, from, subject, status, created_at, updated_at, spam_score, api_key_id a sending_domain_id. Viz Filtrování.
• Používejte samostatné API klíče. Dejte každé aplikaci nebo funkci vlastní API klíč a pak filtrujte podle api_key_id, nebo podle API key v Email API›Emails.
• Párujte události webhooků. Z každé příchozí události přečtěte meta a přiřaďte ji ke správnému záznamu.

Související

• Odeslání e-mailu
• Hlavičky SMTP
• Typy událostí webhooků
• Slovník e-mailových hlaviček