Email-API

Derzeit haben wir noch keine API-Wrapper veröffentlicht, planen dies aber in naher Zukunft zu tun. 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 diese empfohlenen HTTP-Anfragebibliotheken in Ihrer Anwendung verwenden oder einfach curl wie in den folgenden Beispielen nutzen.

Der aktuelle HTTP-Basis-URI-Pfad ist: https://fe.tiamati.email.

Alle Endpunkte erfordern eine Authentifizierung mittels Basic Authorization. Wir unterstützen zwei Authentifizierungsmethoden:

API-Token-Authentifizierung (Empfohlen für die meisten Endpunkte)

Setzen Sie Ihren API-Schlüssel als "Benutzername" mit einem leeren Passwort:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Beachten Sie den Doppelpunkt (:) nach dem API-Token – dieser zeigt ein leeres Passwort im Basic-Auth-Format an.

Alias-Anmeldeinformationen Authentifizierung (Für ausgehende E-Mails)

Der Endpunkt Create outbound SMTP email unterstützt auch die Authentifizierung mit Ihrer Alias-E-Mail-Adresse und einem generierten Alias-Passwort:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Diese Methode ist nützlich, wenn E-Mails von Anwendungen gesendet werden, die bereits SMTP-Anmeldeinformationen verwenden, und macht die Migration von SMTP zu unserer API nahtlos.

Nur Alias-Endpunkte

Die Endpunkte Alias Contacts, Alias Calendars, Alias Messages und Alias Folders erfordern Alias-Anmeldeinformationen und unterstützen keine API-Token-Authentifizierung.

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

Wenn Fehler auftreten, enthält der Antwortkörper der API-Anfrage eine detaillierte Fehlermeldung.

Unser Dienst ist in über 25 verschiedene Sprachen übersetzt. Alle API-Antwortnachrichten werden in die zuletzt erkannte Sprache des Benutzers übersetzt, der die API-Anfrage stellt. Sie können dies überschreiben, indem Sie einen benutzerdefinierten Accept-Language-Header übergeben. Probieren Sie es gerne mit dem Sprach-Dropdown unten auf dieser Seite aus.

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

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

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

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Protokolle abrufen

Unsere API ermöglicht es Ihnen programmatisch, Protokolle für Ihr Konto herunterzuladen. Eine Anfrage an diesen Endpunkt verarbeitet alle Protokolle für Ihr Konto und sendet sie Ihnen als Anhang (eine Gzip-komprimierte CSV-Tabellendatei) per E-Mail, sobald der Vorgang abgeschlossen ist.

Dies ermöglicht es Ihnen, Hintergrundaufgaben mit einem Cron-Job oder mit unserer Node.js-Jobplanungssoftware Bree zu erstellen, um Protokolle jederzeit zu erhalten. Beachten Sie, dass dieser Endpunkt auf 10 Anfragen pro Tag begrenzt ist.

Der Anhang trägt den Kleinbuchstaben-Form 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 Mein Konto → Protokolle herunterladen.

GET /v1/logs/download

Beispielanfrage:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Beispiel Cron-Job (täglich um Mitternacht):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

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

Beispiel Cron-Job (täglich um Mitternacht und mit Protokollen des Vortages):

Für MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Konto abrufen

GET /v1/account

Beispielanfrage:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Konto aktualisieren

PUT /v1/account

Beispielanfrage:

curl -X PUT https://fe.tiamati.email/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 Einrichtungshinweise für Ihre Domain befolgt haben.

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

Nachrichten auflisten und durchsuchen

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

Nachricht aktualisieren

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

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 Einrichtungshinweise für Ihre Domain befolgt haben.

Diese Anweisungen finden Sie unter Mein Konto → Domains → Einstellungen → Ausgehende SMTP-Konfiguration. Sie müssen die Einrichtung von DKIM, Return-Path und DMARC für das Senden von ausgehenden SMTP-E-Mails mit Ihrer Domain sicherstellen.

Abrufen des Limits für ausgehende SMTP-E-Mails

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

GET /v1/emails/limit

Beispielanfrage:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

Auflisten ausgehender SMTP-E-Mails

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

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

GET /v1/emails

Beispielanfrage:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Erstellen einer ausgehenden SMTP-E-Mail

Unsere API zum Erstellen einer E-Mail ist inspiriert von und nutzt die Nachrichtenoptionen-Konfiguration von Nodemailer. Bitte beachten Sie die Nodemailer Nachrichtenkonfiguration für alle untenstehenden Body-Parameter.

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

Sie sollten entweder die einzelne Option raw mit Ihrer rohen vollständigen E-Mail inklusive Header übergeben oder die einzelnen Body-Parameter-Optionen unten angeben.

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

Authentifizierung: Dieser Endpunkt unterstützt sowohl die API-Token-Authentifizierung als auch die Alias-Anmeldeinformationen-Authentifizierung. Details finden Sie im Abschnitt Authentifizierung oben.

POST /v1/emails

Beispielanfrage (API-Token):

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

Beispielanfrage (Alias-Zugangsdaten):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Beispielanfrage (Roh-E-Mail):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Abrufen ausgehender SMTP-E-Mails

GET /v1/emails/:id

Beispielanfrage:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Löschen ausgehender SMTP-E-Mails

Das Löschen einer E-Mail setzt den Status auf "rejected" (und verarbeitet sie anschließend nicht mehr in der Warteschlange), wenn und nur wenn der aktuelle Status einer der folgenden ist: "pending", "queued" oder "deferred". Wir können E-Mails automatisch 30 Tage nach ihrer Erstellung und/oder dem Versand löschen – daher sollten Sie eine Kopie ausgehender SMTP-E-Mails in Ihrem Client, Ihrer Datenbank oder Anwendung aufbewahren. Sie können unseren E-Mail-ID-Wert in Ihrer Datenbank referenzieren, falls gewünscht – 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://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Domains auflisten

GET /v1/domains

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Domain erstellen

POST /v1/domains

Beispielanfrage:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Domain abrufen

GET /v1/domains/example.com

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Domain-Datensätze überprüfen

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

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Domain SMTP-Datensätze überprüfen

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

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Domainweite Catch-All-Passwörter auflisten

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

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Domainweites 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:

Domainweites Catch-All-Passwort entfernen

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

Beispielanfrage:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Domain aktualisieren

PUT /v1/domains/example.com

Beispielanfrage:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Domain löschen

DELETE /v1/domains/:domain_name

Beispielanfrage:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

Domain-Einladung annehmen

GET /v1/domains/:domain_name/invites

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Domain-Einladung erstellen

POST /v1/domains/example.com/invites

Beispielanfrage:

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

Domain-Einladung entfernen

DELETE /v1/domains/:domain_name/invites

Beispielanfrage:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Domain-Mitglied aktualisieren

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

Beispielanfrage:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Domain-Mitglied entfernen

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

Beispielanfrage:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Alias-Passwort generieren

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

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

Beispielanfrage:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Domain-Aliase auflisten

GET /v1/domains/example.com/aliases

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Neuen Domain-Alias erstellen

POST /v1/domains/example.com/aliases

Beispielanfrage:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Domain-Alias abrufen

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

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

Beispielanfrage:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Beispielanfrage:

curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Wir erlauben es Ihnen, Datensätze auch im kostenlosen Tarif ohne Kosten zu verschlüsseln. Datenschutz sollte kein Feature sein, sondern von Natur aus in allen Aspekten eines Produkts eingebaut sein. Wie in einer viel diskutierten Privacy Guides Diskussion und auf unseren GitHub-Issues stark gewünscht, haben wir dies hinzugefügt.

TXT-Datensatz verschlüsseln

POST /v1/encrypt

Beispielanfrage:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"