- Søkeside
- Innholdsfortegnelse
E-post API
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 (vi er vedlikeholdere) |
node.js | superagent (vi er vedlikeholdere) |
Gå | net / http |
.NET | RestSharp |
Base URIer
Gjeldende HTTP-base URI-bane er: https://api.forwardemail.net
.
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 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"
E-poster
Sørg for at du har fulgt oppsettinstruksjonene for domenet ditt. Disse instruksjonene finner du på Min konto → Domener → Innstillinger → Utgående SMTP-konfigurasjon. Du må sørge for oppsett av DKIM, Return-Path og DMARC for å sende utgående SMTP med domenet ditt.
List e-poster
Merk at dette endepunktet ikke returnerer en allerede opprettet e-post message
, headers
, accepted
, eller rejectedErrors
egenskaper.
For å returnere disse egenskapene og deres verdier, vennligst bruk Hent e-post endepunkt med en e-post-ID.
Dette endepunktet vil komme tilbake på det meste 50
resultater om gangen. Hvis du vil spørre etter flere sider, legg til ?page=NUMBER
hvor NUMBER
er et heltall, f.eks. ?page=1
.
GET /v1/emails
Querystring-parameter | Må | Type | Beskrivelse |
---|---|---|---|
q | Nei | String (RegExp støttes) | Søk etter e-poster etter metadata |
domain | Nei | String (RegExp støttes) | Søk etter e-poster etter domenenavn |
page | Nei | Antall | Side for å returnere resultater (standard er 1 ) |
`grense | Nei | Antall | Antall resultater per side som skal returneres (standard er 50 – maks er 50 og minimum er 10 ) |
Eksempel forespørsel:
curl https://api.forwardemail.net/v1/emails \
-u API_TOKEN:
Opprett e-post
Vår API for å lage en e-post er inspirert av og utnytter Nodemailers meldingsalternativkonfigurasjon. Vennligst utsett til Nodemailer-meldingskonfigurasjon for alle kroppsparametere nedenfor.
Merk at med unntak av envelope
og dkim
(siden vi angir disse automatisk for deg), støtter vi alle Nodemailer-alternativer. Vi setter automatisk disableFileAccess
og disableUrlAccess
alternativer til true
av sikkerhetshensyn.
Du bør enten passere enkeltalternativet raw
med hele e-posten din inkludert overskrifter eller passere individuelle kroppsparameteralternativer nedenfor.
POST /v1/emails
Kroppsparameter | Må | Type | Beskrivelse |
---|---|---|---|
from | Nei | Streng (e-post) | E-postadressen til avsenderen (må eksistere som et alias for domenet). |
to | Nei | String eller Array | Kommaseparert liste eller en rekke mottakere for "Til"-overskriften. |
cc | Nei | String eller Array | Kommaseparert liste eller en rekke mottakere for "Cc"-overskriften. |
bcc | Nei | String eller Array | Kommadelt liste eller en rekke mottakere for "Blindkopi"-overskriften. |
subject | Nei | string | Emnet for e-posten. |
text | Nei | String eller buffer | Klartekstversjonen av meldingen. |
html | Nei | String eller buffer | HTML-versjonen av meldingen. |
attachments | Nei | Array | En rekke vedleggsobjekter (se Nodemailers vanlige felt). |
sender | Nei | string | E-postadressen for "Avsender"-overskriften (se Nodemailers mer avanserte felt). |
replyTo | Nei | string | E-postadressen for "Svar til"-overskriften. |
inReplyTo | Nei | string | Meldings-ID-en meldingen er et svar på. |
references | Nei | String eller Array | Mellomromseparert liste eller en rekke meldings-ID-er. |
attachDataUrls | Nei | boolean | Hvis true så konverterer data: bilder i HTML-innholdet i meldingen til innebygde vedlegg. |
watchHtml | Nei | string | En Apple Watch-spesifikk HTML-versjon av meldingen (ifølge Nodemailer-dokumentene, de nyeste klokkene krever ikke at dette stilles inn). |
amp | Nei | string | En AMP4EMAIL-spesifikk HTML-versjon av meldingen (se Nodemailers eksempel). |
icalEvent | Nei | Gjenstand | En iCalendar-hendelse å bruke som et alternativt meldingsinnhold (se Nodemailers kalenderhendelser). |
alternatives | Nei | Array | En rekke alternativt meldingsinnhold (se Nodemailers alternative innhold). |
encoding | Nei | string | Koding for tekst- og HTML-strengene (standard til "utf-8" , men støtter "hex" og "base64" kodingsverdier også). |
raw | Nei | String eller buffer | En tilpasset generert RFC822-formatert melding som skal brukes (i stedet for en som er generert av Nodemailer – se Nodemailers egendefinerte kilde). |
textEncoding | Nei | string | Koding som er tvunget til å brukes for tekstverdier (enten "quoted-printable" eller "base64" ). Standardverdien er den nærmeste verdien som er oppdaget (for ASCII-bruk "quoted-printable" ). |
priority | Nei | string | Prioritetsnivå for e-posten (kan enten være "high" , "normal" (standard), eller "low" ). Merk at en verdi på "normal" angir ikke en prioritert overskrift (dette er standard oppførsel). Hvis en verdi på "high" eller "low" er satt, deretter X-Priority , X-MSMail-Priority , og Importance overskrifter vil bli satt tilsvarende. |
headers | Nei | Objekt eller Array | Et objekt eller en rekke ekstra overskriftsfelt å angi (se Nodemailers egendefinerte overskrifter). |
messageId | Nei | string | En valgfri Message-ID-verdi for "Message-ID"-overskriften (en standardverdi opprettes automatisk hvis den ikke er angitt – merk at verdien skal følge RFC2822-spesifikasjonen). |
date | Nei | String eller dato | En valgfri Dato-verdi som vil bli brukt hvis Date-overskriften mangler etter parsing, ellers vil gjeldende UTC-streng bli brukt hvis den ikke er angitt. Datooverskriften kan ikke være mer enn 30 dager før gjeldende tid. |
list | Nei | Gjenstand | Et valgfritt objekt av List-* overskrifter (se Nodemailers listeoverskrifter). |
Eksempel forespørsel:
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"
Eksempel forespørsel:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "raw=`cat file.eml`"
Hent e-post
GET /v1/emails/:id
Eksempel forespørsel:
curl https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Slett e-post
Sletting av e-post vil sette statusen til "rejected"
(og senere ikke behandle det i køen) hvis og bare hvis gjeldende status er en av "pending"
, "queued"
, eller "deferred"
. Vi kan fjerne e-poster automatisk etter 30 dager etter at de ble opprettet og/eller sendt – derfor bør du beholde en kopi av utgående SMTP-e-poster i klienten, databasen eller applikasjonen din. Du kan referere til vår e-post-ID-verdi i databasen din om ønskelig – denne verdien returneres fra begge Opprett e-post og Hent e-post endepunkter.
DELETE /v1/emails/:id
Eksempel forespørsel:
curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
domener
/v1/domains/:domain_name
siden deres bane kan byttes ut med et domenes ID :domain_id
. Dette betyr at du kan referere til domenet ved enten dets name
eller id
verdi.
Liste domener
GET /v1/domains
Querystring-parameter | Må | Type | Beskrivelse |
---|---|---|---|
q | Nei | String (RegExp støttes) | Søk etter domener etter navn |
name | Nei | String (RegExp støttes) | Søk etter domener etter navn |
Eksempel forespørsel:
curl 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 https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Bekreft domeneregistreringer
GET /v1/domains/example.com/verify-records
Eksempel forespørsel:
curl 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 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 |
---|---|---|---|
q | Nei | String (RegExp støttes) | Søk etter aliaser i et domene etter navn, etikett eller mottaker |
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 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 | Nei | string | Aliasnavn (hvis det ikke er oppgitt eller tomt, genereres et tilfeldig alias) |
recipients | Nei | String eller Array | Liste over mottakere (må være linjeskift/mellomrom/kommaseparert streng eller matrise med gyldige e-postadresser, fullt kvalifiserte domenenavn ("FQDN"), IP-adresser og/eller webhook-URL-er – og hvis de ikke er oppgitt eller er tomme Array, vil brukerens e-post som sender API-forespørselen bli satt som mottaker) |
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 | Om du vil aktivere for å deaktivere dette aliaset (hvis det er deaktivert, vil e-poster ikke bli rutet noe sted, men returnere vellykkede statuskoder). Standard til true , men hvis en verdi passeres, konverteres den til en boolsk vha boolsk) |
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: