Sähköposti 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 on julkaistu. Sillä välin voit käyttää näitä suositeltuja HTTP-pyyntökirjastoja sovelluksessasi tai yksinkertaisesti käyttää kiemura kuten alla olevissa esimerkeissä.

Nykyinen HTTP-pohjainen URI-polku on: https://api.forwardemail.net.

Kaikki päätepisteet vaativat sinun API-avain asetetaan pyynnön "käyttäjänimi"-arvoksi Peruslupa otsikko (paitsi Alias Yhteystiedot, Alias kalenterit, ja Alias Postilaatikot jotka käyttävät a luotu alias käyttäjätunnus ja salasana)..

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

Jos virheitä tapahtuu, API-pyynnön vastausrunko sisältää yksityiskohtaisen virhesanoman.

[!KÄRKI] Jos saat 5xx-tilakoodin (mitä ei pitäisi tapahtua), ota meihin yhteyttä osoitteessa api@forwardemail.net ja autamme sinua ratkaisemaan ongelmasi välittömästi.

Palvelumme on käännetty yli 25 eri kielelle. Kaikki API-vastausviestit käännetään API-pyynnön tehneen käyttäjän viimeksi havaittuun alueeseen. Voit ohittaa tämän ohittamalla mukautetun Accept-Language otsikko. Voit vapaasti kokeilla sitä käyttämällä tämän sivun alareunassa olevaa avattavaa kielivalikkoa.

[!HUOM] 1. marraskuuta 2024 alkaen API-päätepisteet Luettelo verkkotunnuksista ja Luettele verkkotunnuksen aliakset oletuksena 1000 max tulos per sivu. Jos haluat hyväksyä tämän toiminnan aikaisin, voit läpäistä ?paginate=true ylimääräisenä kyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen.

Kaikki tulokset listaavat API-päätepisteet tukevat sivutusta.

Anna vain kyselymerkkijonon ominaisuudet page (ja valinnaisesti limit).

Omaisuus page tulee olla numero, joka on suurempi tai yhtä suuri kuin 1. Jos tarjoat limit (myös numero), niin pienin arvo on 10 ja maksimi on 50 (ellei toisin mainita).

Jotta voimme määrittää, onko lisää tuloksia saatavilla, tarjoamme nämä HTTP-vastausotsikot (jotka voit jäsentää ja sivuuttaa ohjelmallisesti):

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Hae lokit

Sovellusliittymämme avulla voit ohjelmallisesti ladata lokeja tilillesi. Pyynnön lähettäminen tähän päätepisteeseen käsittelee kaikki tilisi lokit ja lähettää ne sinulle liitteenä (Gzip pakattu CSV laskentataulukkotiedosto), kun se on valmis.

Tämän avulla voit luoda taustatöitä a Cronin työ tai käyttämällä meidän Node.js työn ajoitusohjelmisto Bree vastaanottaa lokit milloin haluat. Huomaa, että tämä päätepiste on rajoitettu 10 pyyntöjä päivässä.

Liite on pienillä kirjaimilla email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz ja itse sähköposti sisältää lyhyen yhteenvedon haetuista lokeista. Voit myös ladata lokit milloin tahansa osoitteesta Oma tili → Lokit

GET /v1/logs/download

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Esimerkki Cronin työstä (joka päivä keskiyöllä):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Huomaa, että voit käyttää palveluita, kuten Crontab.guru vahvistaaksesi cron-työlausekkeen syntaksin.

Esimerkki Cron-työstä (joka päivä keskiyöllä ja edellisen päivän lokeilla):

MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Linux ja Ubuntu:

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

Nouda tili

GET /v1/account

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Päivitä tili

PUT /v1/account

Esimerkkipyyntö:

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

[!HUOM] Toisin kuin muut API-päätepisteet, nämä vaativat Todennus "username" vastaa aliaksen käyttäjänimeä ja "salasana" vastaa aliaksen luomaa salasanaa Basic Authorization -otsikoina.

[!VAROITUS] Tämä päätepisteosio on työn alla, ja se julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasta verkkosivustomme navigoinnin "Sovellukset"-pudotusvalikosta.

[!NOTE] CardDAV-tuki ei ole vielä saatavilla. Seuraa tätä keskustelua GitHubissa päivityksiä varten.

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

[!HUOM] Toisin kuin muut API-päätepisteet, nämä vaativat Todennus "username" vastaa aliaksen käyttäjänimeä ja "salasana" vastaa aliaksen luomaa salasanaa Basic Authorization -otsikoina.

[!VAROITUS] Tämä päätepisteosio on työn alla, ja se julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasta verkkosivustomme navigoinnin "Sovellukset"-pudotusvalikosta.

Listaa kalentereita

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

[!HUOM] Toisin kuin muut API-päätepisteet, nämä vaativat Todennus "username" vastaa aliaksen käyttäjänimeä ja "salasana" vastaa aliaksen luomaa salasanaa Basic Authorization -otsikoina.

[!VAROITUS] Tämä päätepisteosio on työn alla, ja se julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasta verkkosivustomme navigoinnin "Sovellukset"-pudotusvalikosta.

Varmista, että olet noudattanut verkkotunnuksesi asennusohjeita.

Nämä ohjeet löytyvät usein kysytyistä kysymyksistämme Tuetko sähköpostin vastaanottamista IMAP-protokollalla?.

Listaa ja etsi viestejä

GET /v1/messages

Tulossa pian

Luo viesti

[!HUOM] Tämä tulee NOT lähetä sähköposti – se vain lisää viestin postilaatikkosi kansioon (esim. tämä on samanlainen kuin IMAP APPEND komento). Jos haluat lähettää sähköpostia, katso Luo lähtevä SMTP-sähköposti alla. Kun olet luonut lähtevän SMTP-sähköpostin, voit liittää sen kopion tämän päätepisteen avulla aliaksesi postilaatikkoon tallennustarkoituksiin.

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

[!KÄRKI] Kansion päätepisteet kansion polulla /v1/folders/:path koska niiden päätepisteet ovat vaihdettavissa kansion tunnuksen kanssa :id. Tämä tarkoittaa, että voit viitata kansioon kummalla tahansa sen perusteella path tai id arvo.

[!VAROITUS] Tämä päätepisteosio on työn alla, ja se julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasta verkkosivustomme navigoinnin "Sovellukset"-pudotusvalikosta.

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 osoitteesta Oma tili → Domains → Asetukset → Lähtevän SMTP-määritykset. Sinun on varmistettava DKIM-, Return-Path- ja DMARC-asetukset, jotta voit lähettää lähtevän SMTP:n verkkotunnuksesi kanssa.

Hae 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 lähtevien SMTP-viestien määrä tilikohtaisesti.

GET /v1/emails/limit

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

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

Huomaa, että tämä päätepiste ei palauta sähköpostin ominaisuusarvoja message, headers, ei myöskään rejectedErrors.

Voit palauttaa kyseiset ominaisuudet ja niiden arvot käyttämällä Hae sähköposti päätepiste sähköpostitunnuksella.

GET /v1/emails

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

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

Sähköpostin luontisovellusliittymämme on saanut inspiraationsa Nodemailerin viestivaihtoehdoista ja hyödyntää sitä. Ole hyvä ja siirry kohtaan Nodemailer-viestin määritys kaikille alla oleville kehon parametreille.

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

Sinun tulisi joko ohittaa yksi vaihtoehto raw raa'alla täydellisellä sähköpostilla, mukaan lukien otsikot tai anna yksittäiset kehon parametriasetukset alla.

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

POST /v1/emails

Esimerkkipyyntö:

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

Esimerkkipyyntö:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

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

GET /v1/emails/:id

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

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

Sähköpostin poistaminen asettaa tilaksi "rejected" (ja sen jälkeen ei käsitellä sitä jonossa) jos ja vain, jos nykyinen tila on yksi "pending", "queued", tai "deferred". Saatamme tyhjentää sähköpostit automaattisesti 30 päivän kuluttua niiden luomisesta ja/tai lähettämisestä – siksi sinun tulee säilyttää kopio lähtevistä SMTP-sähköposteista asiakkaassasi, tietokannassasi tai sovelluksessasi. Voit halutessasi viitata sähköpostitunnukseemme tietokannassasi – tämä arvo palautetaan molemmista Luo sähköposti ja Hae sähköposti päätepisteitä.

DELETE /v1/emails/:id

Esimerkkipyyntö:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

[!KÄRKI] Verkkotunnuksen päätepisteet verkkotunnuksen nimellä /v1/domains/:domain_name koska niiden päätepisteet ovat vaihdettavissa verkkotunnuksen tunnuksen kanssa :domain_id. Tämä tarkoittaa, että voit viitata verkkotunnukseen joko sen perusteella name tai id arvo.

Luettelo verkkotunnuksista

[!HUOM] 1. marraskuuta 2024 alkaen API-päätepisteet Luettelo verkkotunnuksista ja Luettele verkkotunnuksen aliakset oletuksena 1000 max tulos per sivu. Jos haluat hyväksyä tämän toiminnan aikaisin, voit läpäistä ?paginate=true ylimääräisenä kyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen. Katso Sivunumerointi saadaksesi lisätietoa.

GET /v1/domains

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Luo verkkotunnus

POST /v1/domains

Esimerkkipyyntö:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Hae verkkotunnus

GET /v1/domains/example.com

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Vahvista verkkotunnustietueet

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

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Päivitä verkkotunnus

PUT /v1/domains/example.com

Esimerkkipyyntö:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Poista verkkotunnus

DELETE /v1/domains/:domain_name

Esimerkkipyyntö:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Hyväksy verkkotunnuksen kutsu

GET /v1/domains/:domain_name/invites

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Luo verkkotunnuksen kutsu

POST /v1/domains/example.com/invites

Esimerkkipyyntö:

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

[!TÄRKEÄÄ] Jos kutsuttava käyttäjä on jo minkä tahansa muun verkkotunnuksen hyväksytty jäsen, jonka jäsen häntä kutsuva järjestelmänvalvoja on, se hyväksyy kutsun automaattisesti eikä lähetä sähköpostia.

Poista verkkotunnuksen kutsu

DELETE /v1/domains/:domain_name/invites

Esimerkkipyyntö:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Päivitä verkkotunnuksen jäsen

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

Esimerkkipyyntö:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Poista verkkotunnuksen jäsen

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

Esimerkkipyyntö:

curl -X DELETE https://api.forwardemail.net/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änimi ja salasana ovat onnistuneen pyynnön JSON-vastaustekstissä muodossa { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Esimerkkipyyntö:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Luettele verkkotunnuksen aliakset

[!HUOM] 1. marraskuuta 2024 alkaen API-päätepisteet Luettelo verkkotunnuksista ja Luettele verkkotunnuksen aliakset oletuksena 1000 max tulos per sivu. Jos haluat hyväksyä tämän toiminnan aikaisin, voit läpäistä ?paginate=true ylimääräisenä kyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen. Katso Sivunumerointi saadaksesi lisätietoa.

GET /v1/domains/example.com/aliases

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Luo uusi verkkotunnuksen alias

POST /v1/domains/example.com/aliases

Esimerkkipyyntö:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Hae verkkotunnuksen alias

Voit hakea verkkotunnuksen aliaksen joko sen perusteella id tai sen name arvo.

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

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

Esimerkkipyyntö:

curl https://api.forwardemail.net/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://api.forwardemail.net/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://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Annamme sinun salata tietueita jopa ilmaisella sopimuksella ilman kustannuksia. Yksityisyyden suojan ei pitäisi olla ominaisuus, sen tulee olla luonnostaan sisäänrakennettu tuotteen kaikkiin osa-alueisiin. Kuten erittäin pyydettiin a Tietosuojaoppaiden keskustelu ja edelleen GitHub-ongelmiimme olemme lisänneet tämän.

Salaa TXT-tietue

POST /v1/encrypt

Esimerkkipyyntö:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"