Email API

Momentálně jsme ještě nevydali žádné API wrappery, ale plánujeme tak učinit v blízké budoucnosti. Pošlete email na api@forwardemail.net, pokud chcete být upozorněni, až bude vydán API wrapper pro konkrétní programovací jazyk. Mezitím můžete ve své aplikaci použít tyto doporučené HTTP knihovny, nebo jednoduše použít curl jako v níže uvedených příkladech.

Aktuální základní cesta HTTP URI je: https://fe.tiamati.email.

Všechny koncové body vyžadují autentizaci pomocí Basic Authorization. Podporujeme dva způsoby autentizace:

Autentizace pomocí API tokenu (doporučeno pro většinu koncových bodů)

Nastavte svůj API klíč jako hodnotu "username" s prázdným heslem:

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

Všimněte si dvojtečky (:) za API tokenem – označuje prázdné heslo ve formátu Basic Auth.

Autentizace pomocí aliasových přihlašovacích údajů (pro odchozí e-maily)

Koncový bod Vytvořit odchozí SMTP e-mail také podporuje autentizaci pomocí vaší aliasové e-mailové adresy a vygenerovaného aliasového hesla:

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"

Tato metoda je užitečná při odesílání e-mailů z aplikací, které již používají SMTP přihlašovací údaje, a umožňuje bezproblémovou migraci ze SMTP na naše API.

Koncové body pouze pro aliasy

Koncové body Alias Kontakty, Alias Kalendáře, Alias Zprávy a Alias Složky vyžadují aliasové přihlašovací údaje a nepodporují autentizaci pomocí API tokenu.

Nemějte obavy – níže jsou uvedeny příklady, pokud si nejste jisti, co to je.

Pokud dojde k chybě, tělo odpovědi API bude obsahovat podrobnou chybovou zprávu.

Naše služba je přeložena do více než 25 různých jazyků. Všechny zprávy odpovědí API jsou přeloženy do poslední detekované lokality uživatele, který provádí API požadavek. Toto můžete přepsat předáním vlastního hlavičkového parametru Accept-Language. Klidně to vyzkoušejte pomocí jazykového rozbalovacího seznamu ve spodní části této stránky.

Stránkování je podporováno ve všech API koncových bodech, které vracejí seznam výsledků.

Jednoduše zadejte vlastnosti dotazu page (a volitelně limit).

Vlastnost page by měla být číslo větší nebo rovno 1. Pokud zadáte limit (také číslo), minimální hodnota je 10 a maximální 50 (pokud není uvedeno jinak).

Example Request:

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

Získat záznamy

Naše API vám programově umožňuje stáhnout záznamy pro váš účet. Odesláním požadavku na tento endpoint se zpracují všechny záznamy pro váš účet a zašlou se vám e-mailem jako příloha (soubor tabulky CSV komprimovaný pomocí Gzip) po dokončení.

To vám umožňuje vytvářet úlohy na pozadí pomocí Cron job nebo pomocí našeho Node.js plánovacího softwaru Bree, abyste dostávali záznamy kdykoli budete chtít. Všimněte si, že tento endpoint je omezen na 10 požadavků za den.

Příloha má název v malých písmenech ve formátu email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz a samotný e-mail obsahuje stručné shrnutí získaných záznamů. Záznamy si také můžete stáhnout kdykoli z Můj účet → Záznamy

GET /v1/logs/download

Example Request:

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

Příklad Cron jobu (každou půlnoc každý den):

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

Všimněte si, že můžete použít služby jako Crontab.guru k ověření syntaxe výrazu vašeho cron jobu.

Příklad Cron jobu (každou půlnoc každý den a se záznamy za předchozí den):

Pro MacOS:

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

Pro Linux a Ubuntu:

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

Vytvořit účet

POST /v1/account

Example Request:

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

Získat účet

GET /v1/account

Example Request:

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

Aktualizovat účet

PUT /v1/account

Example Request:

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

Seznam kontaktů

GET /v1/contacts

Brzy k dispozici

Vytvořit kontakt

POST /v1/contacts

Brzy k dispozici

Získat kontakt

GET /v1/contacts/:id

Brzy k dispozici

Aktualizovat kontakt

PUT /v1/contacts/:id

Brzy k dispozici

Smazat kontakt

DELETE /v1/contacts/:id

Brzy k dispozici

Seznam kalendářů

GET /v1/calendars

Brzy k dispozici

Vytvořit kalendář

POST /v1/calendars

Brzy k dispozici

Získat kalendář

GET /v1/calendars/:id

Brzy k dispozici

Aktualizovat kalendář

PUT /v1/calendars/:id

Brzy k dispozici

Smazat kalendář

DELETE /v1/calendars/:id

Brzy k dispozici

Prosím ujistěte se, že jste dodrželi pokyny pro nastavení vaší domény.

Tyto pokyny naleznete v naší sekci FAQ Podporujete příjem emailů přes IMAP?.

Seznam a vyhledávání zpráv

GET /v1/messages

Brzy k dispozici

Vytvořit zprávu

POST /v1/messages

Brzy k dispozici

Získat zprávu

GET /v1/messages/:id

Brzy k dispozici

Aktualizovat zprávu

PUT /v1/messages/:id

Brzy k dispozici

Smazat zprávu

DELETE /v1/messages:id

Brzy k dispozici

Seznam složek

GET /v1/folders

Brzy k dispozici

Vytvořit složku

POST /v1/folders

Brzy k dispozici

Získat složku

GET /v1/folders/:id

Brzy k dispozici

Aktualizovat složku

PUT /v1/folders/:id

Brzy k dispozici

Smazat složku

DELETE /v1/folders/:id

Brzy k dispozici

Kopírovat složku

POST /v1/folders/:id/copy

Brzy k dispozici

Prosím ujistěte se, že jste dodrželi pokyny pro nastavení vaší domény.

Tyto pokyny naleznete na Můj účet → Domény → Nastavení → Konfigurace odchozího SMTP. Musíte zajistit nastavení DKIM, Return-Path a DMARC pro odesílání odchozího SMTP s vaší doménou.

Získat limit odchozích SMTP emailů

Toto je jednoduchý endpoint, který vrací JSON objekt obsahující count a limit pro počet denních odchozích SMTP zpráv na základě jednotlivého účtu.

GET /v1/emails/limit

Příklad požadavku:

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

Seznam odchozích SMTP emailů

Všimněte si, že tento endpoint nevrací hodnoty vlastností pro message, headers ani rejectedErrors emailu.

Pro vrácení těchto vlastností a jejich hodnot použijte prosím endpoint Získat email s ID emailu.

GET /v1/emails

Příklad požadavku:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

Vytvořit odchozí SMTP email

Naše API pro vytváření emailů je inspirováno a využívá konfiguraci možností zprávy Nodemaileru. Pro všechny parametry těla níže prosím odkazujte na konfiguraci zprávy Nodemailer.

Všimněte si, že s výjimkou envelope a dkim (které nastavujeme automaticky za vás) podporujeme všechny možnosti Nodemaileru. Automaticky nastavujeme možnosti disableFileAccess a disableUrlAccess na true z bezpečnostních důvodů.

Měli byste buď předat jedinou možnost raw s vaším surovým plným emailem včetně hlaviček nebo předat jednotlivé parametry těla níže.

Tento API endpoint automaticky zakóduje emoji, pokud jsou nalezeny v hlavičkách (např. předmět Subject: 🤓 Hello se automaticky převede na Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Naším cílem bylo vytvořit extrémně přívětivé a odolné API pro vývojáře.

Autentizace: Tento endpoint podporuje jak autentizaci pomocí API tokenu, tak autentizaci pomocí aliasových přihlašovacích údajů. Podrobnosti viz sekce Autentizace výše.

POST /v1/emails

Příklad požadavku (API token):

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říklad požadavku (přihlašovací údaje aliasu):

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říklad požadavku (surový e-mail):

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

Získání odchozího SMTP e-mailu

GET /v1/emails/:id

Příklad požadavku:

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

Smazání odchozího SMTP e-mailu

Smazání e-mailu nastaví stav na "rejected" (a následně jej nebude zpracovávat v frontě) pouze pokud je aktuální stav jeden z "pending", "queued" nebo "deferred". E-maily můžeme automaticky mazat po 30 dnech od jejich vytvoření a/nebo odeslání – proto byste měli uchovávat kopii odchozích SMTP e-mailů ve svém klientovi, databázi nebo aplikaci. Pokud chcete, můžete v databázi odkazovat na naši hodnotu ID e-mailu – tato hodnota je vrácena z obou endpointů Vytvořit e-mail a Získat e-mail.

DELETE /v1/emails/:id

Příklad požadavku:

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

Výpis domén

GET /v1/domains

Příklad požadavku:

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

Vytvoření domény

POST /v1/domains

Příklad požadavku:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Získat doménu

GET /v1/domains/example.com

Příklad požadavku:

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

Ověřit záznamy domény

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

Příklad požadavku:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Ověřit SMTP záznamy domény

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

Příklad požadavku:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Vypsat hesla catch-all pro celou doménu

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

Příklad požadavku:

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

Vytvořit heslo catch-all pro celou doménu

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

Příklad požadavku:

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

Odebrat heslo catch-all pro celou doménu

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

Příklad požadavku:

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

Aktualizovat doménu

PUT /v1/domains/example.com

Example Request:

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

Smazat doménu

DELETE /v1/domains/:domain_name

Example Request:

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

Přijmout pozvánku do domény

GET /v1/domains/:domain_name/invites

Example Request:

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

Vytvořit pozvánku do domény

POST /v1/domains/example.com/invites

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Odebrat pozvánku do domény

DELETE /v1/domains/:domain_name/invites

Example Request:

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

Aktualizovat člena domény

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

Example Request:

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

Odebrat člena domény

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

Example Request:

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

Vygenerovat heslo pro alias

Vezměte prosím na vědomí, že pokud nepošlete instrukce emailem, uživatelské jméno a heslo budou v JSON odpovědi úspěšného požadavku ve formátu { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Example Request:

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

Seznam aliasů domény

GET /v1/domains/example.com/aliases

Example Request:

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

Vytvořit nový alias domény

POST /v1/domains/example.com/aliases

Příklad požadavku:

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

Získání aliasu domény

Alias domény můžete získat buď podle jeho id nebo podle hodnoty name.

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

Příklad požadavku:

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

GET /v1/domains/:domain_name/aliases/:alias_name

Příklad požadavku:

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

Aktualizace aliasu domény

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

Example Request:

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

Smazat alias domény

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

Example Request:

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

Umožňujeme vám šifrovat záznamy i v bezplatném plánu bez poplatků. Soukromí by nemělo být funkcí, mělo by být inherentně zabudováno do všech aspektů produktu. Jak bylo často požadováno v diskuzi Privacy Guides a na našich GitHub issues, přidali jsme tuto funkci.

Šifrovat TXT záznam

POST /v1/encrypt

Example Request:

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