API pro e-maily

V současné době jsme nevydali žádné API wrappery, ale plánujeme to v blízké budoucnosti. Pokud chcete být upozorněni na vydání API wrapperu pro konkrétní programovací jazyk, pošlete e-mail na adresu api@forwardemail.net. Mezitím můžete ve své aplikaci použít tyto doporučené knihovny HTTP požadavků nebo jednoduše použít kučera, jak je uvedeno v níže uvedených příkladech.

Aktuální základní cesta URI protokolu HTTP je: https://api.forwardemail.net.

Všechny koncové body vyžadují, aby byla vaše hodnota Klíč API nastavena jako hodnota „uživatelské jméno“ v záhlaví Základní autorizace požadavku (s výjimkou Aliasové kontakty, Aliasové kalendáře a Aliasové poštovní schránky, které používají vygenerované uživatelské jméno a heslo aliasu).

Nebojte se – níže jsou uvedeny příklady, pokud si nejste jisti, o co jde.

Pokud dojde k nějakým chybám, tělo odpovědi požadavku 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 odpovědi API jsou přeloženy do posledního zjištěného jazyka uživatele, který zadává požadavek API. Toto nastavení můžete přepsat zadáním vlastní hlavičky Accept-Language. Neváhejte si to vyzkoušet pomocí rozbalovací nabídky jazyků v dolní části této stránky.

Stránkování je podporováno všemi koncovými body API, které vypisují výsledky.

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

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

Abychom zjistili, zda jsou k dispozici další výsledky, poskytujeme tyto hlavičky odpovědí HTTP (které můžete analyzovat a programově stránkovat):

Příklad požadavku:

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

Načíst protokoly

Naše API vám programově umožňuje stahovat protokoly pro váš účet. Odesláním požadavku do tohoto koncového bodu zpracujete všechny protokoly pro váš účet a po dokončení vám je odešlete e-mailem jako přílohu (komprimovaný soubor tabulky Gzip CSV).

To vám umožňuje vytvářet úlohy na pozadí s Cron úloha nebo pomocí našeho Software pro plánování úloh Node.js Bree k přijímání protokolů, kdykoli budete chtít. Upozorňujeme, že tento koncový bod je omezen na 10 požadavků za den.

Příloha je malým písmenem ve tvaru email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz a samotný e-mail obsahuje stručné shrnutí načtených protokolů. Protokoly si také můžete kdykoli stáhnout z adresy Můj účet → Protokoly.

GET /v1/logs/download

Příklad požadavku:

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

Příklad úlohy Cron (každý den o půlnoci):

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

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

Příklad úlohy Cron (každý den o půlnoci a se záznamy z předchozího dne):

Pro MacOS:

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

Pro Linux a Ubuntu:

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

Vytvořit účet

POST /v1/account

Příklad požadavku:

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

Načíst účet

GET /v1/account

Příklad požadavku:

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

Aktualizovat účet

PUT /v1/account

Příklad požadavku:

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

Seznam kontaktů

GET /v1/contacts

Již brzy

Vytvořit kontakt

POST /v1/contacts

Již brzy

Načíst kontakt

GET /v1/contacts/:id

Již brzy

Aktualizovat kontakt

PUT /v1/contacts/:id

Již brzy

Smazat kontakt

DELETE /v1/contacts/:id

Již brzy

Seznam kalendářů

GET /v1/calendars

Již brzy

Vytvořit kalendář

POST /v1/calendars

Již brzy

Načíst kalendář

GET /v1/calendars/:id

Již brzy

Aktualizovat kalendář

PUT /v1/calendars/:id

Již brzy

Smazat kalendář

DELETE /v1/calendars/:id

Již brzy

Ujistěte se prosím, že jste postupovali podle pokynů k nastavení vaší domény.

Tyto pokyny naleznete v sekci Často kladených otázek Podporujete příjem e-mailů přes IMAP?.

Seznam a vyhledávání zpráv

GET /v1/messages

Již brzy

Vytvořit zprávu

POST /v1/messages

Již brzy

Načíst zprávu

GET /v1/messages/:id

Již brzy

Aktualizační zpráva

PUT /v1/messages/:id

Již brzy

Smazat zprávu

DELETE /v1/messages:id

Již brzy

Seznam složek

GET /v1/folders

Již brzy

Vytvořit složku

POST /v1/folders

Již brzy

Načíst složku

GET /v1/folders/:id

Již brzy

Aktualizovat složku

PUT /v1/folders/:id

Již brzy

Smazat složku

DELETE /v1/folders/:id

Již brzy

Kopírovat složku

POST /v1/folders/:id/copy

Již brzy

Ujistěte se prosím, že jste postupovali podle pokynů k nastavení vaší domény.

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

Získat limit odchozích e-mailů SMTP

Toto je jednoduchý koncový bod, který vrací objekt JSON obsahující hodnoty count a limit pro počet denních odchozích zpráv SMTP pro každý účet.

GET /v1/emails/limit

Příklad požadavku:

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

Seznam odchozích e-mailů SMTP

Upozorňujeme, že tento koncový bod nevrací hodnoty vlastností pro message, headers ani rejectedErrors e-mailu.

Chcete-li vrátit tyto vlastnosti a jejich hodnoty, použijte koncový bod Načíst e-mail s ID e-mailu.

GET /v1/emails

Příklad požadavku:

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

Vytvořit odchozí SMTP e-mail

Naše API pro vytváření e-mailů je inspirováno a využívá konfiguraci možností zpráv v Nodemaileru. Pro všechny níže uvedené parametry těla zprávy se prosím řiďte parametrem Konfigurace zpráv Nodemaileru.

Upozorňujeme, že s výjimkou envelope a dkim (protože ty nastavujeme automaticky) podporujeme všechny možnosti Nodemaileru. Z bezpečnostních důvodů automaticky nastavujeme možnosti disableFileAccess a disableUrlAccess na true.

Buď byste měli předat jednu možnost raw s vaším nezpracovaným celým e-mailem včetně záhlaví, nebo níže předat jednotlivé možnosti parametrů těla.

Tento koncový bod API automaticky zakóduje emoji, pokud se nacházejí v záhlaví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 e-mailové API, které je extrémně uživatelsky přívětivé a odolné vůči falešným nálepkám.

POST /v1/emails

Příklad požadavku:

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říklad požadavku:

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

Načíst odchozí e-maily SMTP

GET /v1/emails/:id

Příklad požadavku:

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

Smazat odchozí e-maily SMTP

Smazání e-mailu nastaví stav na "rejected" (a následně jej nezpracuje ve frontě) pouze tehdy, když je aktuální stav "pending", "queued" nebo "deferred". E-maily můžeme automaticky smazat po 30 dnech od jejich vytvoření a/nebo odeslání – proto byste si měli uchovávat kopii odchozích SMTP e-mailů ve svém klientovi, databázi nebo aplikaci. V případě potřeby můžete ve své databázi odkazovat na hodnotu našeho ID e-mailu – tato hodnota je vrácena z koncových bodů Vytvořit e-mail i Načíst e-mail.

DELETE /v1/emails/:id

Příklad požadavku:

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

Seznam domén

GET /v1/domains

Příklad požadavku:

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

Vytvořit doménu

POST /v1/domains

Příklad požadavku:

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

Načíst doménu

GET /v1/domains/example.com

Příklad požadavku:

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

Ověření záznamů domény

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

Příklad požadavku:

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

Ověření záznamů SMTP domény

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

Příklad požadavku:

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

Zobrazit seznam hesel pro celou doménu

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

Příklad požadavku:

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

Vytvořit heslo 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 pro celou doménu

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

Příklad požadavku:

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

Aktualizovat doménu

PUT /v1/domains/example.com

Příklad požadavku:

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

Smazat doménu

DELETE /v1/domains/:domain_name

Příklad požadavku:

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

Přijmout pozvánku do domény

GET /v1/domains/:domain_name/invites

Příklad požadavku:

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

Vytvořit pozvánku do domény

POST /v1/domains/example.com/invites

Příklad požadavku:

curl -X POST https://api.forwardemail.net/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

Příklad požadavku:

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

Aktualizovat člena domény

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

Příklad požadavku:

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

Odebrat člena domény

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

Příklad požadavku:

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

Vygenerovat alias hesla

Upozorňujeme, že pokud neodešlete pokyny e-mailem, bude uživatelské jméno a heslo v těle odpovědi JSON ú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

Příklad požadavku:

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

Seznam aliasů domén

GET /v1/domains/example.com/aliases

Příklad požadavku:

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Načíst alias domény

Alias domény můžete načíst buď pomocí hodnoty id, nebo pomocí hodnoty name.

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

Příklad požadavku:

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

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

Příklad požadavku:

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

Aktualizovat alias domény

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

Příklad požadavku:

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

Smazat alias domény

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

Příklad požadavku:

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

Umožňujeme vám šifrovat záznamy i v bezplatném plánu bezplatně. Ochrana soukromí by neměla být funkcí, ale měla by být neodmyslitelně součástí všech aspektů produktu. Na základě důrazné žádosti v dokumentech Diskuse o Průvodcích ochranou osobních údajů a naše problémy s GitHubem jsme tuto funkci přidali.

Zašifrovat záznam TXT

POST /v1/encrypt

Příklad požadavku:

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