Szüksége van valós adatokkal és kulcsokkal rendelkező dokumentumokra?

Csak regisztráljon vagy jelentkezzen be, hogy az API kulcsokat és a valós számlaadatokat alább feltöltse.

Ön elfogadja adatvédelmi szabályzatunkat és feltételeinket .

Nem érdekel? Kattintson ide az olvasás folytatásához

Létrehozott egy API-t a domainek, álnevek és egyebekhez való programozási hozzáféréshez.

API dokumentáció

Programozott hozzáférés az Ön adataihoz

E-mail továbbítás API

Tartalomjegyzék

könyvtárak

Jelenleg még nem tettünk közzé egyetlen API-csomagolást sem, de azt tervezzük, hogy a közeljövőben megtesszük. Küldjön e-mailt aapi@forwardemail.net ha szeretne értesítést kapni egy adott programozási nyelv API-csomagolójának kiadásáról. Időközben használhatja ezeket az ajánlott HTTP kérési könyvtárakat az alkalmazásában, vagy egyszerűen csak használhatjabecsavar mint az alábbi példákban.

Nyelv Könyvtár
Rubin Faraday
Piton kérelmek
Jáva OkHttp
PHP zabál
JavaScript szuperügynök
node.js szuperügynök
Megy net / http
.HÁLÓ RestSharp

Alap URI

A jelenlegi HTTP alap URI elérési út:https://api.forwardemail.net. Az örökölt HTTP-alapú URI-útvonalhttps://forwardemail.net:4000 2021. január 1-jétől megszűnik.

Hitelesítés

Minden végpont megköveteli aAPI kulcs a kérés "felhasználónév" értékeként kell beállítaniAlapvető engedély fejléc. Ne aggódjon – az alábbiakban példákat mutatunk be, ha nem biztos benne, hogy mi ez.

hibák

Ha bármilyen hiba lép fel, az API kérés választörzse részletes hibaüzenetet tartalmaz.

Kód Név
200 rendben
400 Rossz kérés
401 jogtalan
403 Tiltott
404 Nem található
429 Túl sok kérés
500 Belső Szerverhiba
501 Nincs implementálva
502 Rossz átjáró
503 A szolgáltatás nem elérhető
504 Átjáró időkorlátja

Honosítás

Szolgáltatásunk több mint 25 nyelvre van lefordítva. Minden API-válaszüzenet az API-kérést benyújtó felhasználó utoljára észlelt területi beállítására fordítódik. Ezt felülírhatja egy egyéni átadásávalAccept-Language fejléc. Nyugodtan próbálja ki az oldal alján található nyelvi legördülő menü segítségével.

Lapszámozás

Ha szeretne értesítést kapni arról, hogy rendelkezésre áll oldal, akkor kérjük, írjon e-mailtapi@forwardemail.net.

számla

Fiók létrehozása

POST /v1/account

Testparaméter Kívánt típus Leírás
email Igen Karakterlánc (e-mail) Email cím
password Igen Húr Jelszó

Példakérés:

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

Fiók letöltése

GET /v1/account

Példakérés:

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

Fiók frissítése

PUT /v1/account

Testparaméter Kívánt típus Leírás
email Nem Karakterlánc (e-mail) Email cím
given_name Nem Húr Keresztnév
family_name Nem Húr Vezetéknév
avatar_url Nem Karakterlánc (URL) Link avatar képhez

Példakérés:

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

Domainek

Domainek felsorolása

GET /v1/domains

Querystring paraméter Kívánt típus Leírás
name Nem Karakterlánc (RegExp támogatott) Keressen domaineket név szerint
alias Nem Karakterlánc (RegExp támogatott) Keressen domaineket álnév alapján
recipient Nem Karakterlánc (RegExp támogatott) Keressen domaineket címzett szerint

Példakérés:

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

Hozzon létre tartományt

POST /v1/domains

Testparaméter Kívánt típus Leírás
domain Igen Karakterlánc (FQDN vagy IP) Teljesen minősített domain név ("FQDN") vagy IP cím
plan Nem Karakterlánc (számolható) Terv típusa (kell lennie"free","enhanced_protection"vagy"team", alapértelmezés szerint"free" vagy a felhasználó aktuális fizetett előfizetése, ha van ilyen)
catchall Nem Karakterlánc (elválasztott e-mail címek) vagy logikai Hozzon létre egy alapértelmezett összesített álnevet, alapértelmezés szerinttrue (hatrue az API felhasználó e-mail címét fogja használni címzettként, és hafalse nem jön létre összesítő). Ha egy karakterláncot adunk át, akkor ez a címzettként használandó e-mail címek elválasztott listája (sortöréssel, szóközzel és/vagy vesszővel elválasztva)
has_adult_content_protection Nem logikai Engedélyezze-e a Spam Scanner felnőtt tartalom védelmét ezen a domainen
has_phishing_protection Nem logikai Engedélyezze-e a Spam Scanner adathalász-védelmet ezen a tartományon
has_executable_protection Nem logikai Engedélyezze-e a Spam Scanner végrehajtható fájlvédelmét ezen a tartományon
has_virus_protection Nem logikai Engedélyezze-e a Spam Scanner vírusvédelmet ezen a tartományon
has_recipient_verification Nem logikai A globális domain alapértelmezett beállítása, hogy megköveteljék-e az alias címzetteket, hogy rákattintsák az e-mail-ellenőrző hivatkozásra az e-mailek áthaladásához

Példakérés:

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

Beolvasás domain

GET /v1/domains/example.com

Példakérés:

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

Ellenőrizze a domain rekordokat

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

Példakérés:

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

Frissítse a domaint

PUT /v1/domains/example.com

Testparaméter Kívánt típus Leírás
smtp_port Nem Karakterlánc vagy szám Egyéni port az SMTP továbbítás konfigurálásához (alapértelmezés:"25")
has_adult_content_protection Nem logikai Engedélyezze-e a Spam Scanner felnőtt tartalom védelmét ezen a domainen
has_phishing_protection Nem logikai Engedélyezze-e a Spam Scanner adathalász-védelmet ezen a tartományon
has_executable_protection Nem logikai Engedélyezze-e a Spam Scanner végrehajtható fájlvédelmét ezen a tartományon
has_virus_protection Nem logikai Engedélyezze-e a Spam Scanner vírusvédelmet ezen a tartományon
has_recipient_verification Nem logikai A globális domain alapértelmezett beállítása, hogy megköveteljék-e az alias címzetteket, hogy rákattintsák az e-mail-ellenőrző hivatkozásra az e-mailek áthaladásához

Példakérés:

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

Domain törlése

DELETE /v1/domains/:domain_name

Példakérés:

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

Meghívottak

Fogadja el a domain meghívást

GET /v1/domains/:domain_name/invites

Példakérés:

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

Hozzon létre domain meghívást

POST /v1/domains/example.com/invites

Testparaméter Kívánt típus Leírás
email Igen Karakterlánc (e-mail) E-mail cím, amelyet meghívhat a domain tagok listájára
group Igen Karakterlánc (számolható) Csoport, amellyel a felhasználót felveheti a domain tagságba a következővel (lehet az egyik:"admin" vagy"user")

Példakérés:

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

Távolítsa el a domain meghívást

DELETE /v1/domains/:domain_name/invites

Testparaméter Kívánt típus Leírás
email Igen Karakterlánc (e-mail) E-mail cím, amelyet el kell távolítani a domain tagok listájáról

Példakérés:

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

Belépés

Frissítse a domain tagot

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

Testparaméter Kívánt típus Leírás
group Igen Karakterlánc (számolható) Csoport, amellyel a felhasználót frissítheti a domain tagsággal a következővel (lehet az egyik:"admin" vagy"user")

Példakérés:

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

Távolítsa el a domain tagot

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

Példakérés:

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

Más nevek

Domain álnevek listázása

GET /v1/domains/example.com/aliases

Querystring paraméter Kívánt típus Leírás
name Nem Karakterlánc (RegExp támogatott) Keresse meg a domain álneveit név szerint
recipient Nem Karakterlánc (RegExp támogatott) Aliasok keresése egy tartományban címzett szerint

Példakérés:

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

Hozzon létre új domain álnevet

POST /v1/domains/example.com/aliases

Testparaméter Kívánt típus Leírás
name Igen Húr Fedőnév
recipients Igen Karakterlánc vagy array Címzettek listája (sor törés / szóköz / vesszővel elválasztott érvényes e-mail címek, teljesen minősített domain nevek ("FQDN"), IP címek és / vagy webhook URL-ek tömbjének vagy tömbének kell lennie)
description Nem Húr Álnév leírása
labels Nem Karakterlánc vagy array Címkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
has_recipient_verification Nem logikai Engedélyezni kell-e, hogy a címzettek egy e-mail-ellenőrző hivatkozásra kattintsanak az e-mailek áthaladásához (alapértelmezés a domain beállítása, ha nincs kifejezetten beállítva a kérés törzsében)
is_enabled Nem logikai Engedélyezi-e ennek az álnévnek a letiltását (ha le van tiltva, az e-mailek sehova nem kerülnek, de a sikeres állapotkódokat adja vissza)

Példakérés:

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

Domain alias lekérése

A domain aliast bármelyikével lekérhetiid vagy annakname érték.

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

Példakérés:

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

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

Példakérés:

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

Frissítse a domain álnevet

PUT /v1/domains/example.com/aliases/:alias_id

Testparaméter Kívánt típus Leírás
name Nem Húr Fedőnév
recipients Igen Karakterlánc vagy array Címzettek listája (sor törés / szóköz / vesszővel elválasztott érvényes e-mail címek, teljesen minősített domain nevek ("FQDN"), IP címek és / vagy webhook URL-ek tömbjének vagy tömbének kell lennie)
description Nem Húr Álnév leírása
labels Nem Karakterlánc vagy array Címkék listája (soroknak / szóköznek / vesszővel elválasztott karakterláncnak vagy tömbnek kell lennie)
has_recipient_verification Nem logikai Engedélyezni kell-e, hogy a címzettek egy e-mail-ellenőrző hivatkozásra kattintsanak az e-mailek áthaladásához (alapértelmezés a domain beállítása, ha nincs kifejezetten beállítva a kérés törzsében)
is_enabled Nem logikai Engedélyezi-e ennek az álnévnek a letiltását (ha le van tiltva, az e-mailek sehova nem kerülnek, de a sikeres állapotkódokat adja vissza)

Példakérés:

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

Törölje a domain álnevet

DELETE /v1/domains/:domain_name/aliases/:alias_id

Példakérés:

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