- Suchseite
- Inhaltsverzeichnis
E-Mail-API
Bibliotheken
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.
Sprache | Bibliothek |
---|---|
Rubin | Faraday |
Python | Anfragen |
Java | OkHttp |
PHP | fressen |
JavaScript | Superagent (wir sind Betreuer) |
Node.js | Superagent (wir sind Betreuer) |
gehen | net/http |
.NET | RestSharp |
Basis-URIs
Der aktuelle HTTP-Basis-URI-Pfad lautet: https://api.forwardemail.net
.
Authentifizierung
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.
Fehler
Wenn Fehler auftreten, enthält der Antworttext der API-Anforderung eine detaillierte Fehlermeldung.
Code | Name |
---|---|
200 | OK |
400 | Ungültige Anforderung |
401 | Unbefugt |
403 | Verboten |
404 | Nicht gefunden |
429 | Zu viele Anfragen |
500 | interner Serverfehler |
501 | Nicht implementiert |
502 | Schlechtes Tor |
503 | Dienst nicht verfügbar |
504 | Gateway-Timeout |
Lokalisierung
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.
Seitennummerierung
Wenn Sie benachrichtigt werden möchten, wenn Paginierung verfügbar ist, senden Sie bitte eine E-Mail api@forwardemail.net.
Konto
Konto anlegen
POST /v1/account
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
email | Ja | Zeichenfolge (E-Mail) | E-Mail-Addresse |
password | Ja | Schnur | Passwort |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
email | Nein | Zeichenfolge (E-Mail) | E-Mail-Addresse |
given_name | Nein | Schnur | Vorname |
family_name | Nein | Schnur | Nachname |
avatar_url | Nein | Zeichenfolge (URL) | Link zum Avatarbild |
Beispielanfrage:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
E-Mails
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
Querystring-Parameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
q | Nein | Zeichenfolge (RegExp unterstützt) | Suchen Sie nach E-Mails anhand von Metadaten |
domain | Nein | Zeichenfolge (RegExp unterstützt) | Suchen Sie nach E-Mails anhand des Domainnamens |
page | Nein | Nummer | Seite zur Rückgabe der Ergebnisse (Standard ist 1 ) |
`Grenze | Nein | Nummer | Anzahl der Ergebnisse pro Seite, die zurückgegeben werden sollen (Standard ist 50 – das Maximum ist 50 und Minimum ist 10 ) |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
from | Nein | Zeichenfolge (E-Mail) | Die E-Mail-Adresse des Absenders (muss als Alias der Domain vorhanden sein). |
to | Nein | String oder Array | Durch Kommas getrennte Liste oder ein Array von Empfängern für den „An“-Header. |
cc | Nein | String oder Array | Durch Kommas getrennte Liste oder ein Array von Empfängern für den „Cc“-Header. |
bcc | Nein | String oder Array | Durch Kommas getrennte Liste oder ein Array von Empfängern für den „Bcc“-Header. |
subject | Nein | Schnur | Der Betreff der E-Mail. |
text | Nein | String oder Puffer | Die Klartextversion der Nachricht. |
html | Nein | String oder Puffer | Die HTML-Version der Nachricht. |
attachments | Nein | Array | Ein Array von Anhangsobjekten (siehe Gemeinsame Felder von Nodemailer). |
sender | Nein | Schnur | Die E-Mail-Adresse für den „Sender“-Header (siehe Die erweiterten Felder von Nodemailer). |
replyTo | Nein | Schnur | Die E-Mail-Adresse für den „Reply-To“-Header. |
inReplyTo | Nein | Schnur | Die Nachrichten-ID, auf die die Nachricht antwortet. |
references | Nein | String oder Array | Durch Leerzeichen getrennte Liste oder ein Array von Nachrichten-IDs. |
attachDataUrls | Nein | Boolesch | Wenn true dann konvertiert data: Bilder im HTML-Inhalt der Nachricht in eingebettete Anhänge. |
watchHtml | Nein | Schnur | Eine Apple Watch-spezifische HTML-Version der Nachricht (gemäß den Nodemailer-Dokumenten, die neuesten Uhren erfordern keine Einstellung). |
amp | Nein | Schnur | Eine AMP4EMAIL-spezifische HTML-Version der Nachricht (siehe Beispiel von Nodemailer). |
icalEvent | Nein | Objekt | Ein iCalendar-Ereignis zur Verwendung als alternativer Nachrichteninhalt (siehe Kalenderereignisse des Nodemailers). |
alternatives | Nein | Array | Ein Array alternativer Nachrichteninhalte (siehe Alternative Inhalte von Nodemailer). |
encoding | Nein | Schnur | Kodierung für den Text und die HTML-Strings (standardmäßig "utf-8" , unterstützt aber "hex" und "base64" auch Codierungswerte). |
raw | Nein | String oder Puffer | Eine benutzerdefinierte generierte Nachricht im RFC822-Format zur Verwendung (anstelle einer Nachricht, die von Nodemailer generiert wird – siehe Benutzerdefinierte Quelle von Nodemailer). |
textEncoding | Nein | Schnur | Kodierung, die für Textwerte zwingend verwendet werden muss (entweder "quoted-printable" oder "base64" ). Der Standardwert ist der nächstgelegene erkannte Wert (für ASCII-Verwendung). "quoted-printable" ). |
priority | Nein | Schnur | Prioritätsstufe für die E-Mail (kann entweder sein "high" , "normal" (Standard) oder "low" ). Beachten Sie, dass ein Wert von "normal" legt keinen Prioritätsheader fest (dies ist das Standardverhalten). Wenn ein Wert von "high" oder "low" gesetzt ist, dann die X-Priority , X-MSMail-Priority , und Importance Kopfzeilen wird entsprechend eingestellt. |
headers | Nein | Objekt oder Array | Ein Objekt oder ein Array zusätzlicher Headerfelder, die festgelegt werden sollen (siehe Benutzerdefinierte Header des Nodemailers). |
messageId | Nein | Schnur | Ein optionaler Message-ID-Wert für den „Message-ID“-Header (ein Standardwert wird automatisch erstellt, wenn er nicht festgelegt wird – beachten Sie, dass der Wert sollte Halten Sie sich an die RFC2822-Spezifikation). |
date | Nein | Zeichenfolge oder Datum | Ein optionaler Datumswert, der verwendet wird, wenn der Datumsheader nach dem Parsen fehlt. Andernfalls wird die aktuelle UTC-Zeichenfolge verwendet, wenn sie nicht festgelegt ist. Die Datumsüberschrift darf nicht mehr als 30 Tage vor der aktuellen Uhrzeit liegen. |
list | Nein | Objekt | Ein optionales Objekt von List-* Überschriften (siehe Listenkopfzeilen des Nodemailers). |
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
/v1/domains/:domain_name
da ihr Pfad mit der ID einer Domain austauschbar ist :domain_id
. Das bedeutet, dass Sie entweder mit its auf die Domain verweisen können name
oder id
Wert.
Domänen auflisten
GET /v1/domains
Querystring-Parameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
q | Nein | Zeichenfolge (RegExp unterstützt) | Suche nach Domains nach Namen |
name | Nein | Zeichenfolge (RegExp unterstützt) | Suche nach Domains nach Namen |
Beispielanfrage:
curl https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Domäne erstellen
POST /v1/domains
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
domain | Ja | Zeichenfolge (FQDN oder IP) | Vollqualifizierter Domänenname ("FQDN") oder IP-Adresse |
plan | Nein | Zeichenfolge (aufzählbar) | Plantyp (muss "free" , "enhanced_protection" , oder "team" , standardmäßig auf "free" oder der aktuelle bezahlte Plan des Benutzers, falls vorhanden) |
catchall | Nein | String (getrennte E-Mail-Adressen) oder Boolean | Erstellen Sie einen Standard-Catch-All-Alias, standardmäßig zu true (wenn true Es verwendet die E-Mail-Adresse des API-Benutzers als Empfänger, und wenn false es wird kein Auffangbehälter erstellt). Wenn ein String übergeben wird, handelt es sich um eine begrenzte Liste von E-Mail-Adressen, die als Empfänger verwendet werden sollen (getrennt durch Zeilenumbruch, Leerzeichen und/oder Komma). |
has_adult_content_protection | Nein | Boolesch | Ob der Spam-Scanner-Inhaltsschutz für Erwachsene auf dieser Domain aktiviert werden soll |
has_phishing_protection | Nein | Boolesch | Ob der Phishing-Schutz des Spam-Scanners für diese Domäne aktiviert werden soll |
has_executable_protection | Nein | Boolesch | Ob der ausführbare Spam-Scanner-Schutz für diese Domäne aktiviert werden soll |
has_virus_protection | Nein | Boolesch | Ob der Spam Scanner-Virenschutz für diese Domäne aktiviert werden soll |
has_recipient_verification | Nein | Boolesch | Globaler Domänenstandard, ob Alias-Empfänger aufgefordert werden sollen, auf einen E-Mail-Bestätigungslink zu klicken, damit E-Mails weitergeleitet werden |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
smtp_port | Nein | Zeichenfolge oder Zahl | Benutzerdefinierter Port zum Konfigurieren für die SMTP-Weiterleitung (Standard ist "25" ) |
has_adult_content_protection | Nein | Boolesch | Ob der Spam-Scanner-Inhaltsschutz für Erwachsene auf dieser Domain aktiviert werden soll |
has_phishing_protection | Nein | Boolesch | Ob der Phishing-Schutz des Spam-Scanners für diese Domäne aktiviert werden soll |
has_executable_protection | Nein | Boolesch | Ob der ausführbare Spam-Scanner-Schutz für diese Domäne aktiviert werden soll |
has_virus_protection | Nein | Boolesch | Ob der Spam Scanner-Virenschutz für diese Domäne aktiviert werden soll |
has_recipient_verification | Nein | Boolesch | Globaler Domänenstandard, ob Alias-Empfänger aufgefordert werden sollen, auf einen E-Mail-Bestätigungslink zu klicken, damit E-Mails weitergeleitet werden |
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:
Lädt ein
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
email | Ja | Zeichenfolge (E-Mail) | E-Mail-Adresse, die zur Liste der Domänenmitglieder eingeladen werden soll |
group | Ja | Zeichenfolge (aufzählbar) | Gruppe, mit der der Benutzer zur Domänenmitgliedschaft hinzugefügt werden soll (kann eine von sein "admin" oder "user" ) |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
email | Ja | Zeichenfolge (E-Mail) | E-Mail-Adresse, die aus der Liste der Domänenmitglieder entfernt werden soll |
Beispielanfrage:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Mitglieder
Domänenmitglied aktualisieren
PUT /v1/domains/example.com/members/:member_id
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
group | Ja | Zeichenfolge (aufzählbar) | Gruppe, mit der der Benutzer auf die Domänenmitgliedschaft aktualisiert werden soll (kann eine von sein "admin" oder "user" ) |
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:
Aliase
Domain-Aliase auflisten
GET /v1/domains/example.com/aliases
Querystring-Parameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
q | Nein | Zeichenfolge (RegExp unterstützt) | Suchen Sie in einer Domain anhand des Namens, Labels oder Empfängers nach Aliassen |
name | Nein | Zeichenfolge (RegExp unterstützt) | Suchen Sie nach Aliasnamen in einer Domain anhand des Namens |
recipient | Nein | Zeichenfolge (RegExp unterstützt) | Suche nach Aliasen in einer Domäne nach Empfänger |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
name | Nein | Schnur | Aliasname (wenn nicht angegeben oder leer, wird ein zufälliger Alias generiert) |
recipients | Nein | String oder Array | Liste der Empfänger (muss eine durch Zeilenumbruch/Leerzeichen/Komma getrennte Zeichenfolge oder ein Array gültiger E-Mail-Adressen, vollständig qualifizierter Domänennamen („FQDN“), IP-Adressen und/oder Webhook-URLs sein – und falls nicht angegeben oder leer Array, dann wird die E-Mail des Benutzers, der die API-Anfrage stellt, als Empfänger festgelegt.) |
description | Nein | Schnur | Alias-Beschreibung |
labels | Nein | String oder Array | Liste der Labels (muss ein durch Zeilenumbruch/Leerzeichen/Komma getrennter String oder Array sein) |
has_recipient_verification | Nein | Boolesch | Ob aktiviert werden soll, dass Empfänger auf einen E-Mail-Bestätigungslink klicken müssen, damit E-Mails durchgelassen werden (standardmäßig die Einstellung der Domäne, wenn nicht explizit im Anfragetext festgelegt) |
is_enabled | Nein | Boolesch | Ob dieser Alias aktiviert oder deaktiviert werden soll (wenn deaktiviert, werden E-Mails nirgendwo hingeleitet, geben aber erfolgreiche Statuscodes zurück). Standardmäßig auf true , aber wenn ein Wert übergeben wird, wird er mit in einen booleschen Wert konvertiert boolesch) |
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
Körperparameter | Erforderlich | Typ | Beschreibung |
---|---|---|---|
name | Nein | Schnur | Pseudonym |
recipients | Ja | String oder Array | Liste der Empfänger (muss eine durch Zeilenumbruch/Leerzeichen/Komma getrennte Zeichenfolge oder ein Array gültiger E-Mail-Adressen, vollständig qualifizierter Domänennamen („FQDN“), IP-Adressen und/oder Webhook-URLs sein) |
description | Nein | Schnur | Alias-Beschreibung |
labels | Nein | String oder Array | Liste der Labels (muss ein durch Zeilenumbruch/Leerzeichen/Komma getrennter String oder Array sein) |
has_recipient_verification | Nein | Boolesch | Ob aktiviert werden soll, dass Empfänger auf einen E-Mail-Bestätigungslink klicken müssen, damit E-Mails durchgelassen werden (standardmäßig die Einstellung der Domäne, wenn nicht explizit im Anfragetext festgelegt) |
is_enabled | Nein | Boolesch | Ob dieser Alias aktiviert oder deaktiviert werden soll (wenn deaktiviert, werden E-Mails nirgendwo hingeleitet, geben aber erfolgreiche Statuscodes zurück) |
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: