Email API

V současné době jsme ještě nevydali žádné obaly API, ale plánujeme tak učinit v blízké budoucnosti. Pošlete e-mail na adresu api@forwardemail.net pokud si přejete být upozorněni na vydání obalu API konkrétního programovacího jazyka. Mezitím můžete ve své aplikaci používat tyto doporučené knihovny požadavků HTTP nebo je jednoduše používat kučera jako v níže uvedených příkladech.

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

Všechny koncové body vyžadují váš API klíč nastavit jako hodnotu "username" požadavku Základní autorizace záhlaví. Nebojte se – níže jsou uvedeny příklady, pokud si nejste jisti, co to je.

Pokud dojde k chybě, 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 zprávy odpovědí API jsou přeloženy do posledního zjištěného národního prostředí uživatele, který zadává požadavek API. Můžete to přepsat předáním zvyku Accept-Language záhlaví. Neváhejte a vyzkoušejte to pomocí rozbalovací nabídky jazyků v dolní části této stránky.

Pokud chcete být upozorněni, až bude stránkování dostupné, pošlete nám e-mail api@forwardemail.net.

Načíst protokoly

Naše API vám programově umožňuje stahovat protokoly pro váš účet. Odesláním požadavku na tento koncový bod se zpracují všechny protokoly pro váš účet a zašle vám je e-mailem jako přílohu (Gzip stlačený CSV tabulkový soubor) po dokončení.

To vám umožňuje vytvářet úlohy na pozadí s a Cron práce nebo pomocí našeho Node.js software pro plánování úloh Bree přijímat protokoly, kdykoli budete chtít. Všimněte si, že tento koncový bod je omezen na 10 žádostí za den.

Příloha je tvořena malými písmeny email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz a samotný e-mail obsahuje stručné shrnutí získaných protokolů. Záznamy si také můžete kdykoli stáhnout z 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 můžete využívat služby jako např Crontab.guru pro ověření syntaxe výrazu úlohy cron.

Příklad úlohy Cron (každý den o půlnoci a s protokoly za předchozí den):

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:

Aktualizujte úč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"

Ujistěte se, že jste postupovali podle pokynů 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ích SMTP s vaší doménou.

Seznam e-mailů

Všimněte si, že tento koncový bod nevrací již vytvořené e-maily message, headers, accepted, ani rejectedErrors vlastnosti.

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

Tento koncový bod se vrátí maximálně 50 výsledky najednou. Pokud se chcete dotazovat na více stránek, přidejte ?page=NUMBER kde NUMBER je celé číslo, např. ?page=1.

GET /v1/emails

Příklad požadavku:

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

Vytvořit e-mail

Naše API pro vytváření e-mailů je inspirováno a využívá konfiguraci možností zpráv Nodemailer. Prosím odložte na Konfigurace zpráv Nodemailer pro všechny parametry těla níže.

Všimněte si, že s výjimkou envelope a dkim (protože je nastavujeme automaticky za vás), podporujeme všechny možnosti Nodemailer. Nastavíme automaticky disableFileAccess a disableUrlAccess možnosti true pro bezpečnostní účely.

Měli byste buď projít jedinou možností raw s vaším nezpracovaným úplným e-mailem včetně záhlaví nebo předat možnosti jednotlivých parametrů těla níže.

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 e-mail

GET /v1/emails/:id

Příklad požadavku:

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

Smazat e-mail

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

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ěřte záznamy 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:

Aktualizujte 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ání 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 na doménu

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 na doménu

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:

Aktualizujte č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:

Vypsat aliasy domén

GET /v1/domains/example.com/aliases

Příklad požadavku:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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ď jeho id nebo jeho name hodnota.

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:

Aktualizujte 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:

Odstranit 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: