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í oprávnění záhlaví (s výjimkou Alias Kontakty, Alias kalendářea Alias poštovní schránky které používají a vygenerovaný alias uživatelské jméno a heslo)..

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

Pokud se vyskytnou nějaké chyby, tělo odpovědi požadavku API bude obsahovat podrobnou chybovou zprávu.

[!TIP] Pokud obdržíte stavový kód 5xx (což by se nemělo stávat), kontaktujte nás prosím na adrese api@forwardemail.net a my vám pomůžeme váš problém okamžitě vyřešit.

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.

[!POZNÁMKA] Od 1. listopadu 2024 budou koncové body API pro Seznam domén a Vypsat aliasy domén bude výchozí 1000 maximální počet výsledků na stránku. Pokud byste se chtěli k tomuto chování přihlásit dříve, můžete projít ?paginate=true jako další parametr querystring k URL pro dotaz na koncový bod.

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

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

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

Abychom zjistili, zda je nebo není k dispozici více výsledků, poskytujeme tato záhlaví odpovědí HTTP (která můžete analyzovat, abyste je mohli 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 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:

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"

[!POZNÁMKA] Na rozdíl od jiných koncových bodů API tyto vyžadují Autentizace "username" se rovná aliasu uživatelského jména a "password" se rovná heslu vygenerovanému aliasem jako hlavičky Basic Authorization.

[!VAROVÁNÍ] Tato sekce koncového bodu je ve vývoji a bude vydána (doufejme) v roce 2024. Mezitím prosím používejte klienta IMAP z rozevíracího seznamu „Aplikace“ v navigaci na našem webu.

[!NOTE] Podpora CardDAV zatím není k dispozici, aktualizace najdete v této diskuzi na GitHubu.

Seznam kontaktů

GET /v1/contacts

Již brzy

Vytvořte kontakt

POST /v1/contacts

Již brzy

Získat kontakt

GET /v1/contacts/:id

Již brzy

Aktualizujte kontakt

PUT /v1/contacts/:id

Již brzy

Smazat kontakt

DELETE /v1/contacts/:id

Již brzy

[!POZNÁMKA] Na rozdíl od jiných koncových bodů API tyto vyžadují Autentizace "username" se rovná aliasu uživatelského jména a "password" se rovná heslu vygenerovanému aliasem jako hlavičky Basic Authorization.

[!VAROVÁNÍ] Tato sekce koncového bodu je ve vývoji a bude vydána (doufejme) v roce 2024. Mezitím prosím používejte klienta IMAP z rozevíracího seznamu „Aplikace“ v navigaci na našem webu.

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

[!POZNÁMKA] Na rozdíl od jiných koncových bodů API tyto vyžadují Autentizace "username" se rovná aliasu uživatelského jména a "password" se rovná heslu vygenerovanému aliasem jako hlavičky Basic Authorization.

[!VAROVÁNÍ] Tato sekce koncového bodu je ve vývoji a bude vydána (doufejme) v roce 2024. Mezitím prosím používejte klienta IMAP z rozevíracího seznamu „Aplikace“ v navigaci na našem webu.

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

Tyto pokyny naleznete v naší sekci FAQ Podporujete přijímání e-mailů pomocí protokolu IMAP?.

Seznam a vyhledávání zpráv

GET /v1/messages

Již brzy

Vytvořit zprávu

[!POZNÁMKA] Toto bude NOT odeslat e-mail – pouze jednoduše přidá zprávu do složky vaší poštovní schránky (např. je to podobné jako IMAP APPEND příkaz). Pokud chcete poslat email, tak viz Vytvořte odchozí e-mail SMTP níže. Po vytvoření odchozího e-mailu SMTP můžete připojit jeho kopii pomocí tohoto koncového bodu do poštovní schránky svého aliasu pro účely úložiště.

POST /v1/messages

Již brzy

Načíst zprávu

GET /v1/messages/:id

Již brzy

Aktualizovat zprávu

PUT /v1/messages/:id

Již brzy

Smazat zprávu

DELETE /v1/messages:id

Již brzy

[!TIP] Koncové body složky s cestou ke složce /v1/folders/:path protože jejich koncový bod je zaměnitelný s ID složky :id. To znamená, že můžete odkazovat na složku buď její path nebo id hodnota.

[!VAROVÁNÍ] Tato sekce koncového bodu je ve vývoji a bude vydána (doufejme) v roce 2024. Mezitím prosím používejte klienta IMAP z rozevíracího seznamu „Aplikace“ v navigaci na našem webu.

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

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

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

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

Všimněte si, že tento koncový bod nevrací hodnoty vlastností pro e-maily message, headers, ani rejectedErrors.

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

GET /v1/emails

Příklad požadavku:

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

Vytvořte odchozí e-mail SMTP

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.

Tento koncový bod API za vás automaticky zakóduje emotikony, pokud je najdete v záhlaví (např. Subject: 🤓 Hello převádí se na Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automaticky). Naším cílem bylo vytvořit rozhraní API pro e-maily, které je extrémně přátelské pro vývojáře a odolné vůči falešným zprává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í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:

[!TIP] Koncové body domény s názvem domény /v1/domains/:domain_name protože jejich koncový bod je zaměnitelný s ID domény :domain_id. To znamená, že můžete odkazovat na doménu buď její name nebo id hodnota.

Seznam domén

[!POZNÁMKA] Od 1. listopadu 2024 budou koncové body API pro Seznam domén a Vypsat aliasy domén bude výchozí 1000 maximální počet výsledků na stránku. Pokud byste se chtěli k tomuto chování přihlásit dříve, můžete projít ?paginate=true jako další parametr řetězce dotazu k adrese URL pro dotaz na koncový bod. Vidět Stránkování pro větší přehled.

GET /v1/domains

Příklad požadavku:

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

Vytvořte 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í 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řte 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

[!DŮLEŽITÉ] Pokud je pozvaný uživatel již přijatým členem jakékoli jiné domény, jejímž členem je administrátor, který jej zve, pak pozvánku automaticky přijme a neodešle e-mail.

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:

Vygenerujte aliasové heslo

Upozorňujeme, že pokud nezašlete pokyny e-mailem, uživatelské jméno a heslo budou 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:

Vypsat aliasy domén

[!POZNÁMKA] Od 1. listopadu 2024 budou koncové body API pro Seznam domén a Vypsat aliasy domén bude výchozí 1000 maximální počet výsledků na stránku. Pokud byste se chtěli k tomuto chování přihlásit dříve, můžete projít ?paginate=true jako další parametr řetězce dotazu k adrese URL pro dotaz na koncový bod. Vidět Stránkování pro větší přehled.

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řte 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:

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 bezplatně šifrovat záznamy i na bezplatném plánu. Soukromí by nemělo být funkcí, mělo by být neodmyslitelně integrováno do všech aspektů produktu. Jak je vysoce požadováno v a Diskuse o ochraně osobních údajů a dál naše problémy GitHub přidali jsme toto.

Šifrovat TXT záznam

POST /v1/encrypt

Příklad požadavku:

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