E-post vidarebefordra API

Innehållsförteckning

• bibliotek
• Bas URI
• autentisering
• fel
• Lokalisering
• Paginering
• konto
  • Skapa konto
  • Hämta konto
  • Uppdatera konto
• domäner
  • Lista domäner
  • Skapa domän
  • Hämta domän
  • Verifiera domänregister
  • Uppdatera domän
  • Radera domän
• Inbjudningskort
  • Acceptera domäninbjudan
  • Skapa domäninbjudan
  • Ta bort domäninbjudan
• medlemmar
  • Uppdatera domänmedlem
  • Ta bort domänmedlem
• alias
  • Lista domänalias
  • Skapa nytt domänalias
  • Hämta domänalias
  • Uppdatera domänalias
  • Radera domänalias

bibliotek

Just nu har vi ännu inte släppt några API-omslag, men vi planerar att göra det inom en snar framtid. Skicka ett mail till api@forwardemail.net om du vill bli meddelad när ett visst programmeringsspråks API-omslag släpps. Under tiden kan du använda dessa rekommenderade HTTP-förfrågningsbibliotek i din applikation, eller helt enkelt använda ringla som i exemplen nedan.

Språk	Bibliotek
Rubin	Faraday
Pytonorm	förfrågningar
Java	OkHttp
PHP	SUPA
JavaScript	superagent
Node.js	superagent
Gå	net / http
.NET	RestSharp

Bas URI

Den aktuella HTTP-bas-URI-sökvägen är: https://api.forwardemail.net. Den äldre HTTP-bas-URI-sökvägen för https://forwardemail.net:4000 är fasad från och med 1 januari 2021.

autentisering

Alla slutpunkter kräver din API-nyckel ställas in som "användarnamn"-värdet för begäran Grundläggande auktorisation rubrik. Oroa dig inte – exempel ges nedan för dig om du inte är säker på vad detta är.

fel

Om några fel uppstår kommer svarstypen för API-begäran att innehålla ett detaljerat felmeddelande.

Koda	namn
200	OK
400	Dålig förfrågan
401	Obehörig
403	Förbjuden
404	Hittades inte
429	För många förfrågningar
500	internt serverfel
501	Ej implementerad
502	Dålig gateway
503	Tjänsten är inte tillgänglig
504	Gateway Time-out

Lokalisering

Vår tjänst är översatt till över 25 olika språk. Alla API-svarsmeddelanden översätts till den senast upptäckta lokalen för användaren som gör API-begäran. Du kan åsidosätta detta genom att skicka en anpassad Accept-Language rubrik. Testa gärna med hjälp av rullgardinsmenyn för språk längst ner på denna sida.

Paginering

Om du vill bli meddelad när paginering är tillgänglig, vänligen maila api@forwardemail.net.

konto

Skapa konto

POST /v1/account

Kroppsparameter	Nödvändig	Typ	Beskrivning
email	Ja	String (e-post)	E-postadress
password	Ja	Sträng	Lösenord

Exempelförfrågan:

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

Hämta konto

GET /v1/account

Exempelförfrågan:

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

Uppdatera konto

PUT /v1/account

Kroppsparameter	Nödvändig	Typ	Beskrivning
email	Nej	String (e-post)	E-postadress
given_name	Nej	Sträng	Förnamn
family_name	Nej	Sträng	Efternamn
avatar_url	Nej	Sträng (URL)	Länk till avatarbild

Exempelförfrågan:

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

domäner

Lista domäner

GET /v1/domains

Querystring-parameter	Nödvändig	Typ	Beskrivning
name	Nej	String (RegExp stöds)	Sök efter domäner efter namn
alias	Nej	String (RegExp stöds)	Sök efter domäner efter aliasnamn
recipient	Nej	String (RegExp stöds)	Sök efter domäner efter mottagare

Exempelförfrågan:

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

Skapa domän

POST /v1/domains

Kroppsparameter	Nödvändig	Typ	Beskrivning
domain	Ja	String (FQDN eller IP)	Fullt kvalificerat domännamn ("FQDN") eller IP-adress
plan	Nej	Sträng (många)	Plantyp (måste vara "free", "enhanced_protection", eller "team", har som standard "free" eller användarens nuvarande betalda plan om det finns en)
catchall	Nej	Sträng (avgränsade e-postadresser) eller boolesk	Skapa ett förvalt catch-all-alias, som standard true (om true den kommer att använda API-användarens e-postadress som mottagare, och om false ingen catch-all kommer att skapas). Om en sträng skickas är det en avgränsad lista med e-postadresser som ska användas som mottagare (avgränsade med radbrytning, mellanslag och/eller komma)
has_adult_content_protection	Nej	Boolean	Huruvida skydd av barnförbjudet innehåll ska aktiveras av Spam Scanner på den här domänen
has_phishing_protection	Nej	Boolean	Om du ska aktivera skydd mot nätfiske av skräppostskannern på den här domänen
has_executable_protection	Nej	Boolean	Om körbart skydd ska aktiveras av Spam Scanner på den här domänen
has_virus_protection	Nej	Boolean	Om du vill aktivera skräppostscanner-virusskydd på den här domänen
has_recipient_verification	Nej	Boolean	Global domän standard för om aliasmottagare ska behöva klicka på en e-postverifieringslänk för att e-post ska flöda igenom

Exempelförfrågan:

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

Hämta domän

GET /v1/domains/example.com

Exempelförfrågan:

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

Verifiera domänregister

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

Exempelförfrågan:

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

Uppdatera domän

PUT /v1/domains/example.com

Kroppsparameter	Nödvändig	Typ	Beskrivning
smtp_port	Nej	Sträng eller nummer	Anpassad port att konfigurera för SMTP-vidarebefordran (standard är "25")
has_adult_content_protection	Nej	Boolean	Huruvida skydd av barnförbjudet innehåll ska aktiveras av Spam Scanner på den här domänen
has_phishing_protection	Nej	Boolean	Om du ska aktivera skydd mot nätfiske av skräppostskannern på den här domänen
has_executable_protection	Nej	Boolean	Om körbart skydd ska aktiveras av Spam Scanner på den här domänen
has_virus_protection	Nej	Boolean	Om du vill aktivera skräppostscanner-virusskydd på den här domänen
has_recipient_verification	Nej	Boolean	Global domän standard för om aliasmottagare ska behöva klicka på en e-postverifieringslänk för att e-post ska flöda igenom

Exempelförfrågan:

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

Radera domän

DELETE /v1/domains/:domain_name

Exempelförfrågan:

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

Inbjudningskort

Acceptera domäninbjudan

GET /v1/domains/:domain_name/invites

Exempelförfrågan:

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

Skapa domäninbjudan

POST /v1/domains/example.com/invites

Kroppsparameter	Nödvändig	Typ	Beskrivning
email	Ja	String (e-post)	E-postadress för att bjuda in till listan med domänmedlemmar
group	Ja	Sträng (många)	Grupp att lägga till användaren till domänmedlemskapet med (kan vara en av "admin" eller "user")

Exempelförfrågan:

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

Ta bort domäninbjudan

DELETE /v1/domains/:domain_name/invites

Kroppsparameter	Nödvändig	Typ	Beskrivning
email	Ja	String (e-post)	E-postadress som ska tas bort från listan över domänmedlemmar

Exempelförfrågan:

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

medlemmar

Uppdatera domänmedlem

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

Kroppsparameter	Nödvändig	Typ	Beskrivning
group	Ja	Sträng (många)	Grupp att uppdatera användaren till domänmedlemskapet med (kan vara en av "admin" eller "user")

Exempelförfrågan:

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

Ta bort domänmedlem

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

Exempelförfrågan:

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

alias

Lista domänalias

GET /v1/domains/example.com/aliases

Querystring-parameter	Nödvändig	Typ	Beskrivning
name	Nej	String (RegExp stöds)	Sök efter alias i en domän efter namn
recipient	Nej	String (RegExp stöds)	Sök efter alias i en domän efter mottagare

Exempelförfrågan:

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

Skapa nytt domänalias

POST /v1/domains/example.com/aliases

Kroppsparameter	Nödvändig	Typ	Beskrivning
name	Ja	Sträng	Alias namn
recipients	Ja	Sträng eller array	Lista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser)
description	Nej	Sträng	Alias beskrivning
labels	Nej	Sträng eller array	Lista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array)
has_recipient_verification	Nej	Boolean	Huruvida det ska aktiveras för att kräva att mottagarna klickar på en e-postverifieringslänk för att e-post ska flöda igenom (standard för domänens inställning om det inte uttryckligen anges i förfrågans brödtext)
is_enabled	Nej	Boolean	Huruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder)

Exempelförfrågan:

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

Hämta domänalias

Du kan hämta ett domänalias med antingen dess id eller dess name värde.

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

Exempelförfrågan:

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

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

Exempelförfrågan:

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

Uppdatera domänalias

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

Kroppsparameter	Nödvändig	Typ	Beskrivning
name	Nej	Sträng	Alias namn
recipients	Ja	Sträng eller array	Lista över mottagare (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array med giltiga e-postadresser, fullt kvalificerade domännamn ("FQDN"), IP-adresser och / eller webbhook-webbadresser)
description	Nej	Sträng	Alias beskrivning
labels	Nej	Sträng eller array	Lista över etiketter (måste vara radbrytning / mellanslag / kommaseparerad sträng eller array)
has_recipient_verification	Nej	Boolean	Huruvida det ska aktiveras för att kräva att mottagarna klickar på en e-postverifieringslänk för att e-post ska flöda igenom (standard för domänens inställning om det inte uttryckligen anges i förfrågans brödtext)
is_enabled	Nej	Boolean	Huruvida att aktivera detta alias (om det är inaktiverat kommer e-postmeddelanden att dirigeras ingenstans men returnera framgångsrika statuskoder)

Exempelförfrågan:

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

Radera domänalias

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

Exempelförfrågan:

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