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 (kivéve Alias Kapcsolatok, Alias naptárak, és Alias postafiókok amelyek a generált alias felhasználónév és jelszó)..

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.

NOTE: 2024. november 1-től az API-végpontok a következőhöz: Domainek felsorolása és Domain álnevek listázása alapértelmezett lesz 1000 oldalanként max. Ha korábban szeretne feliratkozni erre a viselkedésre, átadhatja ?paginate=true kiegészítő lekérdezési karakterlánc-paraméterként a végpont-lekérdezés URL-jéhez.

A lapozást az eredményeket listázó összes API-végpont támogatja.

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

Az ingatlan page nagyobbnak vagy egyenlőnek kell lennie, mint 1. Ha biztosítod limit (szintén egy szám), akkor a minimális érték 10 és maximum az 50 (hacsak nincs másképp jelezve).

Annak megállapítására, hogy elérhető-e több eredmény, a következő HTTP-válaszfejléceket biztosítjuk (amelyeket elemezhet a programozott oldalszámozáshoz):

Példaké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 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"

NOTE: Más API-végpontokkal ellentétben ezek megkövetelik Hitelesítés A "felhasználónév" megegyezik az alias felhasználónévvel és a "password" egyenlő az álnéven generált jelszóval Basic Authorization fejlécként.

WIP: Ez a végpontszakasz folyamatban van, és (remélhetőleg) 2024-ben fog megjelenni. Addig is, kérjük, használjon IMAP-klienst a webhelyünk navigációs részének „Alkalmazások” legördülő menüjében.

NOTE: A CardDAV-támogatás még nem érhető el. A frissítésekért kövesse ezt a vitát a GitHubon.

Névjegyek listázása

GET /v1/contacts

Hamarosan

Kapcsolat létrehozása

POST /v1/contacts

Hamarosan

Névjegy lekérése

GET /v1/contacts/:id

Hamarosan

Kapcsolattartó frissítése

PUT /v1/contacts/:id

Hamarosan

Névjegy törlése

DELETE /v1/contacts/:id

Hamarosan

NOTE: Más API-végpontokkal ellentétben ezek megkövetelik Hitelesítés A "felhasználónév" megegyezik az alias felhasználónévvel és a "password" egyenlő az álnéven generált jelszóval Basic Authorization fejlécként.

WIP: Ez a végpontszakasz folyamatban van, és (remélhetőleg) 2024-ben fog megjelenni. Addig is, kérjük, használjon IMAP-klienst a webhelyünk navigációs részének „Alkalmazások” legördülő menüjében.

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

NOTE: Más API-végpontokkal ellentétben ezek megkövetelik Hitelesítés A "felhasználónév" megegyezik az alias felhasználónévvel és a "password" egyenlő az álnéven generált jelszóval Basic Authorization fejlécként.

WIP: Ez a végpontszakasz folyamatban van, és (remélhetőleg) 2024-ben fog megjelenni. Addig is, kérjük, használjon IMAP-klienst a webhelyünk navigációs részének „Alkalmazások” legördülő menüjében.

Kérjük, győződjön meg arról, hogy követte a domain beállítási utasításait.

Ezeket az utasításokat a GYIK részben találja Támogatja az e-mailek fogadását az IMAP használatával?.

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

GET /v1/messages

Hamarosan

Üzenet létrehozása

NOTE: Ez lesz NOT e-mail küldése – ez csak egyszerűen hozzáadja az üzenetet a postafiók mappájához (pl. ez hasonló az IMAP-hez APPEND parancs). Ha szeretne e-mailt küldeni, nézze meg Hozzon létre kimenő SMTP e-mailt alatt. A kimenő SMTP e-mail létrehozása után tárolási célból hozzáfűzheti ennek a végpontnak a másolatát az alias postafiókjához.

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

WIP: Ez a végpontszakasz folyamatban van, és (remélhetőleg) 2024-ben fog megjelenni. Addig is, kérjük, használjon IMAP-klienst a webhelyünk navigációs részének „Alkalmazások” legördülő menüjében.

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

Mappa frissítése

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 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.

Kimenő SMTP e-mailek korlátja

Ez egy egyszerű végpont, amely a következőt tartalmazó JSON-objektumot ad vissza count és limit a napi SMTP kimenő üzenetek számára számlánként.

GET /v1/emails/limit

Példaké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 egy e-mailhez message, headers, sem rejectedErrors.

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.

GET /v1/emails

Példakérés:

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

Hozzon létre kimenő SMTP 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.

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

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`"

Kimenő SMTP e-mailek lekérése

GET /v1/emails/:id

Példaké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é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

NOTE: 2024. november 1-től az API-végpontok a következőhöz: Domainek felsorolása és Domain álnevek listázása alapértelmezett lesz 1000 oldalanként max. Ha korábban szeretne feliratkozni erre a viselkedésre, átadhatja ?paginate=true kiegészítő lekérdezési karakterlánc-paraméterként a végpont-lekérdezés URL-jéhez. Lásd Lapszámozás több betekintésért.

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:

Hozzon létre egy alias jelszót

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álasz törzsében lesz a következő formátumban: { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Példakérés:

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

Domain álnevek listázása

NOTE: 2024. november 1-től az API-végpontok a következőhöz: Domainek felsorolása és Domain álnevek listázása alapértelmezett lesz 1000 oldalanként max. Ha korábban szeretne feliratkozni erre a viselkedésre, átadhatja ?paginate=true kiegészítő lekérdezési karakterlánc-paraméterként a végpont-lekérdezés URL-jéhez. Lásd Lapszámozás több betekintésért.

GET /v1/domains/example.com/aliases

Példakérés:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -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:

Lehetővé tesszük a rekordok díjmentes titkosítását még az ingyenes csomagban is. Az adatvédelem nem lehet szolgáltatás, hanem magától értetődően be kell építeni a termék minden aspektusába. Ahogy nagyon kérték a Az adatvédelmi útmutatók megbeszélése és tovább GitHub-problémáink ezt adtuk hozzá.

TXT rekord titkosítása

POST /v1/encrypt

Példakérés:

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