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. Ä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.

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.

Jos haluat saada ilmoituksen, kun sivutus on saatavilla, lähetä sähköpostia api@forwardemail.net.

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"

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.

Listaa sähköpostit

Huomaa, että tämä päätepiste ei palauta jo luotuja sähköpostiviestejä message, headers, accepted, ei myöskään rejectedErrors ominaisuuksia.

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

Tämä päätepiste palaa korkeintaan 50 tuloksia kerrallaan. Jos haluat hakea useita sivuja, liitä ?page=NUMBER missä NUMBER on kokonaisluku, esim. ?page=1.

GET /v1/emails

Esimerkkipyyntö:

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

Luo 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.

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 sähköposti

GET /v1/emails/:id

Esimerkkipyyntö:

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

Poista 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:

Luettelo verkkotunnuksista

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

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:

Luettele verkkotunnuksen aliakset

GET /v1/domains/example.com/aliases

Esimerkkipyyntö:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: