Email API

Just nu har vi ännu inte släppt några API-wrapper, men vi planerar att göra det inom en snar framtid. Skicka ett e-postmeddelande till api@forwardemail.net om du vill bli meddelad när ett API-wrapper för ett visst programmeringsspråk släpps. Under tiden kan du använda dessa rekommenderade HTTP-förfrågningsbibliotek i din applikation, eller helt enkelt använda curl som i exemplen nedan.

Den nuvarande HTTP-bas-URI-sökvägen är: https://fe.tiamati.email.

Alla slutpunkter kräver autentisering med Basic Authorization. Vi stödjer två autentiseringsmetoder:

API-tokenautentisering (Rekommenderas för de flesta slutpunkter)

Ange din API-nyckel som "användarnamn" med ett tomt lösenord:

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

Observera kolon (:) efter API-token – detta indikerar ett tomt lösenord i Basic Auth-format.

Aliasautentisering (För utgående e-post)

Slutpunkten Skapa utgående SMTP-e-post stödjer också autentisering med din alias-e-postadress och ett genererat aliaslösenord:

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"

Denna metod är användbar när du skickar e-post från applikationer som redan använder SMTP-uppgifter och gör migrering från SMTP till vårt API smidig.

Aliasendpunkter

Alias-kontakter, Alias-kalendrar, Alias-meddelanden och Alias-mappar kräver aliasuppgifter och stödjer inte API-tokenautentisering.

Oroa dig inte – exempel finns nedan om du är osäker på vad detta är.

Om några fel uppstår kommer svarskroppen från API-förfrågan att innehålla ett detaljerat felmeddelande.

Vår tjänst är översatt till över 25 olika språk. Alla API-svarsmeddelanden översätts till den senaste lokaliseringen som upptäckts för användaren som gör API-förfrågan. Du kan åsidosätta detta genom att skicka en anpassad Accept-Language-header. Testa gärna med språkvalet längst ner på denna sida.

Paginering stöds av alla API-slutpunkter som listar resultat.

Ange helt enkelt frågesträngsegenskaperna page (och valfritt limit).

Egenskapen page ska vara ett tal större än eller lika med 1. Om du anger limit (också ett tal) är minimivärdet 10 och maxvärdet 50 (om inget annat anges).

Example Request:

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

Hämta loggar

Vårt API tillåter dig programmässigt att ladda ner loggar för ditt konto. Att skicka en förfrågan till denna endpoint kommer att bearbeta alla loggar för ditt konto och skicka dem till dig som en bilaga via e-post (Gzip komprimerad CSV kalkylbladsfil) när det är klart.

Detta gör att du kan skapa bakgrundsjobb med ett Cron-jobb eller använda vår Node.js jobbschemaläggningsprogramvara Bree för att ta emot loggar när du önskar. Observera att denna endpoint är begränsad till 10 förfrågningar per dag.

Bilagan har formen med små bokstäver email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz och själva e-posten innehåller en kort sammanfattning av de hämtade loggarna. Du kan också ladda ner loggar när som helst från Mitt konto → Loggar

GET /v1/logs/download

Example Request:

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

Exempel på Cron-jobb (vid midnatt varje dag):

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

Observera att du kan använda tjänster som Crontab.guru för att validera syntaxen för ditt cron-jobb.

Exempel på Cron-jobb (vid midnatt varje dag och med loggar för föregående dag):

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 och 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

Skapa konto

POST /v1/account

Example Request:

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

Hämta konto

GET /v1/account

Example Request:

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

Uppdatera konto

PUT /v1/account

Example Request:

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

Lista kontakter

GET /v1/contacts

Kommer snart

Skapa kontakt

POST /v1/contacts

Kommer snart

Hämta kontakt

GET /v1/contacts/:id

Kommer snart

Uppdatera kontakt

PUT /v1/contacts/:id

Kommer snart

Radera kontakt

DELETE /v1/contacts/:id

Kommer snart

Lista kalendrar

GET /v1/calendars

Kommer snart

Skapa kalender

POST /v1/calendars

Kommer snart

Hämta kalender

GET /v1/calendars/:id

Kommer snart

Uppdatera kalender

PUT /v1/calendars/:id

Kommer snart

Radera kalender

DELETE /v1/calendars/:id

Kommer snart

Vänligen säkerställ att du har följt installationsinstruktionerna för din domän.

Dessa instruktioner finns i vår FAQ-sektion Stöder ni att ta emot e-post med IMAP?.

Lista och sök efter meddelanden

GET /v1/messages

Kommer snart

Skapa meddelande

POST /v1/messages

Kommer snart

Hämta meddelande

GET /v1/messages/:id

Kommer snart

Uppdatera meddelande

PUT /v1/messages/:id

Kommer snart

Radera meddelande

DELETE /v1/messages:id

Kommer snart

Lista mappar

GET /v1/folders

Kommer snart

Skapa mapp

POST /v1/folders

Kommer snart

Hämta mapp

GET /v1/folders/:id

Kommer snart

Uppdatera mapp

PUT /v1/folders/:id

Kommer snart

Radera mapp

DELETE /v1/folders/:id

Kommer snart

Kopiera mapp

POST /v1/folders/:id/copy

Kommer snart

Vänligen säkerställ att du har följt installationsinstruktionerna för din domän.

Dessa instruktioner finns på Mitt konto → Domäner → Inställningar → Utgående SMTP-konfiguration. Du behöver säkerställa att DKIM, Return-Path och DMARC är korrekt inställda för att skicka utgående SMTP med din domän.

Hämta gräns för utgående SMTP-e-post

Detta är en enkel endpoint som returnerar ett JSON-objekt innehållande count och limit för antalet dagliga utgående SMTP-meddelanden per konto.

GET /v1/emails/limit

Exempel på förfrågan:

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

Lista utgående SMTP-e-post

Observera att denna endpoint inte returnerar egenskapsvärden för ett e-postmeddelandes message, headers eller rejectedErrors.

För att returnera dessa egenskaper och deras värden, använd Hämta e-post endpoint med ett e-post-ID.

GET /v1/emails

Exempel på förfrågan:

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

Skapa utgående SMTP-e-post

Vårt API för att skapa ett e-postmeddelande är inspirerat av och använder Nodemailers konfiguration för meddelandealternativ. Vänligen hänvisa till Nodemailer message configuration för alla kroppparametrar nedan.

Observera att med undantag för envelope och dkim (eftersom vi sätter dessa automatiskt åt dig), stödjer vi alla Nodemailer-alternativ. Vi sätter automatiskt disableFileAccess och disableUrlAccess till true av säkerhetsskäl.

Du bör antingen skicka det enda alternativet raw med din råa fullständiga e-post inklusive headers eller skicka individuella kroppparameteralternativ nedan.

Denna API-endpoint kodar automatiskt emojis åt dig om de finns i headers (t.ex. en ämnesrad Subject: 🤓 Hello konverteras automatiskt till Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Vårt mål var att skapa ett extremt utvecklarvänligt och idiot-säkert e-post-API.

Autentisering: Denna endpoint stödjer både API-token autentisering och alias autentisering. Se avsnittet Autentisering ovan för detaljer.

POST /v1/emails

Exempelbegäran (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"

Exempelbegäran (Aliasuppgifter):

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"

Exempelbegäran (Rå e-post):

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

Hämta utgående SMTP-e-post

GET /v1/emails/:id

Exempelbegäran:

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

Radera utgående SMTP-e-post

Radering av e-post kommer att sätta statusen till "rejected" (och därefter inte bearbeta den i kön) om och endast om den aktuella statusen är en av "pending", "queued", eller "deferred". Vi kan automatiskt rensa e-postmeddelanden efter 30 dagar efter att de skapades och/eller skickades – därför bör du behålla en kopia av utgående SMTP-e-post i din klient, databas eller applikation. Du kan referera till vårt e-post-ID-värde i din databas om så önskas – detta värde returneras från både Skapa e-post och Hämta e-post endpoints.

DELETE /v1/emails/:id

Exempelbegäran:

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

Lista domäner

GET /v1/domains

Exempelbegäran:

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

Skapa domän

POST /v1/domains

Example Request:

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

Hämta domän

GET /v1/domains/example.com

Example Request:

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

Verifiera domänposter

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

Example Request:

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

Verifiera domänens SMTP-poster

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

Example Request:

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

Lista domänomfattande catch-all-lösenord

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

Example Request:

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

Skapa domänomfattande catch-all-lösenord

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

Example Request:

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

Ta bort domänomfattande catch-all-lösenord

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

Example Request:

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

Uppdatera domän

PUT /v1/domains/example.com

Example Request:

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

Ta bort domän

DELETE /v1/domains/:domain_name

Example Request:

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

Acceptera domäninbjudan

GET /v1/domains/:domain_name/invites

Example Request:

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

Skapa domäninbjudan

POST /v1/domains/example.com/invites

Example Request:

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

Ta bort domäninbjudan

DELETE /v1/domains/:domain_name/invites

Example Request:

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

Uppdatera domänmedlem

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

Example Request:

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

Ta bort domänmedlem

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

Example Request:

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

Generera ett alias-lösenord

Observera att om du inte skickar instruktioner via e-post, så kommer användarnamnet och lösenordet finnas i JSON-svarskroppen vid en lyckad förfrågan i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Example Request:

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

Lista domänalias

GET /v1/domains/example.com/aliases

Example Request:

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

Skapa nytt domänalias

POST /v1/domains/example.com/aliases

Exempelbegäran:

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

Hämta domänalias

Du kan hämta ett domänalias antingen via dess id eller dess name-värde.

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

Exempelbegäran:

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

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

Exempelbegäran:

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

Uppdatera domänalias

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

Exempelbegäran:

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

Ta bort domänalias

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

Exempelbegäran:

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

Vi tillåter dig att kryptera poster även på gratisplanen utan kostnad. Integritet ska inte vara en funktion, det ska vara inbyggt i alla delar av en produkt. Som starkt efterfrågat i en Privacy Guides-diskussion och på våra GitHub-ärenden har vi lagt till detta.

Kryptera TXT-post

POST /v1/encrypt

Exempelbegäran:

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