Email API

Jelenleg még nem adtunk ki API wrapper-eket, de a közeljövőben tervezzük ezt. Küldj egy e-mailt a api@forwardemail.net címre, ha értesítést szeretnél kapni, amikor egy adott programozási nyelv API wrapper-e megjelenik. Addig is használhatod ezeket az ajánlott HTTP kérés könyvtárakat az alkalmazásodban, vagy egyszerűen használd a curl parancsot az alábbi példák szerint.

A jelenlegi HTTP alap URI útvonal: https://fe.tiamati.email.

Minden végpont hitelesítést igényel Basic Authorization használatával. Két hitelesítési módszert támogatunk:

API Token hitelesítés (Ajánlott a legtöbb végponthoz)

Állítsd be az API kulcsodat "felhasználónév" értékként, üres jelszóval:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Figyeld meg a kettőspontot (:) az API token után – ez jelzi az üres jelszót Basic Auth formátumban.

Alias hitelesítés (Kimenő e-mailekhez)

A Kimenő SMTP e-mail létrehozása végpont támogatja az alias e-mail címed és egy generált alias jelszó használatával történő hitelesítést is:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Ez a módszer hasznos, ha olyan alkalmazásokból küldesz e-maileket, amelyek már SMTP hitelesítő adatokat használnak, és megkönnyíti az SMTP-ről az API-ra való átállást.

Csak alias végpontok

Az Alias Kapcsolatok, Alias Naptárak, Alias Üzenetek és Alias Mappák végpontok alias hitelesítést igényelnek, és nem támogatják az API tokenes hitelesítést.

Ne aggódj – lentebb példákat is találsz, ha nem vagy biztos benne, hogy ez mit jelent.

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 le van fordítva. Minden API válaszüzenet a kérés felhasználójának utoljára észlelt lokalizációjára van lefordítva. Ezt felülírhatod egy egyedi Accept-Language fejléc megadásával. Nyugodtan próbáld ki a nyelvválasztó legördülő menüjével ezen oldal alján.

Lapozás támogatott minden olyan API végponton, amely listáz eredményeket.

Egyszerűen add meg a lekérdezési paramétereket: page (és opcionálisan limit).

A page értékének 1-nél nagyobb vagy egyenlő számnak kell lennie. Ha megadod a limit értéket (szintén szám), akkor az érték minimuma 10, maximuma 50 (ha nincs másként jelezve).

Példa kérés:

curl https://fe.tiamati.email/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. Ennek a végpontnak a lekérése feldolgozza fiókja összes naplóját, és elküldi Önnek e-mailben csatolmányként (Gzip tömörített CSV táblázatfájl) a feldolgozás befejeztével.

Ez lehetővé teszi, hogy háttérfeladatokat hozzon létre egy Cron job segítségével vagy a mi Node.js ütemező szoftverünkkel, Bree, hogy bármikor megkapja a naplókat. Vegye figyelembe, hogy ez a végpont napi 10 lekérésre van korlátozva.

A csatolmány neve kisbetűs formában email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, és maga az e-mail tartalmaz egy rövid összefoglalót a lekért naplókról. Naplókat bármikor letölthet a Saját fiók → Naplók menüpontból is.

GET /v1/logs/download

Példa kérés:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

Példa Cron job (minden nap éjfélkor):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Vegye figyelembe, hogy használhat olyan szolgáltatásokat, mint a Crontab.guru, hogy ellenőrizze a cron kifejezés szintaxisát.

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

MacOS esetén:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/account \
  -u API_TOKEN:

Fiók frissítése

PUT /v1/account

Példa kérés:

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

Kapcsolatok listázása

GET /v1/contacts

Hamarosan elérhető

Kapcsolat létrehozása

POST /v1/contacts

Hamarosan elérhető

Kapcsolat lekérése

GET /v1/contacts/:id

Hamarosan elérhető

Kapcsolat frissítése

PUT /v1/contacts/:id

Hamarosan elérhető

Kapcsolat törlése

DELETE /v1/contacts/:id

Hamarosan elérhető

Naptárak listázása

GET /v1/calendars

Hamarosan elérhető

Naptár létrehozása

POST /v1/calendars

Hamarosan elérhető

Naptár lekérése

GET /v1/calendars/:id

Hamarosan elérhető

Naptár frissítése

PUT /v1/calendars/:id

Hamarosan elérhető

Naptár törlése

DELETE /v1/calendars/:id

Hamarosan elérhető

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

Ezek az utasítások megtalálhatók a GYIK szekciónkban Támogatják az IMAP-pal történő e-mail fogadást?.

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

GET /v1/messages

Hamarosan elérhető

Üzenet létrehozása

POST /v1/messages

Hamarosan elérhető

Üzenet lekérése

GET /v1/messages/:id

Hamarosan elérhető

Üzenet frissítése

PUT /v1/messages/:id

Hamarosan elérhető

Üzenet törlése

DELETE /v1/messages:id

Hamarosan elérhető

Mappák listázása

GET /v1/folders

Hamarosan elérhető

Mappa létrehozása

POST /v1/folders

Hamarosan elérhető

Mappa lekérése

GET /v1/folders/:id

Hamarosan elérhető

Mappa frissítése

PUT /v1/folders/:id

Hamarosan elérhető

Mappa törlése

DELETE /v1/folders/:id

Hamarosan elérhető

Mappa másolása

POST /v1/folders/:id/copy

Hamarosan elérhető

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

Ezek az utasítások megtalálhatók a Saját fiók → Domain-ek → Beállítások → Kimenő SMTP konfiguráció menüpont alatt. Biztosítania kell a DKIM, Return-Path és DMARC beállítását a domainhez tartozó kimenő SMTP küldéshez.

Kimenő SMTP e-mail limit lekérése

Ez egy egyszerű végpont, amely egy JSON objektumot ad vissza, amely tartalmazza a napi kimenő SMTP üzenetek count és limit értékeit fiókonként.

GET /v1/emails/limit

Példa kérés:

curl https://fe.tiamati.email/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-mail message, headers vagy rejectedErrors mezőihez.

Ezeknek a tulajdonságoknak és értékeiknek a 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://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Kimenő SMTP e-mail létrehozása

Az e-mail létrehozására szolgáló API-nk a Nodemailer üzenet opcióinak konfigurációján alapul és azt használja. Kérjük, tekintse meg a Nodemailer üzenet konfigurációját az alábbi összes törzsi paraméterhez.

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

Vagy az egyetlen raw opciót kell megadnia a teljes nyers e-maillel, beleértve a fejlécet vagy az egyes törzsi paramétereket külön-külön.

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

Hitelesítés: Ez a végpont támogatja mind az API tokenes hitelesítést, mind az alias hitelesítést. Részletekért lásd a fentebb található Hitelesítés szakaszt.

POST /v1/emails

Példa kérés (API tokennel):

curl -X POST https://fe.tiamati.email/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 (Alias hitelesítő adatokkal):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Példa kérés (Nyers email):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Kimenő SMTP email lekérése

GET /v1/emails/:id

Példa kérés:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Kimenő SMTP email törlése

Az email törlése a státuszt "rejected"-re állítja (és ezáltal nem dolgozza fel a sorban), ha és csak ha az aktuális státusz "pending", "queued" vagy "deferred". Automatikusan törölhetünk emaileket 30 nappal az elkészítésük és/vagy elküldésük után – ezért érdemes a kimenő SMTP emailekről másolatot tartani a kliensben, adatbázisban vagy alkalmazásban. Az email ID értékünkre hivatkozhat az adatbázisban, ha szükséges – ez az érték visszatér mind a Email létrehozása, mind a Email lekérése végpontokból.

DELETE /v1/emails/:id

Példa kérés:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

Tartományok listázása

GET /v1/domains

Példa kérés:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

Tartomány létrehozása

POST /v1/domains

Példa kérés:

curl -X POST https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

Domain rekordok ellenőrzése

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

Példa kérés:

curl https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Domain szintű catch-all jelszavak listázása

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

Példa kérés:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Domain szintű catch-all jelszó létrehozása

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ű catch-all jelszó eltávolítása

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

Példa kérés:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Domain frissítése

PUT /v1/domains/example.com

Példa kérés:

curl -X PUT https://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Domain tag frissítése

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

Példa kérés:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Domain tag eltávolítása

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

Példa kérés:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Alias jelszó generálása

Figyelem, ha nem küldesz e-mailben utasításokat, akkor a felhasználónév és jelszó a sikeres kérés JSON válaszában 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élda kérés:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Tartomány aliasok listázása

GET /v1/domains/example.com/aliases

Példa kérés:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Új tartomány alias létrehozása

POST /v1/domains/example.com/aliases

Példa kérés:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

Tartomány alias lekérése

Egy tartomány aliasát lekérheti az id vagy a name értéke alapján.

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

Példa kérés:

curl https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Tartomány alias frissítése

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

Példa kérés:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Tartomány alias törlése

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

Példa kérés:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Lehetővé tesszük, hogy még az ingyenes csomagon is titkosíts rekordokat költség nélkül. A magánéletnek nem kellene egy funkciónak lennie, hanem alapvetően be kellene épülnie a termék minden aspektusába. Nagyon sok kérés érkezett egy Privacy Guides beszélgetésben és a GitHub hibajegyeinken, ezért ezt hozzáadtuk.

TXT rekord titkosítása

POST /v1/encrypt

Példa kérés:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"