E-Mail-API

Im Moment haben wir noch keine API-Wrapper veröffentlicht, aber wir planen dies in naher Zukunft. Sende eine Email an api@forwardemail.net wenn Sie benachrichtigt werden möchten, wenn der API-Wrapper einer bestimmten Programmiersprache veröffentlicht wird. In der Zwischenzeit können Sie diese empfohlenen HTTP-Anforderungsbibliotheken in Ihrer Anwendung verwenden oder einfach verwenden kräuseln wie in den folgenden Beispielen.

Der aktuelle HTTP-Basis-URI-Pfad lautet: https://api.forwardemail.net.

Alle Endpunkte erfordern Ihre API-Schlüssel als "Benutzername"-Wert der Anfrage gesetzt werden Basisberechtigung Header (mit Ausnahme von Alias-Kontakte, Alias Kalender, und Alias-Postfächer die eine generierter Alias-Benutzername und Passwort)..

Keine Sorge – wenn Sie nicht sicher sind, was das ist, finden Sie weiter unten Beispiele.

Wenn Fehler auftreten, enthält der Antworttext der API-Anforderung eine detaillierte Fehlermeldung.

[!TIP] Wenn Sie einen 5xx-Statuscode erhalten (was nicht vorkommen sollte), kontaktieren Sie uns bitte unter api@forwardemail.net und wir werden Ihnen helfen, Ihr Problem sofort zu lösen.

Unser Service wird in über 25 verschiedene Sprachen übersetzt. Alle API-Antwortnachrichten werden in das zuletzt erkannte Gebietsschema des Benutzers übersetzt, der die API-Anforderung stellt. Sie können dies überschreiben, indem Sie einen Benutzernamen übergeben Accept-Language Header. Probieren Sie es einfach aus, indem Sie das Sprach-Dropdown unten auf dieser Seite verwenden.

[!NOTE] Ab dem 1. November 2024 sind die API-Endpunkte für Domänen auflisten und Domain-Aliase auflisten wird standardmäßig 1000 max Ergebnisse pro Seite. Wenn Sie sich frühzeitig für dieses Verhalten entscheiden möchten, können Sie ?paginate=true als zusätzlicher Abfragezeichenfolgenparameter zur URL für die Endpunktabfrage.

Die Paginierung wird von allen API-Endpunkten unterstützt, die Ergebnisse auflisten.

Geben Sie einfach die Querystring-Eigenschaften an page (und optional limit).

Das Anwesen page sollte eine Zahl größer oder gleich sein 1Wenn Sie angeben limit (ebenfalls eine Zahl), dann ist der Mindestwert 10 und das Maximum ist 50 (sofern nicht anders angegeben).

Um zu ermitteln, ob weitere Ergebnisse verfügbar sind oder nicht, stellen wir diese HTTP-Antwortheader bereit (die Sie analysieren können, um programmgesteuert eine Paginierung vorzunehmen):

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Protokolle abrufen

Mit unserer API können Sie Protokolle für Ihr Konto programmgesteuert herunterladen. Wenn Sie eine Anfrage an diesen Endpunkt senden, werden alle Protokolle für Ihr Konto verarbeitet und Ihnen als Anhang per E-Mail zugesandt (Gzip komprimiert CSV Tabellenkalkulationsdatei) nach Fertigstellung.

Dadurch können Sie Hintergrundjobs mit a erstellen Cron-Job oder mit unserem Node.js Jobplanungssoftware Bree um Protokolle zu erhalten, wann immer Sie möchten. Beachten Sie, dass dieser Endpunkt beschränkt ist auf 10 Anfragen pro Tag.

Der Anhang ist die Kleinschreibung von email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz und die E-Mail selbst enthält eine kurze Zusammenfassung der abgerufenen Protokolle. Sie können Protokolle auch jederzeit unter herunterladen Mein Konto → Protokolle

GET /v1/logs/download

Beispielanfrage:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Beispiel für einen Cron-Job (jeden Tag um Mitternacht):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Beachten Sie, dass Sie Dienste wie nutzen können Crontab.guru um die Syntax Ihres Cron-Job-Ausdrucks zu validieren.

Beispiel für einen Cron-Job (jeden Tag um Mitternacht). und mit Protokollen für den Vortag):

Für MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Für Linux und Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Konto anlegen

POST /v1/account

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Konto abrufen

GET /v1/account

Beispielanfrage:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Account aktualisieren

PUT /v1/account

Beispielanfrage:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

[!NOTE] Im Gegensatz zu anderen API-Endpunkten erfordern diese Authentifizierung „Benutzername“ entspricht dem Alias-Benutzernamen und „Passwort“ entspricht dem vom Alias generierten Passwort als Header für die grundlegende Autorisierung.

[!WARNING] Dieser Endpunktbereich befindet sich noch in der Entwicklung und wird (hoffentlich) 2024 veröffentlicht. Bitte verwenden Sie in der Zwischenzeit einen IMAP-Client aus dem Dropdown-Menü „Apps“ in der Navigation unserer Website.

[!NOTE] CardDAV-Unterstützung ist noch nicht verfügbar, folgen Sie dieser Diskussion auf GitHub für Updates.

Kontakte auflisten

GET /v1/contacts

Demnächst verfügbar

Kontakt erstellen

POST /v1/contacts

Demnächst verfügbar

Kontakt abrufen

GET /v1/contacts/:id

Demnächst verfügbar

Kontakt aktualisieren

PUT /v1/contacts/:id

Demnächst verfügbar

Kontakt löschen

DELETE /v1/contacts/:id

Demnächst verfügbar

[!NOTE] Im Gegensatz zu anderen API-Endpunkten erfordern diese Authentifizierung „Benutzername“ entspricht dem Alias-Benutzernamen und „Passwort“ entspricht dem vom Alias generierten Passwort als Header für die grundlegende Autorisierung.

[!WARNING] Dieser Endpunktbereich befindet sich noch in der Entwicklung und wird (hoffentlich) 2024 veröffentlicht. Bitte verwenden Sie in der Zwischenzeit einen IMAP-Client aus dem Dropdown-Menü „Apps“ in der Navigation unserer Website.

Kalender auflisten

GET /v1/calendars

Demnächst verfügbar

Kalender erstellen

POST /v1/calendars

Demnächst verfügbar

Kalender abrufen

GET /v1/calendars/:id

Demnächst verfügbar

Kalender aktualisieren

PUT /v1/calendars/:id

Demnächst verfügbar

Kalender löschen

DELETE /v1/calendars/:id

Demnächst verfügbar

[!NOTE] Im Gegensatz zu anderen API-Endpunkten erfordern diese Authentifizierung „Benutzername“ entspricht dem Alias-Benutzernamen und „Passwort“ entspricht dem vom Alias generierten Passwort als Header für die grundlegende Autorisierung.

[!WARNING] Dieser Endpunktbereich befindet sich noch in der Entwicklung und wird (hoffentlich) 2024 veröffentlicht. Bitte verwenden Sie in der Zwischenzeit einen IMAP-Client aus dem Dropdown-Menü „Apps“ in der Navigation unserer Website.

Bitte stellen Sie sicher, dass Sie die Einrichtungsanweisungen für Ihre Domäne befolgt haben.

Diese Anleitung finden Sie in unserem FAQ-Bereich Unterstützen Sie den E-Mail-Empfang mit IMAP?.

Auflisten und Suchen von Nachrichten

GET /v1/messages

Demnächst verfügbar

Nachricht erstellen

[!HINWEIS] Dies wird NOT eine E-Mail senden – es wird nur einfach die Nachricht zu Ihrem Postfachordner hinzufügen (z.B. dies ist ähnlich wie die IMAP APPEND Befehl). Wenn Sie eine E-Mail senden möchten, lesen Sie Ausgehende SMTP-E-Mail erstellen unten. Nachdem Sie die ausgehende SMTP-E-Mail erstellt haben, können Sie mit diesem Endpunkt eine Kopie davon zur Speicherung an das Postfach Ihres Alias anhängen.

POST /v1/messages

Demnächst verfügbar

Nachricht abrufen

GET /v1/messages/:id

Demnächst verfügbar

Update-Meldung

PUT /v1/messages/:id

Demnächst verfügbar

Nachricht löschen

DELETE /v1/messages:id

Demnächst verfügbar

[!TIP] Ordnerendpunkte mit Ordnerpfad /v1/folders/:path da ihr Endpunkt mit der ID eines Ordners austauschbar ist :id. Das bedeutet, dass Sie den Ordner entweder über seine path oder id Wert.

[!WARNING] Dieser Endpunktbereich befindet sich noch in der Entwicklung und wird (hoffentlich) 2024 veröffentlicht. Bitte verwenden Sie in der Zwischenzeit einen IMAP-Client aus dem Dropdown-Menü „Apps“ in der Navigation unserer Website.

Ordner auflisten

GET /v1/folders

Demnächst verfügbar

Ordner erstellen

POST /v1/folders

Demnächst verfügbar

Ordner abrufen

GET /v1/folders/:id

Demnächst verfügbar

Ordner aktualisieren

PUT /v1/folders/:id

Demnächst verfügbar

Ordner löschen

DELETE /v1/folders/:id

Demnächst verfügbar

Ordner kopieren

POST /v1/folders/:id/copy

Demnächst verfügbar

Bitte stellen Sie sicher, dass Sie die Einrichtungsanweisungen für Ihre Domäne befolgt haben.

Diese Anleitung finden Sie unter Mein Konto → Domänen → Einstellungen → Ausgehende SMTP-Konfiguration. Sie müssen die Einrichtung von DKIM, Return-Path und DMARC sicherstellen, um ausgehendes SMTP mit Ihrer Domain zu senden.

Limit für ausgehende SMTP-E-Mails abrufen

Dies ist ein einfacher Endpunkt, der ein JSON-Objekt zurückgibt, das Folgendes enthält: count und limit für die Anzahl täglicher ausgehender SMTP-Nachrichten pro Konto.

GET /v1/emails/limit

Beispielanfrage:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

Auflisten ausgehender SMTP-E-Mails

Beachten Sie, dass dieser Endpunkt keine Eigenschaftswerte für die message, headers, noch rejectedErrors.

Um diese Eigenschaften und ihre Werte zurückzugeben, verwenden Sie bitte die E-Mail abrufen Endpunkt mit einer E-Mail-ID.

GET /v1/emails

Beispielanfrage:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Ausgehende SMTP-E-Mail erstellen

Unsere API zum Erstellen einer E-Mail ist von der Konfiguration der Nachrichtenoptionen von Nodemailer inspiriert und nutzt diese. Bitte verweisen Sie auf die Nodemailer-Nachrichtenkonfiguration für alle Körperparameter unten.

Beachten Sie, dass mit Ausnahme von envelope und dkim (da wir diese automatisch für Sie festlegen), unterstützen wir alle Nodemailer-Optionen. Wir stellen automatisch ein disableFileAccess und disableUrlAccess Optionen zu true aus Sicherheitsgründen.

Sie sollten entweder die einzelne Option von übergeben raw mit Ihrer rohen vollständigen E-Mail einschließlich Kopfzeilen oder Übergeben Sie unten einzelne Körperparameteroptionen.

Dieser API-Endpunkt kodiert automatisch Emojis für Sie, wenn sie in den Headern gefunden werden (z. B. in einer Betreffzeile von Subject: 🤓 Hello wird umgewandelt in Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automatisch). Unser Ziel war es, eine äußerst entwicklerfreundliche und idiotensichere E-Mail-API zu erstellen.

POST /v1/emails

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Ausgehende SMTP-E-Mails abrufen

GET /v1/emails/:id

Beispielanfrage:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Ausgehende SMTP-E-Mails löschen

Durch das Löschen der E-Mail wird der Status auf gesetzt "rejected" (und anschließend nicht in der Warteschlange verarbeiten) genau dann, wenn der aktuelle Status einer von ist "pending", "queued", oder "deferred". Wir löschen E-Mails möglicherweise automatisch 30 Tage nach ihrer Erstellung und/oder dem Versand. Sie sollten daher eine Kopie der ausgehenden SMTP-E-Mails in Ihrem Client, Ihrer Datenbank oder Ihrer Anwendung aufbewahren. Bei Bedarf können Sie in Ihrer Datenbank auf unseren E-Mail-ID-Wert verweisen – dieser Wert wird von beiden zurückgegeben E-Mail erstellen und E-Mail abrufen Endpunkte.

DELETE /v1/emails/:id

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

[!TIP] Domänenendpunkte mit Domänennamen /v1/domains/:domain_name da ihr Endpunkt mit der ID einer Domäne austauschbar ist :domain_id. Das bedeutet, dass Sie entweder mit its auf die Domain verweisen können name oder id Wert.

Domänen auflisten

[!NOTE] Ab dem 1. November 2024 sind die API-Endpunkte für Domänen auflisten und Domain-Aliase auflisten wird standardmäßig 1000 max Ergebnisse pro Seite. Wenn Sie sich frühzeitig für dieses Verhalten entscheiden möchten, können Sie ?paginate=true als zusätzlicher Abfrageparameter zur URL für die Endpunktabfrage. Siehe Seitennummerierung für mehr Einblick.

GET /v1/domains

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Domäne erstellen

POST /v1/domains

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Domäne abrufen

GET /v1/domains/example.com

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Überprüfen Sie die Domäneneinträge

GET /v1/domains/example.com/verify-records

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Domäne aktualisieren

PUT /v1/domains/example.com

Beispielanfrage:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Domäne löschen

DELETE /v1/domains/:domain_name

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Domäneneinladung annehmen

GET /v1/domains/:domain_name/invites

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Domäneneinladung erstellen

POST /v1/domains/example.com/invites

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

[!WICHTIG] Wenn der eingeladene Benutzer bereits Mitglied einer anderen Domäne ist, der der einladende Administrator angehört, wird die Einladung automatisch angenommen und es wird keine E-Mail gesendet.

Domäneneinladung entfernen

DELETE /v1/domains/:domain_name/invites

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Domänenmitglied aktualisieren

PUT /v1/domains/example.com/members/:member_id

Beispielanfrage:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Domänenmitglied entfernen

DELETE /v1/domains/:domain_name/members/:member_id

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Generieren Sie ein Alias-Passwort

Beachten Sie, dass, wenn Sie keine Anweisungen per E-Mail senden, der Benutzername und das Passwort im JSON-Antworttext einer erfolgreichen Anfrage im Format { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Domain-Aliase auflisten

[!NOTE] Ab dem 1. November 2024 sind die API-Endpunkte für Domänen auflisten und Domain-Aliase auflisten wird standardmäßig 1000 max Ergebnisse pro Seite. Wenn Sie sich frühzeitig für dieses Verhalten entscheiden möchten, können Sie ?paginate=true als zusätzlicher Abfrageparameter zur URL für die Endpunktabfrage. Siehe Seitennummerierung für mehr Einblick.

GET /v1/domains/example.com/aliases

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Erstellen Sie einen neuen Domain-Alias

POST /v1/domains/example.com/aliases

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Domain-Alias abrufen

Sie können einen Domain-Alias entweder über seinen abrufen id oder seine name Wert.

GET /v1/domains/:domain_name/aliases/:alias_id

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Domain-Alias aktualisieren

PUT /v1/domains/example.com/aliases/:alias_id

Beispielanfrage:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Domain-Alias löschen

DELETE /v1/domains/:domain_name/aliases/:alias_id

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Wir ermöglichen Ihnen die Verschlüsselung von Datensätzen sogar im kostenlosen Plan ohne Kosten. Datenschutz sollte kein Feature sein, sondern inhärent in alle Aspekte eines Produkts integriert sein. Wie in einem Diskussion zu Datenschutzleitfäden und weiter unsere GitHub-Probleme wir haben dies hinzugefügt.

TXT-Eintrag verschlüsseln

POST /v1/encrypt

Beispielanfrage:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"