API-videresending av e-post

Innholdsfortegnelse

• biblioteker
• Base URI
• Godkjenning
• feil
• lokalisering
• paginering
• Regnskap
  • Opprett konto
  • Hent konto
  • Oppdater konto
• domener
  • Liste domener
  • Opprett domene
  • Hent domenet
  • Bekreft domeneregistreringer
  • Oppdater domenet
  • Slett domenet
• inviterer
  • Godta domeneinvitasjon
  • Opprett domeneinvitasjon
  • Fjern domeneinvitasjon
• medlemmer
  • Oppdater domenemedlem
  • Fjern domenemedlem
• aliaser
  • List opp domenealiaser
  • Opprett nytt domenealias
  • Hent domenealias
  • Oppdater domenealias
  • Slett domenealias

biblioteker

Akkurat nå har vi ennå ikke gitt ut noen API-innpakninger, men vi planlegger å gjøre det i nær fremtid. Send en e-post til api@forwardemail.net hvis du ønsker å bli varslet når et bestemt programmeringsspråks API-omslag er utgitt. I mellomtiden kan du bruke disse anbefalte HTTP-forespørselsbibliotekene i applikasjonen din, eller ganske enkelt bruke krølle som i eksemplene nedenfor.

Språk	Bibliotek
Rubin	Faraday
Python	forespørsler
Java	OkHttp
PHP	dyse
Javascript	superagent
node.js	superagent
Gå	net / http
.NET	RestSharp

Base URI

Gjeldende HTTP-base URI-bane er: https://api.forwardemail.net. Den eldre HTTP-base-URI-banen til https://forwardemail.net:4000 er avviklet fra 1. januar 2021.

Godkjenning

Alle endepunkter krever din API-nøkkel settes som "brukernavn"-verdien for forespørselen Grunnleggende autorisasjon Overskrift. Ikke bekymre deg – eksempler er gitt nedenfor for deg hvis du ikke er sikker på hva dette er.

feil

Hvis det oppstår feil, vil svaret på API-forespørselen inneholde en detaljert feilmelding.

Kode	Navn
200	OK
400	Dårlig forespørsel
401	uautorisert
403	Forbudt
404	Ikke funnet
429	For mange forespørsler
500	intern server feil
501	Ikke implementert
502	Dårlig gateway
503	Tjenesten utilgjengelig
504	Gateway Time-out

lokalisering

Tjenesten vår er oversatt til over 25 forskjellige språk. Alle API-svarmeldinger blir oversatt til den siste lokaliteten som ble oppdaget av brukeren som sender API-forespørselen. Du kan overstyre dette ved å sende en egendefinert Accept-Language Overskrift. Prøv den gjerne ved å bruke språkrullegardinmenyen nederst på denne siden.

paginering

Hvis du ønsker å bli varslet når paginering er tilgjengelig, vennligst send en e-post api@forwardemail.net.

Regnskap

Opprett konto

POST /v1/account

Kroppsparameter	Må	Type	Beskrivelse
email	Ja	Streng (e-post)	Epostadresse
password	Ja	string	Passord

Eksempel forespørsel:

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

Hent konto

GET /v1/account

Eksempel forespørsel:

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

Oppdater konto

PUT /v1/account

Kroppsparameter	Må	Type	Beskrivelse
email	Nei	Streng (e-post)	Epostadresse
given_name	Nei	string	Fornavn
family_name	Nei	string	Etternavn
avatar_url	Nei	Streng (URL)	Link til avatarbilde

Eksempel forespørsel:

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

domener

Liste domener

GET /v1/domains

Querystring-parameter	Må	Type	Beskrivelse
name	Nei	String (RegExp støttes)	Søk etter domener etter navn
alias	Nei	String (RegExp støttes)	Søk etter domener etter aliasnavn
recipient	Nei	String (RegExp støttes)	Søk etter domener etter mottaker

Eksempel forespørsel:

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

Opprett domene

POST /v1/domains

Kroppsparameter	Må	Type	Beskrivelse
domain	Ja	Streng (FQDN eller IP)	Fullt kvalifisert domenenavn ("FQDN") eller IP-adresse
plan	Nei	Streng (tallbar)	Plantype (må være "free", "enhanced_protection", eller "team", er standard til "free" eller brukerens gjeldende betalte plan hvis på en)
catchall	Nei	Streng (avgrenset e-postadresse) eller boolsk	Opprett et standard oppsamlingsalias, standard til true (hvis true den vil bruke API-brukerens e-postadresse som mottaker, og hvis false ingen catch-all vil bli opprettet). Hvis en streng sendes, er det en avgrenset liste over e-postadresser som skal brukes som mottakere (atskilt med linjeskift, mellomrom og/eller komma)
has_adult_content_protection	Nei	boolean	Hvorvidt du skal aktivere Spam Scanner beskyttelse mot voksent innhold på dette domenet
has_phishing_protection	Nei	boolean	Om du skal aktivere nettfiskingsbeskyttelse for spamskanner på dette domenet
has_executable_protection	Nei	boolean	Hvorvidt du skal aktivere Spam Scanner kjørbar beskyttelse på dette domenet
has_virus_protection	Nei	boolean	Om du skal aktivere Spam Scanner-virusbeskyttelse på dette domenet
has_recipient_verification	Nei	boolean	Globalt domene standard for om aliasmottakere skal kreve å klikke på en e-postbekreftelseslenke for at e-poster skal strømme gjennom

Eksempel forespørsel:

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

Hent domenet

GET /v1/domains/example.com

Eksempel forespørsel:

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

Bekreft domeneregistreringer

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

Eksempel forespørsel:

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

Oppdater domenet

PUT /v1/domains/example.com

Kroppsparameter	Må	Type	Beskrivelse
smtp_port	Nei	Streng eller nummer	Egendefinert port for å konfigurere for SMTP-videresending (standard er "25")
has_adult_content_protection	Nei	boolean	Hvorvidt du skal aktivere Spam Scanner beskyttelse mot voksent innhold på dette domenet
has_phishing_protection	Nei	boolean	Om du skal aktivere nettfiskingsbeskyttelse for spamskanner på dette domenet
has_executable_protection	Nei	boolean	Hvorvidt du skal aktivere Spam Scanner kjørbar beskyttelse på dette domenet
has_virus_protection	Nei	boolean	Om du skal aktivere Spam Scanner-virusbeskyttelse på dette domenet
has_recipient_verification	Nei	boolean	Globalt domene standard for om aliasmottakere skal kreve å klikke på en e-postbekreftelseslenke for at e-poster skal strømme gjennom

Eksempel forespørsel:

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

Slett domenet

DELETE /v1/domains/:domain_name

Eksempel forespørsel:

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

inviterer

Godta domeneinvitasjon

GET /v1/domains/:domain_name/invites

Eksempel forespørsel:

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

Opprett domeneinvitasjon

POST /v1/domains/example.com/invites

Kroppsparameter	Må	Type	Beskrivelse
email	Ja	Streng (e-post)	E-postadresse for å invitere til domenemedlemmelisten
group	Ja	Streng (tallbar)	Gruppe for å legge brukeren til domenemedlemskapet med (kan være en av "admin" eller "user")

Eksempel forespørsel:

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

Fjern domeneinvitasjon

DELETE /v1/domains/:domain_name/invites

Kroppsparameter	Må	Type	Beskrivelse
email	Ja	Streng (e-post)	E-postadresse du vil fjerne fra listen over domenemedlemmer

Eksempel forespørsel:

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

medlemmer

Oppdater domenemedlem

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

Kroppsparameter	Må	Type	Beskrivelse
group	Ja	Streng (tallbar)	Gruppe å oppdatere brukeren til domenemedlemskapet med (kan være en av "admin" eller "user")

Eksempel forespørsel:

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

Fjern domenemedlem

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

Eksempel forespørsel:

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

aliaser

List opp domenealiaser

GET /v1/domains/example.com/aliases

Querystring-parameter	Må	Type	Beskrivelse
name	Nei	String (RegExp støttes)	Søk etter aliaser i et domene etter navn
recipient	Nei	String (RegExp støttes)	Søk etter aliaser i et domene etter mottaker

Eksempel forespørsel:

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

Opprett nytt domenealias

POST /v1/domains/example.com/aliases

Kroppsparameter	Må	Type	Beskrivelse
name	Ja	string	Alias navn
recipients	Ja	String eller Array	Liste over mottakere (må være linjeskift / mellomrom / komma-separert streng eller utvalg av gyldige e-postadresser, fullt kvalifiserte domenenavn ("FQDN"), IP-adresser og / eller nettadresser til nettkroken)
description	Nei	string	Alias beskrivelse
labels	Nei	String eller Array	Liste over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
has_recipient_verification	Nei	boolean	Om det skal aktiveres for å kreve at mottakerne klikker på en e-postbekreftelseslenke for at e-postene skal strømme gjennom (standardinnstillingen for domenet hvis den ikke er eksplisitt angitt i forespørselens tekst)
is_enabled	Nei	boolean	Hvorvidt du vil aktivere å deaktivere dette aliaset (hvis deaktivert, e-postmeldinger vil bli dirigert ingen steder men returnere vellykkede statuskoder)

Eksempel forespørsel:

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

Hent domenealias

Du kan hente et domenealias ved enten dets id eller dens name verdi.

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

Eksempel forespørsel:

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

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

Eksempel forespørsel:

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

Oppdater domenealias

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

Kroppsparameter	Må	Type	Beskrivelse
name	Nei	string	Alias navn
recipients	Ja	String eller Array	Liste over mottakere (må være linjeskift / mellomrom / komma-separert streng eller utvalg av gyldige e-postadresser, fullt kvalifiserte domenenavn ("FQDN"), IP-adresser og / eller nettadresser til nettkroken)
description	Nei	string	Alias beskrivelse
labels	Nei	String eller Array	Liste over etiketter (må være linjeskift / mellomrom / komma separert streng eller matrise)
has_recipient_verification	Nei	boolean	Om det skal aktiveres for å kreve at mottakerne klikker på en e-postbekreftelseslenke for at e-postene skal strømme gjennom (standardinnstillingen for domenet hvis den ikke er eksplisitt angitt i forespørselens tekst)
is_enabled	Nei	boolean	Hvorvidt du vil aktivere å deaktivere dette aliaset (hvis deaktivert, e-postmeldinger vil bli dirigert ingen steder men returnere vellykkede statuskoder)

Eksempel forespørsel:

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

Slett domenealias

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

Eksempel forespørsel:

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