E-mail API

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.

A jelenlegi HTTP-alapú URI-útvonal a következő: https://api.forwardemail.net.

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.

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

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.

Ha szeretne értesítést kapni, amikor elérhető az oldalszámozás, kérjük, írjon e-mailt api@forwardemail.net.

Naplók lekérése

API-nk programozottan lehetővé teszi fiókja naplóinak letöltését. Ha kérelmet nyújt be erre a végpontra, akkor a rendszer feldolgozza a fiókjához tartozó összes naplót, és mellékletként elküldi azokat Önnek (Gzip összenyomva CSV táblázatfájl) befejezése után.

Ez lehetővé teszi háttérmunkák létrehozását a Cron munka vagy használja a mi Node.js munkaütemező szoftver, Bree naplókat fogadni, amikor csak akarja. Vegye figyelembe, hogy ez a végpont erre korlátozódik 10 kérések naponta.

A melléklet a kisbetűs formája email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz maga az e-mail pedig egy rövid összefoglalót tartalmaz a visszakeresett naplókról. A naplókat bármikor letöltheti a webhelyről Saját fiók → Naplók

GET /v1/logs/download

Példakérés:

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

Példa Cron munkára (minden nap éjfélkor):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Vegye figyelembe, hogy olyan szolgáltatásokat használhat, mint pl Crontab.guru a cron job kifejezés szintaxisának érvényesítéséhez.

Példa Cron munkára (minden nap éjfélkor és az előző napi naplókkal):

MacOS esetén:

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

Linux és Ubuntu esetén:

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

Fiók létrehozása

POST /v1/account

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

Példakérés:

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

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

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

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 felsorolása

GET /v1/domains

Példakérés:

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

Hozzon létre tartományt

POST /v1/domains

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

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:

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

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

Példakérés:

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

Frissítse a domain tagot

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

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:

Domain álnevek listázása

GET /v1/domains/example.com/aliases

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

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

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: