Sähköpostin API

Tällä hetkellä emme ole vielä julkaisseet API-kääreitä, mutta aiomme tehdä sen lähitulevaisuudessa. Lähetä sähköpostia osoitteeseen api@forwardemail.net, jos haluat saada ilmoituksen, kun tietyn ohjelmointikielen API-kääre julkaistaan. Sillä välin voit käyttää näitä suositeltuja HTTP-pyyntökirjastoja sovelluksessasi tai yksinkertaisesti käyttää curl kuten alla olevissa esimerkeissä.

Nykyinen HTTP-perus-URI-polku on: https://fe.tiamati.email.

Kaikki päätepisteet vaativat todennuksen käyttäen Basic Authorization. Tuemme kahta todennusmenetelmää:

API Token Authentication (Suositeltu useimmille päätepisteille)

Aseta API-avaimesi "käyttäjätunnus" -arvoksi tyhjällä salasanalla:

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

Huomaa kaksoispiste (:) API-tokenin jälkeen – tämä ilmaisee tyhjän salasanan Basic Auth -muodossa.

Alias Credentials Authentication (Lähtevälle sähköpostille)

Create outbound SMTP email -päätepiste tukee myös todennusta käyttämällä alias-sähköpostiosoitetta ja luotua alias-salasanaa:

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"

Tämä menetelmä on hyödyllinen, kun lähetät sähköposteja sovelluksista, jotka jo käyttävät SMTP-tunnuksia, ja tekee siirtymisen SMTP:stä API:imme saumattomaksi.

Alias-Only Endpoints

Alias Contacts, Alias Calendars, Alias Messages ja Alias Folders -päätepisteet vaativat alias-tunnukset eivätkä tue API-token-todennusta.

Älä huoli – alla on esimerkkejä, jos et ole varma, mitä tämä tarkoittaa.

Jos virheitä ilmenee, API-pyynnön vastausrungossa on yksityiskohtainen virheilmoitus.

Palvelumme on käännetty yli 25 eri kielelle. Kaikki API-vastausviestit käännetään viimeksi havaitulle käyttäjän paikalliselle asetukselle, joka tekee API-pyynnön. Voit ohittaa tämän asettamalla mukautetun Accept-Language -otsikon. Kokeile vapaasti kielen valintaa tämän sivun alareunassa olevasta pudotusvalikosta.

Sivutus on tuettu kaikissa API-päätepisteissä, jotka listaavat tuloksia.

Anna yksinkertaisesti kyselymerkkijonon ominaisuudet page (ja valinnaisesti limit).

Ominaisuuden page tulee olla luku, joka on suurempi tai yhtä suuri kuin 1. Jos annat limit-arvon (myös luku), sen vähimmäisarvo on 10 ja enimmäisarvo 50 (ellei toisin mainita).

Esimerkkipyyntö:

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

Nouda lokit

API:mme avulla voit ohjelmallisesti ladata tilisi lokitiedot. Lähettämällä pyynnön tähän päätepisteeseen käsitellään kaikki tilisi lokit ja lähetetään ne sinulle sähköpostitse liitteenä (Gzip pakattu CSV taulukkomuotoinen tiedosto) valmistuttuaan.

Tämä mahdollistaa taustatehtävien luomisen Cron job -ajastimella tai käyttämällä Node.js työaikataulutusohjelmisto Bree -ohjelmaa, jolloin voit vastaanottaa lokit halutessasi. Huomaa, että tämä päätepiste on rajoitettu 10 pyyntöön päivässä.

Liitteenä on pienaakkosilla muotoiltu tiedosto nimeltä email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz ja sähköposti sisältää lyhyen yhteenvedon haetuista lokeista. Voit myös ladata lokit milloin tahansa Oma tili → Lokit -sivulta.

GET /v1/logs/download

Esimerkkipyyntö:

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

Esimerkki Cron-tehtävästä (keskellä yötä joka päivä):

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

Huomaa, että voit käyttää palveluita kuten Crontab.guru validoidaksesi cron-tehtäväilmaisusi syntaksin.

Esimerkki Cron-tehtävästä (keskellä yötä joka päivä ja edellisen päivän lokit):

MacOS:lle:

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

Linuxille ja Ubuntulle:

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

Luo tili

POST /v1/account

Esimerkkipyyntö:

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

Nouda tili

GET /v1/account

Esimerkkipyyntö:

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

Päivitä tili

PUT /v1/account

Esimerkkipyyntö:

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

Listaa yhteystiedot

GET /v1/contacts

Tulossa pian

Luo yhteystieto

POST /v1/contacts

Tulossa pian

Hae yhteystieto

GET /v1/contacts/:id

Tulossa pian

Päivitä yhteystieto

PUT /v1/contacts/:id

Tulossa pian

Poista yhteystieto

DELETE /v1/contacts/:id

Tulossa pian

Listaa kalenterit

GET /v1/calendars

Tulossa pian

Luo kalenteri

POST /v1/calendars

Tulossa pian

Hae kalenteri

GET /v1/calendars/:id

Tulossa pian

Päivitä kalenteri

PUT /v1/calendars/:id

Tulossa pian

Poista kalenteri

DELETE /v1/calendars/:id

Tulossa pian

Varmista, että olet noudattanut verkkotunnuksesi asennusohjeita.

Nämä ohjeet löytyvät UKK-osastostamme Tuetteko sähköpostin vastaanottoa IMAPilla?.

Listaa ja hae viestejä

GET /v1/messages

Tulossa pian

Luo viesti

POST /v1/messages

Tulossa pian

Hae viesti

GET /v1/messages/:id

Tulossa pian

Päivitä viesti

PUT /v1/messages/:id

Tulossa pian

Poista viesti

DELETE /v1/messages:id

Tulossa pian

Listaa kansiot

GET /v1/folders

Tulossa pian

Luo kansio

POST /v1/folders

Tulossa pian

Hae kansio

GET /v1/folders/:id

Tulossa pian

Päivitä kansio

PUT /v1/folders/:id

Tulossa pian

Poista kansio

DELETE /v1/folders/:id

Tulossa pian

Kopioi kansio

POST /v1/folders/:id/copy

Tulossa pian

Varmista, että olet noudattanut verkkotunnuksesi asennusohjeita.

Nämä ohjeet löytyvät kohdasta Oma tili → Verkkotunnukset → Asetukset → Lähtevän SMTP:n asetukset. Sinun tulee varmistaa DKIM:n, Return-Pathin ja DMARCin asennus lähtevän SMTP:n lähettämistä varten verkkotunnuksellasi.

Hanki lähtevän SMTP-sähköpostin raja

Tämä on yksinkertainen päätepiste, joka palauttaa JSON-objektin, joka sisältää count ja limit päivittäisten SMTP-lähtevien viestien määrälle tilikohtaisesti.

GET /v1/emails/limit

Esimerkkipyyntö:

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

Listaa lähtevät SMTP-sähköpostit

Huomaa, että tämä päätepiste ei palauta ominaisuuksien arvoja sähköpostin message, headers eikä rejectedErrors osalta.

Palautaaksesi nämä ominaisuudet ja niiden arvot, käytä Hae sähköposti -päätepistettä sähköpostin tunnuksella.

GET /v1/emails

Esimerkkipyyntö:

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

Luo lähtevä SMTP-sähköposti

Sähköpostin luomisen API on inspiroitunut ja hyödyntää Nodemailerin viestivaihtoehtojen konfiguraatiota. Katso kaikki alla olevat runkoparametrit Nodemailerin viestikonfiguraatiosta.

Huomaa, että lukuun ottamatta envelope ja dkim (koska asetamme ne automaattisesti puolestasi), tuemme kaikkia Nodemailerin vaihtoehtoja. Asetamme automaattisesti disableFileAccess ja disableUrlAccess arvoksi true turvallisuussyistä.

Sinun tulee joko antaa yksittäinen raw-vaihtoehto, joka sisältää koko raakadatan sähköpostista otsikoineen tai antaa yksittäiset runkoparametrit alla.

Tämä API-päätepiste koodaa automaattisesti emojit, jos niitä löytyy otsikoista (esim. otsikkorivi Subject: 🤓 Hello muunnetaan automaattisesti muotoon Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Tavoitteemme oli tehdä erittäin kehittäjäystävällinen ja virheenkestävä sähköpostin API.

Autentikointi: Tämä päätepiste tukee sekä API-tunnisteautentikointia että alias-tunnistetietojen autentikointia. Katso yllä oleva Autentikointi -osio yksityiskohtia varten.

POST /v1/emails

Esimerkkipyyntö (API-tunnus):

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

Esimerkkipyyntö (Alias-tunnukset):

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=testi" \
  -d "text=testi"

Esimerkkipyyntö (Raaka sähköposti):

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

Nouda lähtevä SMTP-sähköposti

GET /v1/emails/:id

Esimerkkipyyntö:

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

Poista lähtevä SMTP-sähköposti

Sähköpostin poisto asettaa tilaksi "rejected" (eikä sitä tämän jälkeen käsitellä jonossa) vain jos nykyinen tila on jokin seuraavista: "pending", "queued" tai "deferred". Saatamme poistaa sähköposteja automaattisesti 30 päivän kuluttua niiden luomisesta ja/tai lähettämisestä – siksi sinun tulisi säilyttää kopio lähtevistä SMTP-sähköposteista asiakkaassasi, tietokannassasi tai sovelluksessasi. Voit halutessasi viitata sähköpostin ID-arvoon tietokannassasi – tämä arvo palautetaan sekä Luo sähköposti että Nouda sähköposti -rajapinnoista.

DELETE /v1/emails/:id

Esimerkkipyyntö:

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

Listaa verkkotunnukset

GET /v1/domains

Esimerkkipyyntö:

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

Luo verkkotunnus

POST /v1/domains

Esimerkkipyyntö:

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

Hae domain

GET /v1/domains/example.com

Esimerkkipyyntö:

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

Vahvista domainin tietueet

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

Esimerkkipyyntö:

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

Vahvista domainin SMTP-tietueet

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

Esimerkkipyyntö:

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

Listaa domainin catch-all-salasanat

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

Esimerkkipyyntö:

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

Luo domainin catch-all-salasana

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

Esimerkkipyyntö:

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

Poista domainin catch-all-salasana

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

Esimerkkipyyntö:

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

Päivitä domain

PUT /v1/domains/example.com

Esimerkkipyyntö:

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

Poista domain

DELETE /v1/domains/:domain_name

Esimerkkipyyntö:

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

Hyväksy domain-kutsu

GET /v1/domains/:domain_name/invites

Esimerkkipyyntö:

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

Luo domain-kutsu

POST /v1/domains/example.com/invites

Esimerkkipyyntö:

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

Poista domain-kutsu

DELETE /v1/domains/:domain_name/invites

Esimerkkipyyntö:

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

Päivitä domain-jäsen

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

Esimerkkipyyntö:

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

Poista domain-jäsen

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

Esimerkkipyyntö:

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

Luo alias-salasana

Huomaa, että jos et lähetä ohjeita sähköpostitse, käyttäjätunnus ja salasana ovat onnistuneen pyynnön JSON-vastauksen rungossa muodossa { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Esimerkkipyyntö:

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

Listaa domainin aliakset

GET /v1/domains/example.com/aliases

Esimerkkipyyntö:

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

Luo uusi domainin alias

POST /v1/domains/example.com/aliases

Esimerkkipyyntö:

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

Hae verkkotunnuksen alias

Voit hakea verkkotunnuksen aliasin joko sen id- tai name-arvon perusteella.

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

Esimerkkipyyntö:

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

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

Esimerkkipyyntö:

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

Päivitä verkkotunnuksen alias

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

Esimerkkipyyntö:

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

Poista verkkotunnuksen alias

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

Esimerkkipyyntö:

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

Sallimme tietueiden salaamisen myös ilmaisella suunnitelmalla ilman kustannuksia. Yksityisyys ei saisi olla ominaisuus, vaan sen tulisi olla sisäänrakennettuna kaikissa tuotteen osa-alueissa. Kuten erittäin toivottu Privacy Guides -keskustelussa ja GitHub-ongelmissamme, olemme lisänneet tämän.

Salaa TXT-tietue

POST /v1/encrypt

Esimerkkipyyntö:

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