Header und Metadaten

Diese Seite beschreibt zwei Wege, einer per E-Mail-API gesendeten E-Mail eigene Informationen hinzuzufügen: headers, die Teil der Nachricht werden, die der Empfänger erhält, und meta, das Emailit mit der E-Mail speichert und in der API und in Webhooks zurückgibt. Sie listet außerdem die Header auf, die Emailit hinzufügt, umschreibt oder entfernt.

Eigene Header hinzufügen

Übergeben Sie headers als Objekt aus Header-Namen und String-Werten:

{
  "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"
  }
}

• Verwenden Sie für From, To, Cc, Bcc, Reply-To und Subject die Felder der Anfrage, nicht headers.
• Setzen Sie keine Header, deren Namen mit X-Emailit- beginnen. Emailit verwendet sie intern. Eine Nachricht, die bereits X-Emailit-ID enthält, gilt zum Beispiel als verarbeitet und überspringt das Umschreiben der Header und die DKIM-Signatur durch Emailit.
• Header, die Emailit selbst setzt, etwa Message-ID und Date, werden ersetzt, auch wenn Sie sie mitsenden. Siehe nächster Abschnitt.

Header, die Emailit hinzufügt oder ändert

Das SMTP-Relay schreibt Nachrichten, die Sie per SMTP einliefern, auf dieselbe Weise um.

List-Unsubscribe zu Massen-E-Mails hinzufügen

Postfachanbieter wie Gmail und Yahoo erwarten bei Werbe- und anderen Massen-E-Mails eine Abmeldung mit einem Klick. Kampagnen fügen sie automatisch hinzu. Für Newsletter oder Digests, die Sie per API senden, fügen Sie beide Header selbst hinzu:

{
  "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"
  }
}

• Die https-URL muss eine POST-Anfrage mit dem Body List-Unsubscribe=One-Click annehmen und die Person ohne Bestätigung abmelden (RFC 8058).
• Machen Sie jede URL empfängerspezifisch, damit Ihr Endpunkt weiß, wen er abmelden soll.
• Emailit nimmt List-Unsubscribe und List-Unsubscribe-Post in die DKIM-Signatur auf, was Anbieter für die Abmeldung mit einem Klick verlangen.

Die übrigen Anforderungen finden Sie unter Wie erfülle ich die Anforderungen von Gmail und Yahoo an Massenversender?.

Wenn sich jemand abmeldet, senden Sie dieser Person nichts mehr. Sie können sie auf Ihre Sperrliste setzen, damit Emailit künftige Versände blockiert.

Metadaten anhängen

meta ist ein Objekt aus String-Schlüsseln und String-Werten, das Emailit mit jeder E-Mail speichert. Verknüpfen Sie damit eine E-Mail mit Datensätzen in Ihrem eigenen System.

{
  "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"
  }
}

Wandeln Sie Zahlen und Boolesche Werte vor dem Senden in Strings um. Emailit gibt meta zurück:

• In E-Mail abrufen, Metadaten abrufen und E-Mails auflisten.
• In Webhook-Events zur E-Mail: unter data.object.meta bei email.accepted, email.scheduled, email.canceled und den Zustell-Events sowie unter data.object.email.meta bei email.loaded und email.clicked.

Ein Zustell-Event mit Metadaten sieht so aus (gekürzt):

[
  {
    "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" }
      }
    }
  }
]

Beim erneuten Senden einer E-Mail bleiben ihre Metadaten erhalten. Eine Weiterleitung erstellt eine neue E-Mail ohne sie.

E-Mails später wiederfinden

Sie können E-Mails nicht nach meta durchsuchen oder filtern. So finden Sie eine E-Mail wieder:

• IDs speichern. Speichern Sie die id oder bei mehreren Empfängern die Zuordnung ids neben Ihrem eigenen Datensatz und rufen Sie die E-Mail mit E-Mail abrufen ab.
• Liste filtern. E-Mails auflisten filtert nach to, from, subject, status, created_at, updated_at, spam_score, api_key_id und sending_domain_id. Siehe Filtern und Sortieren.
• Separate API-Schlüssel verwenden. Geben Sie jeder Anwendung oder Funktion ihren eigenen API-Schlüssel und filtern Sie dann nach api_key_id oder unter Email API›Emails nach API key.
• Webhook-Events zuordnen. Lesen Sie meta aus jedem Event, um es beim Eintreffen dem richtigen Datensatz zuzuordnen.

Siehe auch

• E-Mail senden
• SMTP-Header
• Webhook-Event-Typen
• Lexikon der E-Mail-Header