Email Forwarding API

Knihovny

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.

Jazyk	Knihovna
Rubín	Faraday
Krajta	žádosti
Jáva	OkHttp
PHP	žrát
JavaScript	superagent (jsme údržbáři)
Node.js	superagent (jsme údržbáři)
Jít	net / http
.NET	RestSharp

Základní URI

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

Ověřování

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.

Chyby

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

Kód	název
200	OK
400	Špatný požadavek
401	Neoprávněný
403	Zakázáno
404	Nenalezeno
429	Příliš mnoho žádostí
500	Interní chyba serveru
501	Není implementováno
502	Špatná brána
503	služba je nedostupná
504	Časový limit brány

Spropitné: 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.

Lokalizace

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.

Stránkování

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

Účet

Vytvořit účet

POST /v1/account

Parametr těla	Požadované	Typ	Popis
`email`	Ano	Řetězec (e-mail)	Emailová adresa
`password`	Ano	Tětiva	Heslo

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 -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Aktualizujte účet

PUT /v1/account

Parametr těla	Požadované	Typ	Popis
`email`	Ne	Řetězec (e-mail)	Emailová adresa
`given_name`	Ne	Tětiva	Jméno
`family_name`	Ne	Tětiva	Příjmení
`avatar_url`	Ne	Řetězec (URL)	Odkaz na obrázek avatar

Příklad požadavku:

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

Domény

Spropitné: Koncové body domény s názvem domény /v1/domains/:domain_name protože jejich cesta 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

GET /v1/domains

Parametr dotazu	Požadované	Typ	Popis
`name`	Ne	Řetězec (podporováno RegExp)	Hledejte domény podle jména
`alias`	Ne	Řetězec (podporováno RegExp)	Hledejte domény podle aliasu
`recipient`	Ne	Řetězec (podporováno RegExp)	Vyhledejte domény podle příjemce

Příklad požadavku:

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

Vytvořit doménu

POST /v1/domains

Parametr těla	Požadované	Typ	Popis
`domain`	Ano	Řetězec (FQDN nebo IP)	Plně kvalifikovaný název domény („FQDN“) nebo adresa IP
`plan`	Ne	Řetězec (počet)	Typ plánu (musí být `"free"`, `"enhanced_protection"`nebo `"team"`, výchozí je `"free"` nebo aktuální placený plán uživatele, pokud jej má)
`catchall`	Ne	Řetězec (oddělené e-mailové adresy) nebo logická hodnota	Vytvořte výchozí univerzální alias, výchozí hodnota je `true` (li `true` jako příjemce použije e-mailovou adresu uživatele API a pokud `false` nebude vytvořen žádný catch-all). Pokud je předán řetězec, jedná se o oddělený seznam e-mailových adres, které lze použít jako příjemce (oddělené zalomením řádku, mezerou a/nebo čárkou)
`has_adult_content_protection`	Ne	Booleovský	Zda povolit v této doméně ochranu obsahu pro dospělé Spam Scanner
`has_phishing_protection`	Ne	Booleovský	Zda povolit ochranu proti phishingu Spam Scanner v této doméně
`has_executable_protection`	Ne	Booleovský	Zda povolit spustitelnou ochranu Spam Scanner v této doméně
`has_virus_protection`	Ne	Booleovský	Zda povolit antivirovou ochranu Spam Scanner v této doméně
`has_recipient_verification`	Ne	Booleovský	Výchozí nastavení globální domény pro to, zda mají příjemci aliasů vyžadovat, aby klikali na odkaz pro ověření e-mailu, aby mohly e-maily procházet

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 -X GET 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 -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Aktualizujte doménu

PUT /v1/domains/example.com

Parametr těla	Požadované	Typ	Popis
`smtp_port`	Ne	Řetězec nebo číslo	Vlastní port pro konfiguraci pro předávání SMTP (výchozí je `"25"`)
`has_adult_content_protection`	Ne	Booleovský	Zda povolit v této doméně ochranu obsahu pro dospělé Spam Scanner
`has_phishing_protection`	Ne	Booleovský	Zda povolit ochranu proti phishingu Spam Scanner v této doméně
`has_executable_protection`	Ne	Booleovský	Zda povolit spustitelnou ochranu Spam Scanner v této doméně
`has_virus_protection`	Ne	Booleovský	Zda povolit antivirovou ochranu Spam Scanner v této doméně
`has_recipient_verification`	Ne	Booleovský	Výchozí nastavení globální domény pro to, zda mají příjemci aliasů vyžadovat, aby klikali na odkaz pro ověření e-mailu, aby mohly e-maily procházet

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:

Pozvánky

Přijmout pozvání do domény

GET /v1/domains/:domain_name/invites

Příklad požadavku:

curl -X GET 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

Parametr těla	Požadované	Typ	Popis
`email`	Ano	Řetězec (e-mail)	E-mailová adresa pro pozvání do seznamu členů domény
`group`	Ano	Řetězec (počet)	Skupina pro přidání uživatele do členství v doméně (může to být jedna z `"admin"` nebo `"user"`)

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

Parametr těla	Požadované	Typ	Popis
`email`	Ano	Řetězec (e-mail)	E-mailová adresa, kterou chcete odstranit ze seznamu členů domény

Příklad požadavku:

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

Členové

Aktualizujte člena domény

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

Parametr těla	Požadované	Typ	Popis
`group`	Ano	Řetězec (počet)	Skupina pro aktualizaci uživatele na členství v doméně (může to být jedna z `"admin"` nebo `"user"`)

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:

Aliasy

Vypsat aliasy domén

GET /v1/domains/example.com/aliases

Parametr dotazu	Požadované	Typ	Popis
`name`	Ne	Řetězec (podporováno RegExp)	Vyhledejte aliasy v doméně podle názvu
`recipient`	Ne	Řetězec (podporováno RegExp)	Vyhledejte aliasy v doméně podle příjemce

Příklad požadavku:

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

Vytvořit nový alias domény

POST /v1/domains/example.com/aliases

Parametr těla	Požadované	Typ	Popis
`name`	Ano	Tětiva	Jméno aliasu
`recipients`	Ano	Řetězec nebo pole	Seznam příjemců (musí být řetězec oddělený mezerou / mezerou / čárkou nebo pole platných e-mailových adres, plně kvalifikovaných doménových jmen („FQDN“), IP adres a / nebo adres URL pro webhook)
`description`	Ne	Tětiva	Popis aliasu
`labels`	Ne	Řetězec nebo pole	Seznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
`has_recipient_verification`	Ne	Booleovský	Zda povolit, aby příjemci klikli na odkaz pro ověření e-mailu, aby e-maily procházely (výchozí nastavení domény, pokud není výslovně nastaveno v těle požadavku)
`is_enabled`	Ne	Booleovský	Zda se má zakázat tento alias (pokud je zakázán, e-maily nebudou směrovány nikde, ale vrátí úspěšné stavové kódy)

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

Parametr těla	Požadované	Typ	Popis
`name`	Ne	Tětiva	Jméno aliasu
`recipients`	Ano	Řetězec nebo pole	Seznam příjemců (musí být řetězec oddělený mezerou / mezerou / čárkou nebo pole platných e-mailových adres, plně kvalifikovaných doménových jmen („FQDN“), IP adres a / nebo adres URL pro webhook)
`description`	Ne	Tětiva	Popis aliasu
`labels`	Ne	Řetězec nebo pole	Seznam štítků (musí být řetězec oddělený mezerou / mezerou nebo čárkou)
`has_recipient_verification`	Ne	Booleovský	Zda povolit, aby příjemci klikli na odkaz pro ověření e-mailu, aby e-maily procházely (výchozí nastavení domény, pokud není výslovně nastaveno v těle požadavku)
`is_enabled`	Ne	Booleovský	Zda se má zakázat tento alias (pokud je zakázán, e-maily nebudou směrovány nikde, ale vrátí úspěšné stavové kódy)

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: