Email API

Lige nu har vi endnu ikke udgivet nogen API wrappers, men vi planlægger at gøre det i den nærmeste fremtid. Send en email til api@forwardemail.net hvis du gerne vil have besked, når en API wrapper til et bestemt programmeringssprog bliver udgivet. I mellemtiden kan du bruge disse anbefalede HTTP request biblioteker i din applikation, eller blot bruge curl som i eksemplerne nedenfor.

Den nuværende HTTP base URI sti er: https://fe.tiamati.email.

Alle endpoints kræver autentificering ved brug af Basic Authorization. Vi understøtter to autentificeringsmetoder:

API Token Authentication (Anbefales til de fleste endpoints)

Indstil din API-nøgle som "brugernavn" værdien med et tomt kodeord:

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

Bemærk kolon (:) efter API-token – dette angiver et tomt kodeord i Basic Auth format.

Alias Credentials Authentication (Til udgående email)

Create outbound SMTP email endpoint understøtter også autentificering ved brug af din alias emailadresse og et genereret alias kodeord:

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 metode er nyttig, når du sender emails fra applikationer, der allerede bruger SMTP legitimationsoplysninger, og gør migrering fra SMTP til vores API problemfri.

Alias-Only Endpoints

Alias Contacts, Alias Calendars, Alias Messages, og Alias Folders endpoints kræver alias legitimationsoplysninger og understøtter ikke API token autentificering.

Bare rolig – eksempler er givet nedenfor, hvis du er usikker på, hvad dette er.

Hvis der opstår fejl, vil svarindholdet fra API-forespørgslen indeholde en detaljeret fejlmeddelelse.

Vores service er oversat til over 25 forskellige sprog. Alle API svarbeskeder oversættes til den sidst registrerede lokalitet for brugeren, der laver API-forespørgslen. Du kan tilsidesætte dette ved at sende en brugerdefineret Accept-Language header. Du er velkommen til at prøve det ved at bruge sprog-dropdown-menuen nederst på denne side.

Pagination understøttes af alle API endpoints, der returnerer lister.

Angiv blot querystring egenskaberne page (og eventuelt limit).

Egenskaben page skal være et tal større end eller lig med 1. Hvis du angiver limit (også et tal), er minimumsværdien 10 og maksimum 50 (medmindre andet er angivet).

Eksempel på forespørgsel:

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

Hent logs

Vores API giver dig programmatisk mulighed for at downloade logs for din konto. Ved at sende en forespørgsel til dette endpoint vil alle logs for din konto blive behandlet og sendt til dig som en vedhæftet fil (en Gzip komprimeret CSV regnearksfil), når processen er færdig.

Dette giver dig mulighed for at oprette baggrundsopgaver med en Cron job eller ved at bruge vores Node.js job scheduling software Bree for at modtage logs, når du ønsker det. Bemærk, at dette endpoint er begrænset til 10 forespørgsler pr. dag.

Vedhæftningen har det småbogstavede format email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, og selve e-mailen indeholder et kort resumé af de hentede logs. Du kan også downloade logs når som helst fra Min Konto → Logs

GET /v1/logs/download

Eksempel på forespørgsel:

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

Eksempel på Cron job (ved midnat hver dag):

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

Bemærk, at du kan bruge tjenester som Crontab.guru til at validere din cron job-udtrykssyntaks.

Eksempel på Cron job (ved midnat hver dag og med logs for foregående 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

Opret konto

POST /v1/account

Eksempel på forespørgsel:

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ørgsel:

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

Opdater konto

PUT /v1/account

Eksempel på forespørgsel:

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

Liste kontakter

GET /v1/contacts

Kommer snart

Opret kontakt

POST /v1/contacts

Kommer snart

Hent kontakt

GET /v1/contacts/:id

Kommer snart

Opdater kontakt

PUT /v1/contacts/:id

Kommer snart

Slet kontakt

DELETE /v1/contacts/:id

Kommer snart

Liste kalendere

GET /v1/calendars

Kommer snart

Opret kalender

POST /v1/calendars

Kommer snart

Hent kalender

GET /v1/calendars/:id

Kommer snart

Opdater kalender

PUT /v1/calendars/:id

Kommer snart

Slet kalender

DELETE /v1/calendars/:id

Kommer snart

Sørg for, at du har fulgt opsætningsinstruktionerne for dit domæne.

Disse instruktioner kan findes i vores FAQ-sektion Understøtter I modtagelse af email med IMAP?.

Liste og søg efter beskeder

GET /v1/messages

Kommer snart

Opret besked

POST /v1/messages

Kommer snart

Hent besked

GET /v1/messages/:id

Kommer snart

Opdater besked

PUT /v1/messages/:id

Kommer snart

Slet besked

DELETE /v1/messages:id

Kommer snart

Liste mapper

GET /v1/folders

Kommer snart

Opret mappe

POST /v1/folders

Kommer snart

Hent mappe

GET /v1/folders/:id

Kommer snart

Opdater mappe

PUT /v1/folders/:id

Kommer snart

Slet mappe

DELETE /v1/folders/:id

Kommer snart

Kopiér mappe

POST /v1/folders/:id/copy

Kommer snart

Sørg for, at du har fulgt opsætningsinstruktionerne for dit domæne.

Disse instruktioner kan findes under Min Konto → Domæner → Indstillinger → Udgående SMTP Konfiguration. Du skal sikre opsætning af DKIM, Return-Path og DMARC for at sende udgående SMTP med dit domæne.

Hent grænse for udgående SMTP-email

Dette er et simpelt endpoint, der returnerer et JSON-objekt indeholdende count og limit for antallet af daglige udgående SMTP-beskeder pr. konto.

GET /v1/emails/limit

Eksempel på forespørgsel:

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

Liste over udgående SMTP-emails

Bemærk, at dette endpoint ikke returnerer egenskabsværdier for en emails message, headers eller rejectedErrors.

For at returnere disse egenskaber og deres værdier, brug venligst Hent email endpoint med en email-ID.

GET /v1/emails

Eksempel på forespørgsel:

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

Opret udgående SMTP-email

Vores API til oprettelse af en email er inspireret af og benytter Nodemailers message option-konfiguration. Se venligst Nodemailer message configuration for alle body-parametre nedenfor.

Bemærk, at med undtagelse af envelope og dkim (da vi sætter disse automatisk for dig), understøtter vi alle Nodemailer muligheder. Vi sætter automatisk disableFileAccess og disableUrlAccess til true af sikkerhedsmæssige årsager.

Du skal enten sende den enkelte option raw med din rå fulde email inklusive headers eller sende individuelle body-parameter muligheder nedenfor.

Dette API-endpoint koder automatisk emojis for dig, hvis de findes i headers (f.eks. en emnelinje Subject: 🤓 Hello konverteres automatisk til Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Vores mål var at lave en ekstremt udviklervenlig og idiot-sikker email-API.

Autentificering: Dette endpoint understøtter både API token autentificering og alias credentials autentificering. Se afsnittet Autentificering ovenfor for detaljer.

POST /v1/emails

Eksempelanmodning (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"

Eksempelanmodning (Alias-legitimationsoplysninger):

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"

Eksempelanmodning (Raw Email):

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

Hent udgående SMTP-email

GET /v1/emails/:id

Eksempelanmodning:

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

Slet udgående SMTP-email

Sletning af email vil sætte status til "rejected" (og efterfølgende ikke behandle den i køen) hvis og kun hvis den nuværende status er en af "pending", "queued" eller "deferred". Vi kan automatisk slette emails efter 30 dage efter de blev oprettet og/eller sendt – derfor bør du beholde en kopi af udgående SMTP-emails i din klient, database eller applikation. Du kan referere til vores email-ID-værdi i din database, hvis ønsket – denne værdi returneres fra både Opret email og Hent email endpoints.

DELETE /v1/emails/:id

Eksempelanmodning:

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

Liste domæner

GET /v1/domains

Eksempelanmodning:

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

Opret domæne

POST /v1/domains

Eksempel på forespørgsel:

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

Hent domæne

GET /v1/domains/example.com

Eksempel på forespørgsel:

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

Verificer domæneposter

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

Eksempel på forespørgsel:

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

Verificer domænes SMTP-poster

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

Eksempel på forespørgsel:

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

Liste over domænedækkende catch-all adgangskoder

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

Eksempel på forespørgsel:

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

Opret domænedækkende catch-all adgangskode

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

Eksempel på forespørgsel:

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

Fjern domænedækkende catch-all adgangskode

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

Eksempel på forespørgsel:

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

Opdater domæne

PUT /v1/domains/example.com

Example Request:

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

Slet domæne

DELETE /v1/domains/:domain_name

Example Request:

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

Accepter domæneinvitation

GET /v1/domains/:domain_name/invites

Example Request:

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

Opret domæneinvitation

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

Fjern domæneinvitation

DELETE /v1/domains/:domain_name/invites

Example Request:

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

Opdater domænemedlem

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:

Fjern domænemedlem

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:

Generer et alias-adgangskode

Bemærk, at hvis du ikke sender instruktioner via email, vil brugernavn og adgangskode være i JSON-responsens krop ved en succesfuld forespørgsel i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Eksempel på forespørgsel:

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

Liste over domænealiaser

GET /v1/domains/example.com/aliases

Eksempel på forespørgsel:

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

Opret nyt domænealias

POST /v1/domains/example.com/aliases

Example Request:

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

Hent domænealias

Du kan hente et domænealias enten ved dets id eller dets name værdi.

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:

Opdater domænealias

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

Example Request:

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

Slet domænealias

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

Example Request:

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

Vi tillader dig at kryptere poster selv på gratisplanen uden omkostninger. Privatliv bør ikke være en funktion, det bør være indbygget i alle aspekter af et produkt. Som stærkt efterspurgt i en Privacy Guides diskussion og på vores GitHub issues har vi tilføjet dette.

Krypter TXT-post

POST /v1/encrypt

Example Request:

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