Sähköpostin edelleenlähetyksen API

Sisällysluettelo

• Kirjastot
• Perus-URI
• Todennus
• Virheet
• Lokalisointi
• Sivunumerointi
• Tili
  • Luo tili
  • Nouda tili
  • Päivitä tili
• Verkkotunnukset
  • Luettelo verkkotunnuksista
  • Luo verkkotunnus
  • Hae verkkotunnus
  • Vahvista verkkotunnustietueet
  • Päivitä verkkotunnus
  • Poista verkkotunnus
• Kutsuu
  • Hyväksy verkkotunnuksen kutsu
  • Luo verkkotunnuksen kutsu
  • Poista verkkotunnuksen kutsu
• Jäsenet
  • Päivitä verkkotunnuksen jäsen
  • Poista verkkotunnuksen jäsen
• Aliakset
  • Luettele verkkotunnuksen aliakset
  • Luo uusi verkkotunnuksen alias
  • Hae verkkotunnuksen alias
  • Päivitä verkkotunnuksen alias
  • Poista verkkotunnuksen alias

Kirjastot

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

Kieli	Kirjasto
Rubiini	Faraday
Python	pyynnöt
Java	OkHttp
PHP	ahmia
JavaScript	superagentti
Node.js	superagentti
Mennä	net / http
.NET	LepoTerävä

Perus-URI

Nykyinen HTTP-pohjainen URI-polku on: https://api.forwardemail.net. Vanha HTTP-pohjainen URI-polku: https://forwardemail.net:4000 on poistettu käytöstä 1.1.2021 alkaen.

Todennus

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.

Virheet

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

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

Lokalisointi

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.

Sivunumerointi

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

Tili

Luo tili

POST /v1/account

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Sähköpostiosoite
password	Joo	Merkkijono	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 -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Päivitä tili

PUT /v1/account

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

Esimerkkipyyntö:

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

Verkkotunnukset

Luettelo verkkotunnuksista

GET /v1/domains

Kyselymerkkiparametri	Edellytetään	Tyyppi	Kuvaus
name	Ei	Merkkijono (RegExp tuettu)	Hae verkkotunnuksia nimen mukaan
alias	Ei	Merkkijono (RegExp tuettu)	Hae verkkotunnuksia aliaksen nimen perusteella
recipient	Ei	Merkkijono (RegExp tuettu)	Hae verkkotunnuksia vastaanottajan mukaan

Esimerkkipyyntö:

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

Luo verkkotunnus

POST /v1/domains

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
domain	Joo	Merkkijono (FQDN tai IP)	Täysin hyväksytty verkkotunnus ("FQDN") tai IP-osoite
plan	Ei	Merkkijono (lueteltava)	Suunnitelman tyyppi (täytyy olla "free", "enhanced_protection", tai "team", oletuksena "free" tai käyttäjän nykyinen maksettu sopimus, jos sellainen)
catchall	Ei	Merkkijono (erotetut sähköpostiosoitteet) tai Boolean	Luo oletusarvoinen keräilyalias, oletuksena true (jos true se käyttää API-käyttäjän sähköpostiosoitetta vastaanottajana, ja jos false saalis-kaikkia ei luoda). Jos merkkijono välitetään, se on rajattu luettelo sähköpostiosoitteista, joita käytetään vastaanottajina (erottuna rivinvaihdolla, välilyönnillä ja/tai pilkulla).
has_adult_content_protection	Ei	Boolen	Otetaanko Spam Scannerin aikuisille suunnatun sisällön suojaus käyttöön tässä verkkotunnuksessa
has_phishing_protection	Ei	Boolen	Otetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protection	Ei	Boolen	Otetaanko Roskapostin skannerin suoritettavien tiedostojen suojaus käyttöön tässä verkkotunnuksessa
has_virus_protection	Ei	Boolen	Otetaanko Spam Scanner -virustorjunta käyttöön tässä verkkotunnuksessa
has_recipient_verification	Ei	Boolen	Maailmanlaajuisen verkkotunnuksen oletusarvo sille, vaaditaanko aliasten vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi

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 -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Vahvista verkkotunnustietueet

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

Esimerkkipyyntö:

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

Päivitä verkkotunnus

PUT /v1/domains/example.com

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
smtp_port	Ei	Merkkijono tai numero	Mukautettu portti SMTP-edelleenlähetystä varten (oletus on "25")
has_adult_content_protection	Ei	Boolen	Otetaanko Spam Scannerin aikuisille suunnatun sisällön suojaus käyttöön tässä verkkotunnuksessa
has_phishing_protection	Ei	Boolen	Otetaanko roskapostiskannerin tietojenkalastelusuoja käyttöön tässä verkkotunnuksessa
has_executable_protection	Ei	Boolen	Otetaanko Roskapostin skannerin suoritettavien tiedostojen suojaus käyttöön tässä verkkotunnuksessa
has_virus_protection	Ei	Boolen	Otetaanko Spam Scanner -virustorjunta käyttöön tässä verkkotunnuksessa
has_recipient_verification	Ei	Boolen	Maailmanlaajuisen verkkotunnuksen oletusarvo sille, vaaditaanko aliasten vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi

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:

Kutsuu

Hyväksy verkkotunnuksen kutsu

GET /v1/domains/:domain_name/invites

Esimerkkipyyntö:

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

Luo verkkotunnuksen kutsu

POST /v1/domains/example.com/invites

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Sähköpostiosoite, jota kutsutaan verkkotunnuksen jäsenluetteloon
group	Joo	Merkkijono (lueteltava)	Ryhmä, johon käyttäjä lisätään verkkotunnuksen jäsenyyteen (voi olla yksi "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

Poista verkkotunnuksen kutsu

DELETE /v1/domains/:domain_name/invites

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
email	Joo	Merkkijono (sähköposti)	Sähköpostiosoite, joka poistetaan verkkotunnuksen jäsenluettelosta

Esimerkkipyyntö:

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

Jäsenet

Päivitä verkkotunnuksen jäsen

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

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
group	Joo	Merkkijono (lueteltava)	Ryhmä päivittääksesi käyttäjän verkkotunnuksen jäsenyyteen (voi olla yksi "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:

Aliakset

Luettele verkkotunnuksen aliakset

GET /v1/domains/example.com/aliases

Kyselymerkkiparametri	Edellytetään	Tyyppi	Kuvaus
name	Ei	Merkkijono (RegExp tuettu)	Etsi aliaksia verkkotunnuksesta nimen perusteella
recipient	Ei	Merkkijono (RegExp tuettu)	Etsi aliaksia verkkotunnuksesta vastaanottajan mukaan

Esimerkkipyyntö:

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

Luo uusi verkkotunnuksen alias

POST /v1/domains/example.com/aliases

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
name	Joo	Merkkijono	Alias nimi
recipients	Joo	Merkkijono tai Array	Luettelo vastaanottajista (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisista sähköpostiosoitteista, täysin hyväksytyistä verkkotunnuksista ("FQDN"), IP-osoitteista ja / tai webhook-URL-osoitteista)
description	Ei	Merkkijono	Aliaksen kuvaus
labels	Ei	Merkkijono tai Array	Luettelo tarroista (täytyy olla rivinvaihto / välilyönti / pilkulla erotettu merkkijono tai taulukko)
has_recipient_verification	Ei	Boolen	Otetaanko käyttöön, vaaditaanko vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi (oletusarvo on verkkotunnuksen asetus, jos sitä ei ole erikseen määritetty pyynnön tekstiosassa)
is_enabled	Ei	Boolen	Otetaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköpostit reititetään mihinkään, mutta palauttavat onnistuneet tilakoodit)

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

Kehon parametri	Edellytetään	Tyyppi	Kuvaus
name	Ei	Merkkijono	Alias nimi
recipients	Joo	Merkkijono tai Array	Luettelo vastaanottajista (täytyy olla rivinvaihto / välilyönti / pilkuilla erotettu merkkijono tai taulukko kelvollisista sähköpostiosoitteista, täysin hyväksytyistä verkkotunnuksista ("FQDN"), IP-osoitteista ja / tai webhook-URL-osoitteista)
description	Ei	Merkkijono	Aliaksen kuvaus
labels	Ei	Merkkijono tai Array	Luettelo tarroista (täytyy olla rivinvaihto / välilyönti / pilkulla erotettu merkkijono tai taulukko)
has_recipient_verification	Ei	Boolen	Otetaanko käyttöön, vaaditaanko vastaanottajia napsauttamaan sähköpostin vahvistuslinkkiä, jotta sähköpostit kulkevat läpi (oletusarvo on verkkotunnuksen asetus, jos sitä ei ole erikseen määritetty pyynnön tekstiosassa)
is_enabled	Ei	Boolen	Otetaanko tämän aliaksen poistaminen käytöstä (jos se on poistettu käytöstä, sähköpostit reititetään mihinkään, mutta palauttavat onnistuneet tilakoodit)

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: