E-post API

Akkurat nå har vi ikke lansert noen API-wrappere ennå, men vi planlegger å gjøre det i nær fremtid. Send en e-post til api@forwardemail.net hvis du ønsker å bli varslet når en API-wrapper for et bestemt programmeringsspråk blir lansert. I mellomtiden kan du bruke disse anbefalte HTTP-forespørselsbibliotekene i applikasjonen din, eller ganske enkelt bruke curl som i eksemplene nedenfor.

Den nåværende HTTP base URI-stien er: https://fe.tiamati.email.

Alle endepunkter krever autentisering ved bruk av Basic Authorization. Vi støtter to autentiseringsmetoder:

API Token Autentisering (Anbefalt for de fleste endepunkter)

Sett din API-nøkkel som "brukernavn"-verdi med et tomt passord:

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

Merk kolon (:) etter API-token – dette indikerer et tomt passord i Basic Auth-format.

Alias-legitimasjon Autentisering (For utgående e-post)

Endepunktet Opprett utgående SMTP e-post støtter også autentisering ved bruk av din alias e-postadresse og et generert alias-passord:

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"

Denne metoden er nyttig når du sender e-post fra applikasjoner som allerede bruker SMTP-legitimasjon og gjør migrering fra SMTP til vårt API sømløs.

Alias-Only Endepunkter

Alias Kontakter, Alias Kalendere, Alias Meldinger, og Alias Mapper endepunkter krever alias-legitimasjon og støtter ikke API token autentisering.

Ikke bekymre deg – eksempler er gitt nedenfor for deg hvis du ikke er sikker på hva dette er.

Hvis det oppstår noen feil, vil responskroppen til API-forespørselen inneholde en detaljert feilmelding.

Vår tjeneste er oversatt til over 25 forskjellige språk. Alle API-responsmeldinger oversettes til den siste lokaliteten som oppdages for brukeren som gjør API-forespørselen. Du kan overstyre dette ved å sende en egendefinert Accept-Language header. Prøv gjerne ut ved å bruke språkvelgeren nederst på denne siden.

Paginering støttes av alle API-endepunkter som lister resultater.

Oppgi enkelt querystring-egenskapene page (og eventuelt limit).

Egenskapen page skal være et tall større enn eller lik 1. Hvis du oppgir limit (også et tall), er minimumsverdien 10 og maksimum 50 (med mindre annet er angitt).

Example Request:

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

Hent logger

Vår API lar deg programmessivt laste ned logger for kontoen din. Å sende en forespørsel til dette endepunktet vil behandle alle logger for kontoen din og sende dem til deg som et vedlegg (en Gzip komprimert CSV regnearkfil) når det er fullført.

Dette lar deg opprette bakgrunnsjobber med en Cron job eller bruke vår Node.js job scheduling software Bree for å motta logger når du ønsker det. Merk at dette endepunktet er begrenset til 10 forespørsler per dag.

Vedlegget har små bokstaver og navnet email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz og e-posten inneholder en kort oppsummering av de hentede loggene. Du kan også laste ned logger når som helst fra Min konto → Logger

GET /v1/logs/download

Eksempel på forespørsel:

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

Eksempel på Cron-jobb (ved midnatt hver dag):

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

Merk at du kan bruke tjenester som Crontab.guru for å validere syntaksen i cron-jobb-uttrykket ditt.

Eksempel på Cron-jobb (ved midnatt hver dag og med logger for forrige dag):

For 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

For Linux og 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

Opprett konto

POST /v1/account

Eksempel på forespørsel:

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

Hent konto

GET /v1/account

Eksempel på forespørsel:

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

Oppdater konto

PUT /v1/account

Eksempel på forespørsel:

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

Liste kontakter

GET /v1/contacts

Kommer snart

Opprett kontakt

POST /v1/contacts

Kommer snart

Hent kontakt

GET /v1/contacts/:id

Kommer snart

Oppdater kontakt

PUT /v1/contacts/:id

Kommer snart

Slett kontakt

DELETE /v1/contacts/:id

Kommer snart

Liste kalendere

GET /v1/calendars

Kommer snart

Opprett kalender

POST /v1/calendars

Kommer snart

Hent kalender

GET /v1/calendars/:id

Kommer snart

Oppdater kalender

PUT /v1/calendars/:id

Kommer snart

Slett kalender

DELETE /v1/calendars/:id

Kommer snart

Vennligst sørg for at du har fulgt oppsettsinstruksjonene for ditt domene.

Disse instruksjonene finnes i vår FAQ-seksjon Støtter dere mottak av e-post med IMAP?.

Liste og søk etter meldinger

GET /v1/messages

Kommer snart

Opprett melding

POST /v1/messages

Kommer snart

Hent melding

GET /v1/messages/:id

Kommer snart

Oppdater melding

PUT /v1/messages/:id

Kommer snart

Slett melding

DELETE /v1/messages:id

Kommer snart

Liste mapper

GET /v1/folders

Kommer snart

Opprett mappe

POST /v1/folders

Kommer snart

Hent mappe

GET /v1/folders/:id

Kommer snart

Oppdater mappe

PUT /v1/folders/:id

Kommer snart

Slett mappe

DELETE /v1/folders/:id

Kommer snart

Kopier mappe

POST /v1/folders/:id/copy

Kommer snart

Vennligst sørg for at du har fulgt oppsettsinstruksjonene for ditt domene.

Disse instruksjonene finnes under Min konto → Domener → Innstillinger → Utgående SMTP-konfigurasjon. Du må sikre oppsett av DKIM, Return-Path og DMARC for å sende utgående SMTP med ditt domene.

Hent grense for utgående SMTP-e-post

Dette er et enkelt endepunkt som returnerer et JSON-objekt som inneholder count og limit for antall daglige utgående SMTP-meldinger per konto.

GET /v1/emails/limit

Eksempel på forespørsel:

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

List utgående SMTP-e-poster

Merk at dette endepunktet ikke returnerer egenskapsverdier for en e-posts message, headers eller rejectedErrors.

For å returnere disse egenskapene og deres verdier, vennligst bruk Hent e-post endepunktet med en e-post-ID.

GET /v1/emails

Eksempel på forespørsel:

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

Opprett utgående SMTP-e-post

Vårt API for å opprette en e-post er inspirert av og benytter Nodemailers konfigurasjon for meldingsalternativer. Vennligst se Nodemailer message configuration for alle kroppparametere nedenfor.

Merk at med unntak av envelope og dkim (siden vi setter disse automatisk for deg), støtter vi alle Nodemailer-alternativer. Vi setter automatisk disableFileAccess og disableUrlAccess til true av sikkerhetsgrunner.

Du bør enten sende det enkeltalternativet raw med din rå fullstendige e-post inkludert headere eller sende individuelle kroppparameter-alternativer nedenfor.

Dette API-endepunktet vil automatisk kode emojis for deg hvis de finnes i headerne (f.eks. en emnelinje Subject: 🤓 Hello konverteres automatisk til Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Målet vårt var å lage et ekstremt utviklervennlig og idiot-sikkert e-post-API.

Autentisering: Dette endepunktet støtter både API-token autentisering og alias-legitimasjonsautentisering. Se Autentisering seksjonen ovenfor for detaljer.

POST /v1/emails

Eksempel Forespørsel (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"

Eksempel Forespørsel (Alias-legitimasjon):

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"

Eksempel Forespørsel (Rå e-post):

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

Hent utgående SMTP-e-post

GET /v1/emails/:id

Eksempel Forespørsel:

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

Slett utgående SMTP-e-post

Sletting av e-post vil sette status til "rejected" (og deretter ikke behandle den i køen) kun hvis gjeldende status er en av "pending", "queued", eller "deferred". Vi kan automatisk slette e-poster etter 30 dager etter at de ble opprettet og/eller sendt – derfor bør du beholde en kopi av utgående SMTP-e-poster i din klient, database eller applikasjon. Du kan referere til vår e-post-ID-verdi i databasen din om ønskelig – denne verdien returneres fra både Opprett e-post og Hent e-post endepunktene.

DELETE /v1/emails/:id

Eksempel Forespørsel:

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

List domener

GET /v1/domains

Eksempel Forespørsel:

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

Opprett domene

POST /v1/domains

Eksempel Forespørsel:

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

Hent domene

GET /v1/domains/example.com

Eksempel Forespørsel:

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

Verifiser domeneposter

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

Eksempel Forespørsel:

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

Verifiser domenets SMTP-poster

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

Eksempel Forespørsel:

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

List domenebredde catch-all passord

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

Eksempel Forespørsel:

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

Opprett domenebredde catch-all passord

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

Eksempel Forespørsel:

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

Fjern domenebredde catch-all passord

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

Eksempel Forespørsel:

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

Oppdater domene

PUT /v1/domains/example.com

Eksempel Forespørsel:

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

Slett domene

DELETE /v1/domains/:domain_name

Eksempel Forespørsel:

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

Aksepter domeneinvitasjon

GET /v1/domains/:domain_name/invites

Eksempel Forespørsel:

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

Opprett domeneinvitasjon

POST /v1/domains/example.com/invites

Eksempel Forespørsel:

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

Fjern domeneinvitasjon

DELETE /v1/domains/:domain_name/invites

Eksempel Forespørsel:

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

Oppdater domenemedlem

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

Eksempel Forespørsel:

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

Fjern domenemedlem

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

Eksempel Forespørsel:

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

Generer et alias-passord

Merk at hvis du ikke sender instruksjoner på e-post, vil brukernavn og passord være i JSON-responsen av en vellykket forespørsel i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Eksempel Forespørsel:

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

Liste over domenaliaser

GET /v1/domains/example.com/aliases

Eksempel Forespørsel:

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

Opprett nytt domenalias

POST /v1/domains/example.com/aliases

Example Request:

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

Hent domenenavn alias

Du kan hente et domenenavn alias enten ved dets id eller dets name verdi.

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

Example Request:

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

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

Example Request:

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

Oppdater domenenavn alias

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

Eksempel Forespørsel:

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

Slett domenenavn-alias

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

Eksempel Forespørsel:

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

Vi lar deg kryptere poster selv på gratisplanen uten kostnad. Personvern skal ikke være en funksjon, det skal være innebygd i alle aspekter av et produkt. Som sterkt etterspurt i en Privacy Guides diskusjon og på våre GitHub issues har vi lagt til dette.

Krypter TXT-post

POST /v1/encrypt

Eksempel Forespørsel:

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