Email Forwarding 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 mitään API-kääreitä, mutta aiomme tehdä sen lähitulevaisuudessa. Lähetä sähköposti osoitteeseenapi@forwardemail.net jos haluat ilmoituksen, kun tietyn ohjelmointikielen API-kääre vapautetaan. Sillä välin voit käyttää näitä suositeltuja HTTP-pyyntökirjastoja sovelluksessasi tai käyttää yksinkertaisestikiemura kuten alla olevissa esimerkeissä.

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

Perus-URI

Nykyinen HTTP-perus-URI-polku on:https://api.forwardemail.net. Aiempi HTTP-pohjainen URI-polkuhttps://forwardemail.net:4000 on poistettu käytöstä 1. tammikuuta 2021.

Todennus

Kaikki päätepisteet vaativat sinunAPI key to be set as the "username" value of the request's Peruslupa otsikko. Älä huoli - alla on sinulle esimerkkejä, 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 käännetään yli 25 eri kielelle. Kaikki API-vastausviestit käännetään API-pyynnön esittäneen käyttäjän viimeksi havaitulle kielelle. Voit ohittaa tämän välittämällä mukautetunAccept-Language otsikko. Voit kokeilla sitä vapaasti tämän sivun alaosassa olevalla avattavalla kielellä.

Sivunumerointi

Jos haluat ilmoituksen, kun sivutus on käytettävissä, lähetä sähköpostiaapi@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 (on oltava"free","enhanced_protection"tai"team", oletuksena"free" or the user's current paid plan if on one)
catchall	Ei	Merkkijono (erotetut sähköpostiosoitteet) tai Boolean	Luo oletusarvoinen allias, oletuksenatrue (jostrue se käyttää API-käyttäjän sähköpostiosoitetta vastaanottajana ja josfalse kaikkia ei luoda. Jos merkkijono välitetään, se on erotettu luettelo sähköpostiosoitteista, joita käytetään vastaanottajina (erotettu rivinvaihdolla, välilyönnillä ja / tai pilkulla)
has_adult_content_protection	Ei	Boolen	Whether to enable Spam Scanner adult content protection on this domain
has_phishing_protection	Ei	Boolen	Whether to enable Spam Scanner phishing protection on this domain
has_executable_protection	Ei	Boolen	Whether to enable Spam Scanner executable protection on this domain
has_virus_protection	Ei	Boolen	Whether to enable Spam Scanner virus protection on this domain
has_recipient_verification	Ei	Boolen	Global domain default for whether to require alias recipients to click an email verification link for emails to flow through

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	Whether to enable Spam Scanner adult content protection on this domain
has_phishing_protection	Ei	Boolen	Whether to enable Spam Scanner phishing protection on this domain
has_executable_protection	Ei	Boolen	Whether to enable Spam Scanner executable protection on this domain
has_virus_protection	Ei	Boolen	Whether to enable Spam Scanner virus protection on this domain
has_recipient_verification	Ei	Boolen	Global domain default for whether to require alias recipients to click an email verification link for emails to flow through

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ä, jolla käyttäjä lisätään verkkotunnusjä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ää käyttäjän verkkotunnuksen jäseneksi (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	Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body)
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 perusteellaid tai senname 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	Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body)
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: