E-Mail-API

Derzeit haben wir noch keine API-Wrapper veröffentlicht, planen dies aber in naher Zukunft. Senden Sie eine E-Mail an api@forwardemail.net, wenn Sie benachrichtigt werden möchten, sobald ein API-Wrapper für eine bestimmte Programmiersprache veröffentlicht wird. In der Zwischenzeit können Sie die empfohlenen HTTP-Anforderungsbibliotheken in Ihrer Anwendung verwenden oder einfach Locke wie in den folgenden Beispielen verwenden.

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

Für alle Endpunkte muss Ihr API-Schlüssel als „Benutzername“-Wert des Basisautorisierung-Headers der Anfrage festgelegt werden (mit Ausnahme von Alias-Kontakte, Alias-Kalender und Alias-Postfächer, die einen generierter Alias-Benutzername und Passwort verwenden).

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

Wenn Fehler auftreten, enthält der Antworttext der API-Anfrage eine ausführliche Fehlermeldung.

Unser Service ist in über 25 verschiedene Sprachen übersetzt. Alle API-Antworten werden in die zuletzt erkannte Sprache des Benutzers übersetzt, der die API-Anfrage gestellt hat. Sie können dies überschreiben, indem Sie einen benutzerdefinierten Accept-Language-Header übergeben. Probieren Sie es einfach über das Sprach-Dropdown-Menü unten auf dieser Seite aus.

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

Geben Sie einfach die Abfragezeichenfolgeneigenschaften page (und optional limit) an.

Die Eigenschaft page sollte eine Zahl größer oder gleich 1 sein. Wenn Sie limit (ebenfalls eine Zahl) angeben, ist der Mindestwert 10 und der Höchstwert 50 (sofern nicht anders angegeben).

Um festzustellen, ob weitere Ergebnisse verfügbar sind, stellen wir diese HTTP-Antwortheader bereit (die Sie analysieren können, um sie programmgesteuert zu paginieren):

Beispielanfrage:

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

Protokolle abrufen

Unsere API ermöglicht Ihnen den programmgesteuerten Download von Protokollen für Ihr Konto. Wenn Sie eine Anfrage an diesen Endpunkt senden, werden alle Protokolle für Ihr Konto verarbeitet und Ihnen nach Abschluss per E-Mail als Anhang (Gzip komprimierte CSV Tabellenkalkulationsdatei) zugesandt.

Dies ermöglicht Ihnen, Hintergrundjobs mit einem Cron-Job zu erstellen oder unseren Node.js-Jobplanungssoftware Bree zu verwenden, um Protokolle jederzeit zu erhalten. Beachten Sie, dass dieser Endpunkt auf 10 Anfragen pro Tag beschränkt ist.

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

GET /v1/logs/download

Beispielanfrage:

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

Beispiel für einen Cron-Job (täglich 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 Crontab.guru verwenden können, um die Ausdruckssyntax Ihres Cron-Jobs zu validieren.

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

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 erstellen

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:

Konto aktualisieren

PUT /v1/account

Beispielanfrage:

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

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

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

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

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

Nachrichten auflisten und suchen

GET /v1/messages

Demnächst verfügbar

Nachricht erstellen

POST /v1/messages

Demnächst verfügbar

Nachricht abrufen

GET /v1/messages/:id

Demnächst verfügbar

Update-Nachricht

PUT /v1/messages/:id

Demnächst verfügbar

Nachricht löschen

DELETE /v1/messages:id

Demnächst verfügbar

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

Update-Ordner

PUT /v1/folders/:id

Demnächst verfügbar

Ordner {#delete-folder} 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 Anweisungen finden Sie unter Mein Konto → Domänen → Einstellungen → Outbound SMTP-Konfiguration. Sie müssen die Einrichtung von DKIM, Return-Path und DMARC für das Senden ausgehender SMTP-Nachrichten mit Ihrer Domäne sicherstellen.

Erhalten Sie das Limit für ausgehende SMTP-E-Mails

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

GET /v1/emails/limit

Beispielanfrage:

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

Liste ausgehender SMTP-E-Mails

Beachten Sie, dass dieser Endpunkt keine Eigenschaftswerte für message, headers oder rejectedErrors einer E-Mail zurückgibt.

Um diese Eigenschaften und ihre Werte zurückzugeben, verwenden Sie bitte den Endpunkt E-Mail abrufen 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 Nachrichtenoptionenkonfiguration von Nodemailer inspiriert und nutzt diese. Bitte verwenden Sie den Nodemailer-Nachrichtenkonfiguration für alle unten aufgeführten Textparameter.

Beachten Sie, dass wir mit Ausnahme von envelope und dkim (da wir diese automatisch für Sie festlegen) alle Nodemailer-Optionen unterstützen. Aus Sicherheitsgründen setzen wir die Optionen disableFileAccess und disableUrlAccess automatisch auf true.

Sie sollten entweder die einzelne Option raw mit Ihrer vollständigen E-Mail einschließlich der Kopfzeilen übergeben oder unten einzelne Textparameteroptionen übergeben.

Dieser API-Endpunkt kodiert automatisch Emojis für Sie, wenn diese in den Headern gefunden werden (z. B. wird eine Betreffzeile von Subject: 🤓 Hello automatisch in Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello umgewandelt). Unser Ziel war es, eine extrem 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-Mail abrufen

GET /v1/emails/:id

Beispielanfrage:

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

Ausgehende SMTP-E-Mails löschen

Das Löschen einer E-Mail setzt den Status auf "rejected" (und verarbeitet sie anschließend nicht in der Warteschlange), wenn der aktuelle Status "pending", "queued" oder "deferred" ist. Wir löschen E-Mails möglicherweise automatisch 30 Tage nach ihrer Erstellung und/oder ihrem Versand. Bewahren Sie daher eine Kopie ausgehender SMTP-E-Mails in Ihrem Client, Ihrer Datenbank oder Ihrer Anwendung auf. Sie können bei Bedarf auf unsere E-Mail-ID in Ihrer Datenbank verweisen – dieser Wert wird sowohl von den Endpunkten E-Mail erstellen als auch E-Mail abrufen zurückgegeben.

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:

Domäneneinträge überprüfen

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

Beispielanfrage:

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

SMTP-Einträge der Domäne überprüfen

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

Beispielanfrage:

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

Domänenweite Catch-All-Passwörter auflisten

GET /v1/domains/example.com/catch-all-passwords

Beispielanfrage:

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

Domänenweites Catch-All-Passwort erstellen

POST /v1/domains/example.com/catch-all-passwords

Beispielanfrage:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Domänenweites Catch-All-Passwort entfernen

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Beispielanfrage:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -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:

Generieren Sie ein Alias-Passwort

Beachten Sie: Wenn Sie keine Anweisungen per E-Mail senden, werden Benutzername und Kennwort im JSON-Antworttext einer erfolgreichen Anfrage im Format { username: 'alias@yourdomain.com', password: 'some-generated-password' } angezeigt.

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:

Domänen-Aliase auflisten

GET /v1/domains/example.com/aliases

Beispielanfrage:

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

Neuen Domänenalias erstellen

POST /v1/domains/example.com/aliases

Beispielanfrage:

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

Domänenalias abrufen

Sie können einen Domänenalias entweder über seinen Wert id oder seinen Wert name abrufen.

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:

Domänenalias 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:

Domänenalias 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 kostenlose Verschlüsselung von Datensätzen auch im kostenlosen Tarif. Datenschutz sollte kein Feature sein, sondern in alle Aspekte eines Produkts integriert sein. Wie bereits in Diskussion zu Datenschutzleitfäden und unsere GitHub-Probleme häufig gewünscht, haben wir 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"