- Keresés oldal
- Tartalomjegyzék
E-mail API
könyvtárak
Jelenleg még nem adtunk ki API-burkolókat, de a közeljövőben ezt tervezzük. Küldj e-mailt a címre api@forwardemail.net ha szeretne értesítést kapni egy adott programozási nyelv API burkolójának kiadásáról. Addig is használhatja ezeket az ajánlott HTTP-kérés-könyvtárakat az alkalmazásban, vagy egyszerűen csak becsavar 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 (karbantartók vagyunk) |
node.js | szuperügynök (karbantartók vagyunk) |
Megy | net / http |
.NET | RestSharp |
Alap URI
A jelenlegi HTTP-alapú URI-útvonal a következő: https://api.forwardemail.net
.
Hitelesítés
Minden végpont megköveteli az Ön API kulcs a kérés "felhasználónév" értékeként kell beállítani Alapvető 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 | OK |
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 különböző nyelvre van lefordítva. Minden API-válaszüzenet az API-kérelmet benyújtó felhasználó utoljára észlelt területi beállítására fordítja le. Ezt felülírhatja egy egyéni átadásával Accept-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, amikor elérhető az oldalszámozás, kérjük, írjon e-mailt api@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 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"
E-mailek
Kérjük, győződjön meg arról, hogy követte a domain beállítási utasításait. Ezek az utasítások a címen találhatók Saját fiók → Domain → Beállítások → Kimenő SMTP konfiguráció. Biztosítania kell a DKIM, a Return-Path és a DMARC beállítását a kimenő SMTP-küldéshez a domainnel.
E-mailek listázása
Vegye figyelembe, hogy ez a végpont nem ad vissza már létrehozott e-mailt message
, headers
, accepted
, sem rejectedErrors
tulajdonságait.
A tulajdonságok és értékük visszaadásához használja a E-mail lekérése végpont egy e-mail azonosítóval.
Ez a végpont legfeljebb visszatér 50
eredményeket egyszerre. Ha több oldalt szeretne lekérdezni, fűzze hozzá ?page=NUMBER
ahol NUMBER
egy egész szám, pl. ?page=1
.
GET /v1/emails
Querystring paraméter | Kívánt | típus | Leírás |
---|---|---|---|
q | Nem | Karakterlánc (RegExp támogatott) | E-mailek keresése metaadatok alapján |
domain | Nem | Karakterlánc (RegExp támogatott) | E-mailek keresése domain név alapján |
page | Nem | Szám | Oldal az eredmények visszaküldéséhez (alapértelmezett 1 ) |
`korlát | Nem | Szám | A visszaküldendő találatok száma oldalanként (alapértelmezett 50 – a max 50 és minimum az 10 ) |
Példakérés:
curl https://api.forwardemail.net/v1/emails \
-u API_TOKEN:
Hozzon létre e-mailt
Az e-mailek létrehozására szolgáló API-nkat a Nodemailer üzenetbeállítási beállításai ihlették, és kihasználják. Kérjük, halassza el a Nodemailer üzenetkonfiguráció az alábbi testparaméterekre.
Vegye figyelembe, hogy kivéve envelope
és dkim
(mivel ezeket automatikusan beállítjuk Önnek), támogatjuk a Nodemailer összes beállítását. Automatikusan beállítjuk disableFileAccess
és disableUrlAccess
lehetőségeket true
biztonsági okokból.
Vagy át kell adnia az egyetlen lehetőséget raw
teljes nyers e-mailjével, beleértve a fejléceket is vagy adja át az egyes testparaméter-beállításokat alább.
POST /v1/emails
Testparaméter | Kívánt | típus | Leírás |
---|---|---|---|
from | Nem | Karakterlánc (e-mail) | A feladó e-mail címe (a domain aliasaként kell léteznie). |
to | Nem | Karakterlánc vagy array | Vesszővel tagolt lista vagy címzettek tömbje a „Címzett” fejléchez. |
cc | Nem | Karakterlánc vagy array | Vesszővel tagolt lista vagy címzettek tömbje a „Másolat” fejléchez. |
bcc | Nem | Karakterlánc vagy array | Vesszővel tagolt lista vagy címzettek tömbje a „Titkos másolat” fejléchez. |
subject | Nem | Húr | Az e-mail tárgya. |
text | Nem | String vagy puffer | Az üzenet egyszerű szöveges változata. |
html | Nem | String vagy puffer | Az üzenet HTML-változata. |
attachments | Nem | Sor | Csatolási objektumok tömbje (lásd A Nodemailer közös mezői). |
sender | Nem | Húr | A „Feladó” fejléc e-mail címe (lásd A Nodemailer fejlettebb mezői). |
replyTo | Nem | Húr | A „Válasz” fejléc e-mail címe. |
inReplyTo | Nem | Húr | Az üzenet azonosítója, amelyre az üzenet válaszol. |
references | Nem | Karakterlánc vagy array | Szóközökkel elválasztott lista vagy üzenetazonosítók tömbje. |
attachDataUrls | Nem | logikai | Ha true majd megtér data: képeket az üzenet HTML-tartalmában a beágyazott mellékletekhez. |
watchHtml | Nem | Húr | Az üzenet Apple Watch-specifikus HTML-változata (a Nodemailer dokumentumok szerint, a legújabb óráknál nem kell ezt beállítani). |
amp | Nem | Húr | Az üzenet AMP4EMAIL specifikus HTML-verziója (lásd Nodemailer példa). |
icalEvent | Nem | Tárgy | Egy iCalendar esemény alternatív üzenettartalomként (lásd Nodemailer naptári eseményei). |
alternatives | Nem | Sor | Alternatív üzenettartalom tömbje (lásd A Nodemailer alternatív tartalma). |
encoding | Nem | Húr | A szöveg és a HTML karakterláncok kódolása (alapértelmezés szerint "utf-8" , de támogatja "hex" és "base64" kódolási értékek is). |
raw | Nem | String vagy puffer | Egyéni generált RFC822 formátumú üzenet (a Nodemailer által generált helyett – lásd A Nodemailer egyéni forrása). |
textEncoding | Nem | Húr | Olyan kódolás, amelyet szöveges értékekhez kell használni (vagy "quoted-printable" vagy "base64" ). Az alapértelmezett érték a legközelebbi észlelt érték (ASCII használat esetén "quoted-printable" ). |
priority | Nem | Húr | Az e-mail prioritási szintje (lehet "high" , "normal" (alapértelmezett), vagy "low" ). Vegye figyelembe, hogy a "normal" nem állít be prioritási fejlécet (ez az alapértelmezett viselkedés). Ha egy értéke "high" vagy "low" be van állítva, akkor a X-Priority , X-MSMail-Priority , és Importance fejlécek ennek megfelelően lesz beállítva. |
headers | Nem | Objektum vagy tömb | Beállítandó objektum vagy további fejlécmezők tömbje (lásd A Nodemailer egyéni fejlécei). |
messageId | Nem | Húr | Egy opcionális Message-ID érték a "Message-ID" fejléchez (alapértelmezett érték automatikusan létrejön, ha nincs beállítva – vegye figyelembe, hogy az értéket tartsa be az RFC2822 specifikációt). |
date | Nem | Karakterlánc vagy dátum | Egy opcionális dátumérték, amely akkor kerül felhasználásra, ha a Dátum fejléc hiányzik az elemzés után, ellenkező esetben az aktuális UTC karakterlánc kerül felhasználásra, ha nincs beállítva. A dátumfejléc nem lehet több 30 nappal az aktuális idő előtt. |
list | Nem | Tárgy | Opcionális tárgya List-* fejlécek (lásd Nodemailer listafejlécei). |
Példakérés:
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"
Példakérés:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "raw=`cat file.eml`"
E-mail lekérése
GET /v1/emails/:id
Példakérés:
curl https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
E-mail törlése
Az e-mail törlés az állapotot a következőre állítja be "rejected"
(és ezt követően ne dolgozza fel a sorban) akkor és csak akkor, ha az aktuális állapot az egyik "pending"
, "queued"
, vagy "deferred"
. Előfordulhat, hogy az e-maileket a létrehozásuk és/vagy elküldésük után 30 nappal automatikusan töröljük – ezért a kimenő SMTP e-mailek másolatát meg kell őriznie a kliensében, adatbázisában vagy alkalmazásában. Igény szerint hivatkozhat az e-mail azonosítónkra az adatbázisában – ezt az értéket mindkettő visszaadja Hozzon létre e-mailt és E-mail lekérése végpontok.
DELETE /v1/emails/:id
Példakérés:
curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Domainek
/v1/domains/:domain_name
mivel az útvonaluk felcserélhető egy domain azonosítójával :domain_id
. Ez azt jelenti, hogy bármelyikével hivatkozhat a domainre name
vagy id
érték.
Domainek felsorolása
GET /v1/domains
Querystring paraméter | Kívánt | típus | Leírás |
---|---|---|---|
q | Nem | Karakterlánc (RegExp támogatott) | Keressen domaineket név szerint |
name | Nem | Karakterlánc (RegExp támogatott) | Keressen domaineket név szerint |
Példakérés:
curl 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 gyűjtőálnevet, alapértelmezés szerint true (ha true az API felhasználó e-mail címét fogja használni címzettként, és ha false 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 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 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áshoz (alapértelmezett: "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 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 hozzáadhatja a domain tagsághoz (az egyik lehet "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, amely frissíti a felhasználót a domain tagságra a következővel (az egyik lehet "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 |
---|---|---|---|
q | Nem | Karakterlánc (RegExp támogatott) | Keressen aliasokat egy domainben név, címke vagy címzett alapján |
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 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 | Nem | Húr | Alias név (ha nincs megadva, vagy ha üres, akkor véletlenszerű álnév jön létre) |
recipients | Nem | Karakterlánc vagy array | A címzettek listája (sortörés/szóköz/vesszővel elválasztott karakterlánc vagy érvényes e-mail címek tömbje, teljesen minősített domain nevek ("FQDN"), IP-címek és/vagy webhook URL-ek – és ha nincs megadva, vagy üres Tömb, akkor az API-kérést küldő felhasználó e-mail címe lesz beállítva) |
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élyezze-e az álnév letiltását (ha le van tiltva, az e-mailek sehova sem kerülnek átirányításra, csak a sikeres állapotkódokat adják vissza). Alapértelmezés szerint true , de ha egy értéket adunk át, akkor a rendszer logikai értékké konvertálja a használatával logikai érték) |
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érheti id
vagy annak name
é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: