E-mail API

Jelenleg még nem adtunk ki API-csomagolókat, de a közeljövőben tervezzük, hogy megteszünk egyet. Küldjön egy e-mailt a api@forwardemail.net címre, ha értesítést szeretne kapni egy adott programozási nyelv API-csomagolójának kiadásáról. Addig is használhatja ezeket az ajánlott HTTP-kéréskönyvtárakat az alkalmazásában, vagy egyszerűen használhatja a becsavar függvényt az alábbi példák szerint.

A jelenlegi HTTP alap URI elérési út: https://api.forwardemail.net.

Minden végponthoz a API-kulcs paramétert kell a kérés Alapszintű engedélyezés fejlécének „username” értékeként beállítani (a Alias-kapcsolatok, Alias naptárak és Alias postaládák kivételével, amelyek generált alias felhasználónév és jelszó paramétert használnak).

Ne aggódj – ha nem vagy biztos benne, hogy miről is van szó, alább láthatsz néhány példát.

Ha bármilyen hiba történik, az API-kérés válaszának tö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érést kezdeményező felhasználó által utoljára észlelt területi beállításra van lefordítva. Ezt felülbírálhatja egy egyéni Accept-Language fejléc megadásával. Nyugodtan próbálja ki a lap alján található nyelvi legördülő menü segítségével.

A lapozást minden olyan API-végpont támogatja, amely listázza az eredményeket.

Egyszerűen adja meg a page (és opcionálisan a limit) lekérdezési karakterlánc tulajdonságait.

A page tulajdonságnak a 1 tulajdonságnál nagyobb vagy azzal egyenlő számnak kell lennie. Ha megadja a limit tulajdonságot (ami szintén egy szám), akkor a minimális érték 10, a maximális pedig 50 (kivéve, ha másképp van feltüntetve).

Annak megállapításához, hogy elérhetők-e további találatok, ezeket a HTTP válaszfejléceket biztosítjuk (amelyeket programozottan elemezhet a lapozáshoz):

Példa kérés:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Naplók lekérése

API-nk programozott módon lehetővé teszi fiókod naplóinak letöltését. Ha erre a végpontra küldesz egy kérést, a rendszer feldolgozza a fiókod összes naplóját, és a folyamat befejezése után mellékletként (Gzip tömörített CSV táblázatfájl) elküldi neked e-mailben.

Ez lehetővé teszi háttérfeladatok létrehozását Cron-feladat segítségével, vagy a Node.js munkaütemező szoftver Bree használatával naplókat fogadhat, amikor csak szeretné. Vegye figyelembe, hogy ez a végpont napi 10 kérésre korlátozódik.

A melléklet a email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz kisbetűs alakja, és maga az e-mail tartalmazza a lekért naplók rövid összefoglalását. A naplókat bármikor letöltheti a Fiókom → Naplók oldalról.

GET /v1/logs/download

Példa kérés:

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

Példa Cron feladatra (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 is használhat, mint a Crontab.guru, a cron feladatkifejezés szintaxisának érvényesítéséhez.

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

MacOS rendszeren:

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élda kérés:

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

Fiók lekérése

GET /v1/account

Példa kérés:

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

Fiók frissítése

PUT /v1/account

Példa kérés:

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

Kapcsolatok listázása

GET /v1/contacts

Hamarosan

Kapcsolat létrehozása

POST /v1/contacts

Hamarosan

Kapcsolat lekérése

GET /v1/contacts/:id

Hamarosan

Kapcsolattartó frissítése

PUT /v1/contacts/:id

Hamarosan

Kapcsolat törlése

DELETE /v1/contacts/:id

Hamarosan

Naptárak listázása

GET /v1/calendars

Hamarosan

Naptár létrehozása

POST /v1/calendars

Hamarosan

Naptár lekérése

GET /v1/calendars/:id

Hamarosan

Naptár frissítése

PUT /v1/calendars/:id

Hamarosan

Naptár törlése

DELETE /v1/calendars/:id

Hamarosan

Kérjük, győződjön meg róla, hogy követte a domain beállítására vonatkozó utasításokat.

Ezek az utasítások a GYIK részben találhatók: Támogatja az IMAP-on keresztüli e-mail fogadást?.

Üzenetek listázása és keresése

GET /v1/messages

Hamarosan

Üzenet létrehozása

POST /v1/messages

Hamarosan

Üzenet lekérése

GET /v1/messages/:id

Hamarosan

Üzenet frissítése

PUT /v1/messages/:id

Hamarosan

Üzenet törlése

DELETE /v1/messages:id

Hamarosan

Mappák listázása

GET /v1/folders

Hamarosan

Mappa létrehozása

POST /v1/folders

Hamarosan

Mappa lekérése

GET /v1/folders/:id

Hamarosan

Frissítési mappa

PUT /v1/folders/:id

Hamarosan

Mappa törlése

DELETE /v1/folders/:id

Hamarosan

Mappa másolása

POST /v1/folders/:id/copy

Hamarosan

Kérjük, győződjön meg róla, hogy követte a domain beállítására vonatkozó utasításokat.

Ezek az utasítások a Fiókom → Domainek → Beállítások → Kimenő SMTP konfiguráció címen találhatók. Gondoskodnia kell a DKIM, a Return-Path és a DMARC beállításáról a kimenő SMTP-üzenetek domainnel történő küldéséhez.

Kimenő SMTP e-mail korlát lekérése

Ez egy egyszerű végpont, amely egy JSON objektumot ad vissza, amely a count és limit értékeket tartalmazza a napi SMTP kimenő üzenetek számára vonatkozóan fiókonként.

GET /v1/emails/limit

Példa kérés:

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

Kimenő SMTP e-mailek listázása

Vegye figyelembe, hogy ez a végpont nem ad vissza tulajdonságértékeket az e-mailek message, headers és rejectedErrors tulajdonságaihoz.

Ezen tulajdonságok és értékük visszaadásához kérjük, használja a E-mail lekérése végpontot egy e-mail azonosítóval.

GET /v1/emails

Példa kérés:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Kimenő SMTP e-mail létrehozása

Az e-mailek létrehozására szolgáló API-nkat a Nodemailer üzenetküldési beállításainak konfigurációja ihlette és azt használja ki. Kérjük, az összes alábbi törzsparaméter esetében a Nodemailer üzenetkonfiguráció paramétert használja.

Vegye figyelembe, hogy a envelope és dkim kivételével (mivel ezeket automatikusan beállítjuk), az összes Nodemailer opciót támogatjuk. Biztonsági okokból a disableFileAccess és disableUrlAccess opciókat automatikusan true értékre állítjuk.

Vagy a raw egyetlen opcióját kell átadnod a nyers, teljes e-maileddel, beleértve a fejléceket is, vagy az alábbi, különálló törzsparaméter-opciókat kell megadnod.

Ez az API végpont automatikusan kódolja az emojikat, ha megtalálhatók a fejlécekben (pl. a Subject: 🤓 Hello tárgysor automatikusan Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello-re konvertálódik). Célunk egy rendkívül fejlesztőbarát és becsapásbiztos e-mail API létrehozása volt.

POST /v1/emails

Példa ké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élda kérés:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Kimenő SMTP e-mail lekérése

GET /v1/emails/:id

Példa kérés:

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

Kimenő SMTP e-mail törlése

Az e-mail törlése akkor és csak akkor állítja be az állapotot "rejected" értékre (és ezt követően nem dolgozza fel a sorban), ha az aktuális állapot a "pending", "queued" vagy "deferred" egyike. Az e-maileket a létrehozásuk és/vagy elküldésük után 30 nappal automatikusan törölhetjük – ezért érdemes a kimenő SMTP e-mailekről másolatot tartani a kliensben, az adatbázisban vagy az alkalmazásban. Szükség esetén hivatkozhat az adatbázisban található e-mail azonosító értékünkre – ezt az értéket mind a E-mail létrehozása, mind a E-mail lekérése végpont visszaadja.

DELETE /v1/emails/:id

Példa kérés:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Domainek listázása

GET /v1/domains

Példa kérés:

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

Tartomány létrehozása

POST /v1/domains

Példa kérés:

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

Domain lekérése

GET /v1/domains/example.com

Példa kérés:

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

Domainrekordok ellenőrzése

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

Példa kérés:

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

Domain SMTP-rekordok ellenőrzése

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

Példa kérés:

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

Domain szintű, mindent lefedő jelszavak listája

GET /v1/domains/example.com/catch-all-passwords

Példa kérés:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Hozzon létre egy domain szintű, mindent lefedő jelszót

POST /v1/domains/example.com/catch-all-passwords

Példa kérés:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Domain szintű, mindent lefedő jelszó eltávolítása

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Példa kérés:

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

Tartomány frissítése

PUT /v1/domains/example.com

Példa ké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élda kérés:

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

Domain meghívó elfogadása

GET /v1/domains/:domain_name/invites

Példa kérés:

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

Domain meghívó létrehozása

POST /v1/domains/example.com/invites

Példa ké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

Domain meghívó eltávolítása

DELETE /v1/domains/:domain_name/invites

Példa kérés:

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

Tartománytag frissítése

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

Példa kérés:

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

Tartománytag eltávolítása

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

Példa kérés:

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

Alias jelszó létrehozása

Vegye figyelembe, hogy ha nem küld e-mailben utasításokat, akkor a felhasználónév és a jelszó a sikeres kérés JSON-választörzsében lesz { username: 'alias@yourdomain.com', password: 'some-generated-password' } formátumban.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Példa kérés:

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

Domainaliasok listázása

GET /v1/domains/example.com/aliases

Példa kérés:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Új domainalias létrehozása

POST /v1/domains/example.com/aliases

Példa kérés:

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

Domainalias lekérése

Egy domain aliast a id vagy a name értéke alapján kérhet le.

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

Példa ké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élda kérés:

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

Domainalias frissítése

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

Példa kérés:

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

Domainalias törlése

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

Példa kérés:

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

Lehetővé tesszük a rekordok ingyenes titkosítását még az ingyenes csomagban is. Az adatvédelemnek nem szabadna funkciónak lennie, hanem a termék minden aspektusába beépítettnek. Ahogy azt a Adatvédelmi útmutatók megbeszélése és a GitHub-problémáink csomagokban is erősen kérték, ezt hozzáadtuk.

TXT rekord titkosítása

POST /v1/encrypt

Példa kérés:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"