Ihre Anwendung sendet strukturierte Daten an einen HTTP-Endpunkt und erhält eine Antwort mit dem Nachrichtenergebnis oder einem Fehler. Diese Anfrage und Antwort bilden die Arbeitsfläche einer E-Mail-API.
Was deckt eine E-Mail-API ab?
Ein Sende-Endpunkt akzeptiert Empfänger, einen Betreff und Text- oder HTML-Inhalt. Er kann auch Header, Tags, Templates und Anhänge akzeptieren, wenn der Anbieter sie unterstützt.
Ein Event-Endpunkt oder Webhook meldet, was nach der Annahme passiert ist. Typische Events sind Zustellung, Bounce, Beschwerde, Öffnung und Klick. Eine empfangende API wandelt eingehende E-Mails in strukturierte Nachrichten für Ihre Anwendung um, statt Sie ein Postfach abfragen zu lassen.
Wie unterscheidet sich eine E-Mail-API von SMTP?
SMTP erfordert, dass Ihre Anwendung eine Verbindung öffnet, sich authentifiziert, Befehle sendet und Antwortcodes liest. Eine E-Mail-API nutzt stattdessen HTTP-Anfragen, sodass eine Client-Bibliothek Verbindungswiederverwendung, JSON-Kodierung, Wiederholungsversuche und Antwortverarbeitung übernehmen kann.
Wählen Sie eine API, wenn Ihre Anwendung bereits HTTP verwendet, strukturierte Events benötigt oder in einer Umgebung läuft, in der das Öffnen von SMTP-Verbindungen umständlich ist. Wählen Sie ein SMTP-Relay, wenn eine vorhandene Mail-Bibliothek oder ein Mailserver bereits SMTP spricht. Beide Wege können dieselbe Nachricht zustellen.
| Aufgabe | Sende-API | SMTP-Relay | Postfach-API |
|---|---|---|---|
| Nachricht senden | Ja | Ja | Antworten oder Verfassen |
| Geparste Mail empfangen | Einige Anbieter | Nein | Ja |
| Gesprächsverlauf lesen | Einige Anbieter | Nein | Ja |
| Zustellung beobachten | Events oder Webhooks | Antwortcodes plus Events | Nachrichtenstatus und Events |
Produkte verwenden den Begriff E-Mail-API für unterschiedliche Funktionsumfänge. Prüfen Sie das Schema des Anbieters, bevor Sie annehmen, dass eine API jede Zeile abdeckt.
Was sollte eine API-Anfrage enthalten?
Senden Sie die Felder, die Ihr Anbieter verlangt. Speichern Sie den zurückgegebenen Nachrichten-Identifier. Verwenden Sie einen eigenen Idempotency-Key, wenn ein erneuter Versuch keinen doppelten Versand erzeugen darf. Validieren Sie Empfänger vor dem Senden. Bewahren Sie Secrets auf Ihrem Server auf.
Eine beispielhafte transaktionale Anfrage enthält from, to, subject, text, category: transactional und einen serverseitig gespeicherten Idempotency-Key. Verwenden Sie eine verifizierte Absenderdomain, bevor Sie sie absenden.
Die HTTP-Antwort bedeutet, dass der Dienst die Anfrage angenommen hat. Zustellungs-, Bounce- und Beschwerde-Events treffen später ein, sodass eine Annahmeantwort keine Platzierung im Posteingang belegt.
Verwenden Sie Webhooks für spätere Events, statt eine angenommene Anfrage als Beweis zu behandeln, dass eine Nachricht den Posteingang erreicht hat. Zustellungs- und Beschwerde-Events beschreiben, was nach der Annahme passiert ist.
Wie sende ich mit Bird?
Sie rufen die createEmailMessage API von Bird mit Ihrem Workspace-API-Key, Absender, Empfängern, Inhalt und optionalen Metadaten auf. Der Leitfaden zum E-Mail-Versand zeigt die Anfrage- und Antwortfelder.
Für Antworten und eingehende E-Mails erstellen Sie ein Postfach und konsumieren dessen Nachrichten- und Zustellungs-Events. Der Postfach-Leitfaden behandelt diese Endpunkte und Webhook-Namen.
Kurzübersicht
- Eine E-Mail-API stellt Versand- und Nachrichten-Events über HTTP bereit.
- Die Antwort bestätigt die API-Annahme, nicht die Platzierung im Posteingang.
- Idempotency-Keys ermöglichen sichere Wiederholungsversuche.
- Bird bietet Sende- und Postfach-APIs mit Leitfäden für jeden Weg.