Sähköposti-API

Tällä hetkellä emme ole vielä julkaisseet API-kääreitä, mutta aiomme tehdä niin 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 käyttää yksinkertaisesti kiemura-kirjastoa kuten alla olevissa esimerkeissä.

Kieli Kirjasto
Rubiini Faraday
Python requests
Java OkHttp
PHP guzzle
JavaScript superagent (olemme ylläpitäjiä)
Node.js superagent (olemme ylläpitäjiä)
Mennä net/http
.NET RestSharp

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

Kaikki päätepisteet edellyttävät, että API-avain on asetettu pyynnön Perusvaltuutus-otsikon "username"-arvoksi (lukuun ottamatta Alias-yhteystiedot-, Alias-kalenterit- ja Alias-postilaatikot-otsikoita, jotka käyttävät luotu alias-käyttäjätunnus ja salasana-arvoa).

Älä huoli – esimerkkejä on alla, jos et ole varma, mistä on kyse.

Jos virheitä ilmenee, API-pyynnön vastauksen runko sisältää yksityiskohtaisen virheilmoituksen.

Koodi Nimi
200 OK
400 Virheellinen pyyntö
401 Luvaton
403 Kielletty
404 Ei löytynyt
429 Liian monta pyyntöä
500 Sisäinen palvelinvirhe
501 Ei toteutettu
502 Huono yhdyskäytävä
503 Palvelu ei ole käytettävissä
504 Yhdyskäytävän aikakatkaisu

Tip

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

Palvelumme on käännetty yli 25 eri kielelle. Kaikki API-vastausviestit käännetään käyttäjän API-pyynnön viimeksi havaitsemaan kieliasetukseen. Voit ohittaa tämän antamalla mukautetun Accept-Language-otsikon. Voit kokeilla sitä tämän sivun alareunassa olevan kielivalikon avulla.

Note

  1. marraskuuta 2024 alkaen Listaa verkkotunnukset- ja Listaa verkkotunnusaliakset-sovellusliittymän päätepisteiden oletusarvo on 1000, jonka enimmäistulokset sivua kohden ovat 1000. Jos haluat ottaa tämän käyttöön jo aiemmin, voit välittää ?paginate=true:n lisäkyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen.

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

Anna vain kyselymerkkijonon ominaisuudet page (ja valinnaisesti limit).

Ominaisuuden page tulee olla luku, joka on suurempi tai yhtä suuri kuin 1. Jos annat limit:n (myös luku), pienin arvo on 10 ja suurin 50 (ellei toisin mainita).

Kyselymerkkijonojen parametrit Pakollinen Tyyppi Kuvaus
page Ei Määrä Palautettava tulossivu. Jos ei ole määritetty, page -arvo on 1. Sen on oltava suurempi tai yhtä suuri kuin 1.
limit Ei Määrä Sivua kohden palautettavien tulosten määrä. Oletusarvo on 10, jos sitä ei ole määritetty. Luvun on oltava suurempi tai yhtä suuri kuin 1 ja pienempi tai yhtä suuri kuin 50.

Jotta voimme selvittää, onko lisää tuloksia saatavilla, tarjoamme seuraavat HTTP-vastausotsikot (jotka voit jäsentää sivutusta varten):

HTTP-vastausotsikko Esimerkki Kuvaus
X-Page-Count X-Page-Count: 3 Käytettävissä olevien sivujen kokonaismäärä.
X-Page-Current X-Page-Current: 1 Nykyinen palautettujen tulosten sivu (esim. page kyselymerkkijonoparametrin perusteella).
X-Page-Size X-Page-Size: 10 Sivulla palautettujen tulosten kokonaismäärä (esim. limit kyselymerkkijonoparametrin ja palautettujen todellisten tulosten perusteella).
X-Item-Count X-Item-Count: 30 Kaikilla sivuilla saatavilla olevien kohteiden kokonaismäärä.
Link Link: <https://api.forwardemail.net/v1/emails?page=1>; rel="prev", <https://api.forwardemail.net/v1/emails?page=3>; rel="next", <https://api.forwardemail.net/v1/emails?page=3; rel="last", https://api.forwardemail.net/v1/emails?page=1; rel="first" Tarjoamme Link HTTP-vastausotsikon, jonka voit jäsentää esimerkissä esitetyllä tavalla. Tämä on similar to GitHub (esim. kaikkia arvoja ei anneta, jos ne eivät ole relevantteja tai saatavilla, esim. "next" ei anneta, jos toista sivua ei ole).

Esimerkkipyyntö:

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

Nouda lokit

API-rajapintamme avulla voit ladata lokeja tilillesi ohjelmallisesti. Pyynnön lähettäminen tähän päätepisteeseen käsittelee kaikki tilisi lokit ja lähettää ne sinulle sähköpostin liitteenä (Gzip pakattu CSV taulukkolaskentatiedosto), kun se on valmis.

Näin voit luoda taustatöitä Cron-työ-kohteella tai käyttää Node.js-työaikataulutusohjelmisto Bree-kohteitamme lokien vastaanottamiseen milloin tahansa. Huomaa, että tämä päätepiste on rajoitettu 10 pyyntöön päivässä.

Liite on email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz:n pienimuotoinen muoto, ja itse sähköpostiviesti sisältää lyhyen yhteenvedon noudetuista lokeista. Voit myös ladata lokit milloin tahansa osoitteesta Oma tili → Lokit.

GET /v1/logs/download

Kyselymerkkijonojen parametrit Pakollinen Tyyppi Kuvaus
domain Ei Merkkijono (FQDN) Suodata lokit täysin pätevän verkkotunnuksen ("FQDN") mukaan. Jos et anna tätä, kaikkien verkkotunnusten kaikki lokit noudetaan.
q Ei Jousi Hae lokeja sähköpostiosoitteen, verkkotunnuksen, aliaksen, IP-osoitteen tai päivämäärän mukaan (muoto M/Y, M/D/YY, M-D, M-D-YY tai M.D.YY).
bounce_category Ei Jousi Hae lokeja tietyn palautusluokan mukaan (esim. blocklist).
response_code Ei Määrä Hae lokeja tietyn virhevastauskoodin perusteella (esim. 421 tai 550).

Esimerkkipyyntö:

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

Esimerkki Cron-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, cron-työlausekkeen syntaksin validointiin.

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

MacOS-käyttöjärjestelmälle:

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

Linuxille ja Ubuntulle:

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

Kehon parametri Pakollinen Tyyppi Kuvaus
email Kyllä Merkkijono (sähköpostiosoite) Sähköpostiosoite
password Kyllä Jousi Salasana

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

Kehon parametri Pakollinen Tyyppi Kuvaus
email Ei Merkkijono (sähköpostiosoite) Sähköpostiosoite
given_name Ei Jousi Etunimi
family_name Ei Jousi Sukunimi
avatar_url Ei Merkkijono (URL-osoite) Linkki avatar-kuvaan

Esimerkkipyyntö:

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

Note

Toisin kuin muut API-päätepisteet, nämä vaativat perusvaltuutusotsikoiksi Todennus "käyttäjätunnus", joka on sama kuin aliaksen käyttäjätunnus, ja "salasanan", joka on sama kuin aliaksen luoma salasana.

Warning

Tämä päätepisteosio on keskeneräinen ja julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasohjelmaa verkkosivustomme navigoinnin "Sovellukset"-alasvetovalikosta.

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

Note

Toisin kuin muut API-päätepisteet, nämä vaativat perusvaltuutusotsikoiksi Todennus "käyttäjätunnus", joka on sama kuin aliaksen käyttäjätunnus, ja "salasanan", joka on sama kuin aliaksen luoma salasana.

Warning

Tämä päätepisteosio on keskeneräinen ja julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasohjelmaa verkkosivustomme navigoinnin "Sovellukset"-alasvetovalikosta.

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

Note

Toisin kuin muut API-päätepisteet, nämä vaativat perusvaltuutusotsikoiksi Todennus "käyttäjätunnus", joka on sama kuin aliaksen käyttäjätunnus, ja "salasanan", joka on sama kuin aliaksen luoma salasana.

Warning

Tämä päätepisteosio on keskeneräinen ja julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasohjelmaa verkkosivustomme navigoinnin "Sovellukset"-alasvetovalikosta.

Varmista, että olet noudattanut verkkotunnuksesi asennusohjeita.

Nämä ohjeet löytyvät usein kysyttyjen kysymysten osiostamme Tuetteko sähköpostin vastaanottamista IMAP-protokollan kautta?.

Listaa ja etsii viestejä

GET /v1/messages

Tulossa pian

Luo viesti

Note

Tämä EI lähetä sähköpostia – se vain lisää viestin postilaatikkoosi (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 aliaksesi postilaatikkoon tallennusta varten tämän päätepisteen avulla.

POST /v1/messages

Tulossa pian

Nouda viesti

GET /v1/messages/:id

Tulossa pian

Päivitysviesti

PUT /v1/messages/:id

Tulossa pian

Poista viesti

DELETE /v1/messages:id

Tulossa pian

Tip

Kansioiden päätepisteet, joiden päätepisteenä on kansion polku /v1/folders/:path, ovat keskenään vaihdettavissa kansion tunnuksen :id kanssa. Tämä tarkoittaa, että voit viitata kansioon joko sen path- tai id-arvolla.

Warning

Tämä päätepisteosio on keskeneräinen ja julkaistaan (toivottavasti) vuonna 2024. Käytä sillä välin IMAP-asiakasohjelmaa verkkosivustomme navigoinnin "Sovellukset"-alasvetovalikosta.

Listaa kansiot

GET /v1/folders

Tulossa pian

Luo kansio

POST /v1/folders

Tulossa pian

Nouda 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 → Verkkotunnukset → Asetukset → Lähtevän SMTP:n asetukset. Sinun on varmistettava, että DKIM, Return-Path ja DMARC on määritetty lähtevän SMTP-viestin lähettämistä varten verkkotunnuksesi kautta.

Hae lähtevän SMTP-sähköpostin rajoitus

Tämä on yksinkertainen päätepiste, joka palauttaa JSON-objektin, joka sisältää count- ja limit-arvot päivittäisten SMTP-lähtevien viestien määrälle 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 message-, headers- eikä rejectedErrors-ominaisuuksien arvoja.

Palauttaaksesi nämä ominaisuudet ja niiden arvot, käytä Hae sähköposti-päätepistettä ja sähköpostiosoitetta.

GET /v1/emails

Kyselymerkkijonojen parametrit Pakollinen Tyyppi Kuvaus
q Ei Merkkijono (Regulaarilauseke tuettu) Hae sähköposteja metatietojen perusteella
domain Ei Merkkijono (Regulaarilauseke tuettu) Hae sähköposteja verkkotunnuksen perusteella
sort Ei Jousi Lajittele tietyn kentän mukaan (lisää etuliite yhdellä yhdysmerkillä - lajitellaksesi kentän käänteiseen suuntaan). Oletusarvo on created_at, jos sitä ei ole asetettu.
page Ei Määrä Katso lisätietoja osoitteesta Pagination
limit Ei Määrä Katso lisätietoja osoitteesta Pagination

Esimerkkipyyntö:

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

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

Sähköpostin luomiseen tarkoitettu API-rajapintamme on saanut inspiraationsa Nodemailerin viestiasetusten määrityksistä ja hyödyntää niitä. Käytä Nodemailer-viestin konfigurointi-muuttujaa kaikkien alla olevien tekstiparametrien määrittämiseksi.

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

Sinun tulisi joko antaa raw-niminen yksittäinen asetus raakasähköpostisi kanssa, joka sisältää otsikot, tai antaa yksittäiset alla olevat runkoparametrit.

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

POST /v1/emails

Kehon parametri Pakollinen Tyyppi Kuvaus
from Ei Merkkijono (sähköpostiosoite) Lähettäjän sähköpostiosoite (sen on oltava verkkotunnuksen alias).
to Ei Merkkijono tai taulukko Pilkuilla erotettu luettelo tai vastaanottajien taulukko "Vastaanottaja"-otsikolle.
cc Ei Merkkijono tai taulukko Pilkuilla erotettu luettelo tai vastaanottajien taulukko "Kopio"-otsikolle.
bcc Ei Merkkijono tai taulukko Pilkuilla erotettu luettelo tai vastaanottajien taulukko "Piilokopio"-otsikolle.
subject Ei Jousi Sähköpostin aihe.
text Ei Merkkijono tai puskuri Viestin selkokielinen versio.
html Ei Merkkijono tai puskuri Viestin HTML-versio.
attachments Ei Taulukko Liitetiedostojen objekteja sisältävä taulukko (katso Nodemailer's common fields).
sender Ei Jousi "Lähettäjä"-otsikon sähköpostiosoite (katso Nodemailer's more advanced fields).
replyTo Ei Jousi "Vastaa"-otsikon sähköpostiosoite.
inReplyTo Ei Jousi Viestin ID, johon viesti on vastaus.
references Ei Merkkijono tai taulukko Välilyönneillä erotettu luettelo tai viestitunnusten taulukko.
attachDataUrls Ei Totuusarvo Jos true, se muuntaa viestin HTML-sisällössä olevat data: kuvat upotetuiksi liitteiksi.
watchHtml Ei Jousi Viestin Apple Watchille tarkoitettu HTML-versio (according to the Nodemailer docs, uusimmat kellot eivät vaadi tämän asettamista).
amp Ei Jousi Viestin AMP4EMAIL-kohtainen HTML-versio (katso Nodemailer's example).
icalEvent Ei Esine iCalendar-tapahtuma, jota käytetään vaihtoehtoisena viestisisältönä (katso Nodemailer's calendar events).
alternatives Ei Taulukko Vaihtoehtoisen viestisisällön taulukko (katso Nodemailer's alternative content).
encoding Ei Jousi Tekstin ja HTML-merkkijonojen koodaus (oletusarvo on "utf-8", mutta tukee myös "hex" ja "base64" koodausarvoja).
raw Ei Merkkijono tai puskuri Käytettävä mukautettu RFC822-muotoiltu viesti (Nodemailerin luoman viestin sijaan – katso Nodemailer's custom source).
textEncoding Ei Jousi Tekstiarvoille pakotettu koodaus (joko "quoted-printable" tai "base64"). Oletusarvo on lähimpänä havaittu arvo (ASCII-merkistössä käytä "quoted-printable").
priority Ei Jousi Sähköpostin prioriteettitaso (voi olla joko "high", "normal" (oletus) tai "low"). Huomaa, että arvo "normal" ei aseta prioriteettiotsikkoa (tämä on oletusarvo). Jos arvo "high" tai "low" on asetettu, niin X-Priority, X-MSMail-Priority ja Importance -otsikot ovat will be set accordingly.
headers Ei Objekti tai taulukko Objekti tai taulukko lisäotsikkokentistä, jotka asetetaan (katso Nodemailer's custom headers).
messageId Ei Jousi Valinnainen Message-ID-arvo "Message-ID"-otsikolle (oletusarvo luodaan automaattisesti, jos sitä ei aseteta – huomaa, että arvon tulisi olla adhere to the RFC2822 specification).
date Ei Merkkijono tai päivämäärä Valinnainen päivämääräarvo, jota käytetään, jos päivämääräotsikko puuttuu jäsentämisen jälkeen. Muussa tapauksessa käytetään nykyistä UTC-merkkijonoa, jos sitä ei ole asetettu. Päivämääräotsikko ei voi olla yli 30 päivää nykyistä aikaa edellä.
list Ei Esine Valinnainen List-* -otsikoiden objekti (katso Nodemailer's list headers).

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`"

Nouda 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 tilan arvoon "rejected" (eikä sitä myöhemmin käsitellä jonossa) vain ja ainoastaan, 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 tulee säilyttää kopio lähtevistä SMTP-sähköposteista sähköpostiohjelmassasi, tietokannassasi tai sovelluksessasi. Voit halutessasi viitata sähköpostitunnukseemme tietokannassasi – tämä arvo palautetaan sekä Luo sähköposti- että Hae sähköposti-päätepisteistä.

DELETE /v1/emails/:id

Esimerkkipyyntö:

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

Tip

Verkkotunnusten päätepisteet, joiden päätepisteenä on verkkotunnuksen nimi /v1/domains/:domain_name, ovat keskenään vaihdettavissa verkkotunnuksen tunnuksen :domain_id kanssa. Tämä tarkoittaa, että voit viitata verkkotunnukseen joko sen name- tai id-arvolla.

Listaa verkkotunnukset

Note

  1. marraskuuta 2024 alkaen Listaa verkkotunnukset:n ja Listaa verkkotunnusaliakset:n API-päätepisteiden oletusarvo on 1000, jonka enimmäistulosmäärä sivua kohden on TEMP_PLACEHOLDER. Jos haluat ottaa tämän käyttöön jo aiemmin, voit välittää ?paginate=true:n lisäkyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen. Lisätietoja on kohdassa Sivunumerointi.

GET /v1/domains

Kyselymerkkijonojen parametrit Pakollinen Tyyppi Kuvaus
q Ei Merkkijono (Regulaarilauseke tuettu) Hae verkkotunnuksia nimen perusteella
name Ei Merkkijono (Regulaarilauseke tuettu) Hae verkkotunnuksia nimen perusteella
sort Ei Jousi Lajittele tietyn kentän mukaan (lisää etuliite yhdellä yhdysmerkillä - lajitellaksesi kentän käänteiseen suuntaan). Oletusarvo on created_at, jos sitä ei ole asetettu.
page Ei Määrä Katso lisätietoja osoitteesta Pagination
limit Ei Määrä Katso lisätietoja osoitteesta Pagination

Esimerkkipyyntö:

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

Luo verkkotunnus

POST /v1/domains

Kehon parametri Pakollinen Tyyppi Kuvaus
domain Kyllä Merkkijono (FQDN tai IP) Täydellinen verkkotunnusnimi ("FQDN") tai IP-osoite
team_domain Ei Merkkijono (verkkotunnustunnus tai verkkotunnusnimi; FQDN) Määritä tämä verkkotunnus automaattisesti samalle tiimille toisesta verkkotunnuksesta. Tämä tarkoittaa, että kaikki tämän verkkotunnuksen jäsenet määritetään tiimin jäseniksi ja plan asetetaan automaattisesti myös arvoon team. Voit asettaa arvoksi "none" tarvittaessa poistaaksesi tämän nimenomaisesti käytöstä, mutta se ei ole välttämätöntä.
plan Ei Merkkijono (luetteloitava) Sopimuksen tyyppi (täytyy olla "free", "enhanced_protection" tai "team", oletusarvo on "free" tai käyttäjän nykyinen maksullinen sopimus, jos sellainen on)
catchall Ei Merkkijono (erotelluilla merkeillä sähköpostiosoitteet) tai totuusarvo Luo oletusarvoinen keräilyalias, jonka oletusarvo on true (jos true, vastaanottajana käytetään API-käyttäjän sähköpostiosoitetta, ja jos false, keräilyaliasta ei luoda). Jos merkkijono annetaan, se on eroteltu luettelo sähköpostiosoitteista, joita käytetään vastaanottajina (eroteltuna rivinvaihdolla, välilyönnillä ja/tai pilkulla).
has_adult_content_protection Ei Totuusarvo Otetaanko käyttöön roskapostiskannerin aikuisille suunnatun sisällön suojaus tällä verkkotunnuksella
has_phishing_protection Ei Totuusarvo Otetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protection Ei Totuusarvo Otetaanko käyttöön Roskapostiskannerin suoritettavan tiedoston suojaus tällä verkkotunnuksella
has_virus_protection Ei Totuusarvo Otetaanko käyttöön roskapostiskannerin virustorjunta tässä verkkotunnuksessa
has_recipient_verification Ei Totuusarvo Globaali toimialueen oletusasetus sille, vaaditaanko aliasvastaanottajilta sähköpostin vahvistuslinkin napsauttamista sähköpostien kulkemiseksi
ignore_mx_check Ei Totuusarvo Ohitetaanko MX-tietueen tarkistus verkkotunnuksessa vahvistusta varten. Tämä koskee pääasiassa käyttäjiä, joilla on edistyneet MX-vaihdon määrityssäännöt ja joiden on säilytettävä nykyinen MX-vaihdonsa ja lähetettävä tiedot meille.
retention_days Ei Määrä Kokonaisluku välillä 0 ja 30, joka vastaa säilytyspäivien määrää, jonka ajan lähtevät SMTP-sähköpostit tallennetaan onnistuneen toimituksen tai pysyvän virheen jälkeen. Oletusarvo on 0, mikä tarkoittaa, että lähtevät SMTP-sähköpostit poistetaan ja sensuroidaan välittömästi turvallisuussyistä.
bounce_webhook Ei Merkkijono (URL) tai totuusarvo (false) Valitsemasi http:// tai https:// webhookin URL-osoite, johon palautuswebhookit lähetetään. Lähetämme tähän URL-osoitteeseen POST -pyynnön, joka sisältää tietoja lähtevän SMTP-viestinnän epäonnistumisista (esim. ohjelmisto- tai hard-virheet – jotta voit hallita tilaajiasi ja lähtevää sähköpostiasi ohjelmallisesti).
max_quota_per_alias Ei Jousi Tämän verkkotunnuksen aliaksien tallennuskiintiö. Anna arvo, kuten "1 Gt", jonka bytes jäsentää.

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:

Vahvista verkkotunnuksen SMTP-tietueet

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

Esimerkkipyyntö:

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

Listaa koko verkkotunnuksen kattavat yleiset salasanat

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

Esimerkkipyyntö:

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

Luo koko verkkotunnuksen kattava yleissalasana

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

Kehon parametri Pakollinen Tyyppi Kuvaus
new_password Ei Jousi Uusi mukautettu salasanasi, jota käytetään koko verkkotunnuksen kattavana keräilysalasanana. Huomaa, että voit jättää tämän tyhjäksi tai puuttua kokonaan API-pyyntösi rungosta, jos haluat satunnaisesti luodun ja vahvan salasanan.
description Ei Jousi Kuvaus vain organisointitarkoituksiin.

Esimerkkipyyntö:

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

Poista koko verkkotunnuksen kattava yleissalasana

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

Esimerkkipyyntö:

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

Päivitä verkkotunnus

PUT /v1/domains/example.com

Kehon parametri Pakollinen Tyyppi Kuvaus
smtp_port Ei Merkkijono tai numero Mukautettu portti SMTP-edelleenlähetystä varten (oletus on "25")
has_adult_content_protection Ei Totuusarvo Otetaanko käyttöön roskapostiskannerin aikuisille suunnatun sisällön suojaus tällä verkkotunnuksella
has_phishing_protection Ei Totuusarvo Otetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protection Ei Totuusarvo Otetaanko käyttöön Roskapostiskannerin suoritettavan tiedoston suojaus tällä verkkotunnuksella
has_virus_protection Ei Totuusarvo Otetaanko käyttöön roskapostiskannerin virustorjunta tässä verkkotunnuksessa
has_recipient_verification Ei Totuusarvo Globaali toimialueen oletusasetus sille, vaaditaanko aliasvastaanottajilta sähköpostin vahvistuslinkin napsauttamista sähköpostien kulkemiseksi
ignore_mx_check Ei Totuusarvo Ohitetaanko MX-tietueen tarkistus verkkotunnuksessa vahvistusta varten. Tämä koskee pääasiassa käyttäjiä, joilla on edistyneet MX-vaihdon määrityssäännöt ja joiden on säilytettävä nykyinen MX-vaihdonsa ja lähetettävä tiedot meille.
retention_days Ei Määrä Kokonaisluku välillä 0 ja 30, joka vastaa säilytyspäivien määrää, jonka ajan lähtevät SMTP-sähköpostit tallennetaan onnistuneen toimituksen tai pysyvän virheen jälkeen. Oletusarvo on 0, mikä tarkoittaa, että lähtevät SMTP-sähköpostit poistetaan ja sensuroidaan välittömästi turvallisuussyistä.
bounce_webhook Ei Merkkijono (URL) tai totuusarvo (false) Valitsemasi http:// tai https:// webhookin URL-osoite, johon palautuswebhookit lähetetään. Lähetämme tähän URL-osoitteeseen POST -pyynnön, joka sisältää tietoja lähtevän SMTP-viestinnän epäonnistumisista (esim. ohjelmisto- tai hard-virheet – jotta voit hallita tilaajiasi ja lähtevää sähköpostiasi ohjelmallisesti).
max_quota_per_alias Ei Jousi Tämän verkkotunnuksen aliaksien tallennuskiintiö. Anna arvo, kuten "1 Gt", jonka bytes jäsentää.

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 verkkotunnuskutsu

GET /v1/domains/:domain_name/invites

Esimerkkipyyntö:

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

Luo verkkotunnuskutsu

POST /v1/domains/example.com/invites

Kehon parametri Pakollinen Tyyppi Kuvaus
email Kyllä Merkkijono (sähköpostiosoite) Sähköpostiosoite, johon haluat kutsua verkkotunnuksen jäsenluetteloon
group Kyllä Merkkijono (luetteloitava) Ryhmä, johon käyttäjä lisätään verkkotunnusjäsenyyteen (voi olla joko "admin" tai "user")

Esimerkkipyyntö:

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

Important

Jos kutsuttava käyttäjä on jo hyväksytty jäsen jollakin muulla verkkotunnuksella, johon kutsun lähettänyt ylläpitäjä kuuluu, kutsu hyväksytään automaattisesti eikä sähköpostia lähetetä.

Poista verkkotunnuskutsu

DELETE /v1/domains/:domain_name/invites

Kehon parametri Pakollinen Tyyppi Kuvaus
email Kyllä Merkkijono (sähköpostiosoite) Verkkotunnuksen jäsenluettelosta poistettava sähköpostiosoite

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

Kehon parametri Pakollinen Tyyppi Kuvaus
group Kyllä Merkkijono (luetteloitava) Ryhmä, johon käyttäjä päivitetään verkkotunnusjäsenyydeksi (voi olla joko "admin" tai "user")

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 aliassalasana

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

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

Kehon parametri Pakollinen Tyyppi Kuvaus
new_password Ei Jousi Uusi mukautettu salasanasi aliasta varten. Huomaa, että voit jättää tämän tyhjäksi tai puuttua kokonaan API-pyyntösi rungosta, jos haluat satunnaisesti luodun ja vahvan salasanan.
password Ei Jousi Aliaksen nykyinen salasana, jos haluat vaihtaa salasanan poistamatta olemassa olevaa IMAP-postilaatikon tallennustilaa (katso is_override -vaihtoehto alla, jos sinulla ei enää ole nykyistä salasanaa).
is_override Ei Totuusarvo KÄYTÄ VAROVASTI: Tämä ohittaa olemassa olevan aliaksen salasanan ja tietokannan kokonaan ja poistaa pysyvästi olemassa olevan IMAP-tallennustilan ja nollaa aliaksen SQLite-sähköpostitietokannan kokonaan. Tee varmuuskopio, jos mahdollista, jos sinulla on olemassa oleva postilaatikko liitettynä tähän aliakseen.
emailed_instructions Ei Jousi Sähköpostiosoite, johon lähetetään aliaksen salasana ja asennusohjeet.

Esimerkkipyyntö:

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

Listaa verkkotunnusaliakset

Note

  1. marraskuuta 2024 alkaen Listaa verkkotunnukset:n ja Listaa verkkotunnusaliakset:n API-päätepisteiden oletusarvo on 1000, jonka enimmäistulosmäärä sivua kohden on TEMP_PLACEHOLDER. Jos haluat ottaa tämän käyttöön jo aiemmin, voit välittää ?paginate=true:n lisäkyselymerkkijonoparametrina päätepistekyselyn URL-osoitteeseen. Lisätietoja on kohdassa Sivunumerointi.

GET /v1/domains/example.com/aliases

Kyselymerkkijonojen parametrit Pakollinen Tyyppi Kuvaus
q Ei Merkkijono (Regulaarilauseke tuettu) Hae aliaksia verkkotunnuksesta nimen, tunnisteen tai vastaanottajan perusteella
name Ei Merkkijono (Regulaarilauseke tuettu) Hae aliaksia verkkotunnuksesta nimen perusteella
recipient Ei Merkkijono (Regulaarilauseke tuettu) Etsi aliaksia verkkotunnuksesta vastaanottajan mukaan
sort Ei Jousi Lajittele tietyn kentän mukaan (lisää etuliite yhdellä yhdysmerkillä - lajitellaksesi kentän käänteiseen suuntaan). Oletusarvo on created_at, jos sitä ei ole asetettu.
page Ei Määrä Katso lisätietoja osoitteesta Pagination
limit Ei Määrä Katso lisätietoja osoitteesta Pagination

Esimerkkipyyntö:

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

Luo uusi verkkotunnusalias

POST /v1/domains/example.com/aliases

Kehon parametri Pakollinen Tyyppi Kuvaus
name Ei Jousi Alias-nimi (jos sitä ei anneta tai jos se on tyhjä, luodaan satunnainen alias)
recipients Ei Merkkijono tai taulukko Vastaanottajien luettelo (erottelema rivinvaihdolla/välilyönnillä/pilkulla merkkijono tai taulukko, joka sisältää kelvollisia sähköpostiosoitteita, täysin hyväksyttyjä verkkotunnuksia ("FQDN"), IP-osoitteita ja/tai webhook-URL-osoitteita – jos niitä ei ole annettu tai taulukko on tyhjä, API-pyynnön tehneen käyttäjän sähköpostiosoite asetetaan vastaanottajaksi)
description Ei Jousi Alias-kuvaus
labels Ei Merkkijono tai taulukko Tunnisteiden luettelo (erotettava rivinvaihdolla/välilyönnillä/pilkulla merkkijono tai taulukko)
has_recipient_verification Ei Totuusarvo Vaadi vastaanottajia napsauttamaan sähköpostiosoitteen vahvistuslinkkiä, jotta sähköpostit kulkevat eteenpäin (oletuksena käytetään verkkotunnuksen asetuksia, jos niitä ei ole erikseen määritetty pyynnön rungossa)
is_enabled Ei Totuusarvo Otetaanko tämä alias käyttöön vai poistetaanko se käytöstä (jos poistettu käytöstä, sähköpostit reititetään mihinkään, mutta ne palauttavat onnistumisen tilakoodit). Jos arvo annetaan, se muunnetaan totuusarvoksi käyttämällä boolean)
error_code_if_disabled Ei Numero (joko 250, 421 tai 550) Tälle aliakselle saapuvat sähköpostit hylätään, jos is_enabled on false ja siinä on joko 250 (ei toimita hiljaisesti minnekään, esim. mustaan aukkoon tai /dev/null), 421 (pehmeä hylkäys; ja uudelleenyritys jopa ~5 päivän ajan) tai 550 pysyvä epäonnistuminen ja hylkäys. Oletusarvo on 250.
has_imap Ei Totuusarvo Otetaanko IMAP-tallennus käyttöön vai poistetaanko se käytöstä tälle aliakselle (jos se ei ole käytössä, saapuvia sähköposteja ei tallenneta soluun IMAP storage. Jos arvo annetaan, se muunnetaan totuusarvoksi käyttämällä solua boolean)
has_pgp Ei Totuusarvo Otetaanko käyttöön vai poistetaanko käytöstä OpenPGP encryption solulle IMAP/POP3/CalDAV/CardDAV encrypted email storage käyttäen aliasta public_key.
public_key Ei Jousi OpenPGP:n julkinen avain ASCII Armor -muodossa (click here to view an example; esim. GPG-avain solulle support@forwardemail.net). Tämä pätee vain, jos has_pgp on asetettu arvoon true. Learn more about end-to-end encryption in our FAQ.
max_quota Ei Jousi Tämän aliaksen tallennuskiintiön enimmäismäärä. Jätä tyhjäksi palauttaaksesi verkkotunnuksen nykyisen enimmäiskiintiön tai anna arvo, kuten "1 Gt", jonka bytes jäsentää. Vain verkkotunnuksen järjestelmänvalvojat voivat muuttaa tätä arvoa.
vacation_responder_is_enabled Ei Totuusarvo Otetaanko automaattinen lomaviesti käyttöön vai poistetaanko se käytöstä.
vacation_responder_start_date Ei Jousi Lomaviestin aloituspäivämäärä (jos käytössä eikä aloituspäivämäärää ole asetettu, oletetaan, että se on jo käynnistetty). Tuemme päivämäärämuotoja, kuten MM/DD/YYYY, YYYY-MM-DD ja muita päivämäärämuotoja älykkään jäsentämisen avulla käyttäen dayjs.
vacation_responder_end_date Ei Jousi Lomaviestin päättymispäivämäärä (jos käytössä eikä päättymispäivämäärää ole asetettu, oletetaan, että viesti ei lopu koskaan ja että se vastaa ikuisesti). Tuemme päivämäärämuotoja, kuten MM/DD/YYYY, YYYY-MM-DD ja muita päivämäärämuotoja älykkään jäsentämisen avulla käyttäen dayjs.
vacation_responder_subject Ei Jousi Lomaviestin aihe selkokielisenä, esim. "Poissa toimistolta". Käytämme striptags poistaaksemme kaiken HTML-koodin täältä.
vacation_responder_message Ei Jousi Lomavastaajalle tarkoitettu selkokielinen viesti, esim. "Olen poissa toimistolta helmikuuhun asti.". Käytämme striptags poistaaksemme kaiken HTML:n täältä.

Esimerkkipyyntö:

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

Hae verkkotunnuksen alias

Voit hakea verkkotunnusaliaksen joko sen id- tai name-arvon perusteella.

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

Kehon parametri Pakollinen Tyyppi Kuvaus
name Ei Jousi Alias-nimi
recipients Ei Merkkijono tai taulukko Vastaanottajien luettelo (erotettava rivinvaihdolla/välilyönnillä/pilkulla merkkijono tai taulukko kelvollisista sähköpostiosoitteista, täysin kelvollisista verkkotunnuksista ("FQDN"), IP-osoitteista ja/tai webhook-URL-osoitteista)
description Ei Jousi Alias-kuvaus
labels Ei Merkkijono tai taulukko Tunnisteiden luettelo (erotettava rivinvaihdolla/välilyönnillä/pilkulla merkkijono tai taulukko)
has_recipient_verification Ei Totuusarvo Vaadi vastaanottajia napsauttamaan sähköpostiosoitteen vahvistuslinkkiä, jotta sähköpostit kulkevat eteenpäin (oletuksena käytetään verkkotunnuksen asetuksia, jos niitä ei ole erikseen määritetty pyynnön rungossa)
is_enabled Ei Totuusarvo Otetaanko tämä alias käyttöön vai poistetaanko se käytöstä (jos poistettu käytöstä, sähköpostit reititetään mihinkään, mutta ne palauttavat onnistumisen tilakoodit). Jos arvo annetaan, se muunnetaan totuusarvoksi käyttämällä boolean)
error_code_if_disabled Ei Numero (joko 250, 421 tai 550) Tälle aliakselle saapuvat sähköpostit hylätään, jos is_enabled on false ja siinä on joko 250 (ei toimita hiljaisesti minnekään, esim. mustaan aukkoon tai /dev/null), 421 (pehmeä hylkäys; ja uudelleenyritys jopa ~5 päivän ajan) tai 550 pysyvä epäonnistuminen ja hylkäys. Oletusarvo on 250.
has_imap Ei Totuusarvo Otetaanko IMAP-tallennus käyttöön vai poistetaanko se käytöstä tälle aliakselle (jos se ei ole käytössä, saapuvia sähköposteja ei tallenneta soluun IMAP storage. Jos arvo annetaan, se muunnetaan totuusarvoksi käyttämällä solua boolean)
has_pgp Ei Totuusarvo Otetaanko käyttöön vai poistetaanko käytöstä OpenPGP encryption solulle IMAP/POP3/CalDAV/CardDAV encrypted email storage käyttäen aliasta public_key.
public_key Ei Jousi OpenPGP:n julkinen avain ASCII Armor -muodossa (click here to view an example; esim. GPG-avain solulle support@forwardemail.net). Tämä pätee vain, jos has_pgp on asetettu arvoon true. Learn more about end-to-end encryption in our FAQ.
max_quota Ei Jousi Tämän aliaksen tallennuskiintiön enimmäismäärä. Jätä tyhjäksi palauttaaksesi verkkotunnuksen nykyisen enimmäiskiintiön tai anna arvo, kuten "1 Gt", jonka bytes jäsentää. Vain verkkotunnuksen järjestelmänvalvojat voivat muuttaa tätä arvoa.
vacation_responder_is_enabled Ei Totuusarvo Otetaanko automaattinen lomaviesti käyttöön vai poistetaanko se käytöstä.
vacation_responder_start_date Ei Jousi Lomaviestin aloituspäivämäärä (jos käytössä eikä aloituspäivämäärää ole asetettu, oletetaan, että se on jo käynnistetty). Tuemme päivämäärämuotoja, kuten MM/DD/YYYY, YYYY-MM-DD ja muita päivämäärämuotoja älykkään jäsentämisen avulla käyttäen dayjs.
vacation_responder_end_date Ei Jousi Lomaviestin päättymispäivämäärä (jos käytössä eikä päättymispäivämäärää ole asetettu, oletetaan, että viesti ei lopu koskaan ja että se vastaa ikuisesti). Tuemme päivämäärämuotoja, kuten MM/DD/YYYY, YYYY-MM-DD ja muita päivämäärämuotoja älykkään jäsentämisen avulla käyttäen dayjs.
vacation_responder_subject Ei Jousi Lomaviestin aihe selkokielisenä, esim. "Poissa toimistolta". Käytämme striptags poistaaksemme kaiken HTML-koodin täältä.
vacation_responder_message Ei Jousi Lomavastaajalle tarkoitettu selkokielinen viesti, esim. "Olen poissa toimistolta helmikuuhun asti.". Käytämme striptags poistaaksemme kaiken HTML:n täältä.

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:

Voit salata tietueita jopa ilmaisversiossa täysin ilmaiseksi. Yksityisyyden ei pitäisi olla ominaisuus, vaan sen tulisi olla sisäänrakennettu osa kaikkia tuotteen ominaisuuksia. Olemme lisänneet tämän Tietosuojaoppaiden keskustelu- ja GitHub-ongelmamme-versioissa esitettyjen pyyntöjen mukaisesti.

Salaa TXT-tietue

POST /v1/encrypt

Kehon parametri Pakollinen Tyyppi Kuvaus
input Kyllä Jousi Mikä tahansa kelvollinen välityssähköpostin selkotekstitiedosto

Esimerkkipyyntö:

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