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. Keine Sorge – unten finden Sie Beispiele, wenn Sie sich nicht sicher sind, was das ist.

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

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.

Wenn Sie benachrichtigt werden möchten, wenn Paginierung verfügbar ist, senden Sie bitte eine E-Mail api@forwardemail.net.

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"

Bitte stellen Sie sicher, dass Sie die Einrichtungsanweisungen für Ihre Domain 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.

E-Mails auflisten

Beachten Sie, dass dieser Endpunkt keine bereits erstellten E-Mails zurückgibt message, headers, accepted, noch rejectedErrors Eigenschaften.

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

Dieser Endpunkt wird höchstens zurückkehren 50 Ergebnisse auf einmal. Wenn Sie mehrere Seiten abfragen möchten, fügen Sie an ?page=NUMBER Wo NUMBER ist eine ganze Zahl, z.B. ?page=1.

GET /v1/emails

Beispielanfrage:

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

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.

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`"

E-Mail abrufen

GET /v1/emails/:id

Beispielanfrage:

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

E-Mail 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:

Domänen auflisten

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

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:

Domain-Aliase auflisten

GET /v1/domains/example.com/aliases

Beispielanfrage:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: