E-post API

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.

Gjeldende HTTP-base URI-bane er: https://api.forwardemail.net.

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.

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

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.

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

Opprett konto

POST /v1/account

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

Eksempel forespørsel:

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

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

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

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:

Liste domener

GET /v1/domains

Eksempel forespørsel:

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

Opprett domene

POST /v1/domains

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

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:

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

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

Eksempel forespørsel:

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

Oppdater domenemedlem

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

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:

List opp domenealiaser

GET /v1/domains/example.com/aliases

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

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

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: