E-post-API

Akkurat nå har vi ikke gitt ut noen API-wrappere, 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-wrapper blir utgitt. I mellomtiden kan du bruke disse anbefalte HTTP-forespørselsbibliotekene i applikasjonen din, eller ganske enkelt bruke krøll som i eksemplene nedenfor.

Den nåværende HTTP-basis-URI-banen er: https://api.forwardemail.net.

Alle endepunkter krever at API-nøkkel angis som "brukernavn"-verdien i forespørselens Grunnleggende autorisasjon-header (med unntak av Aliaskontakter, Aliaskalendere og Alias-postkasser som bruker en generert alias brukernavn og passord).

Ikke bekymre deg – eksempler er gitt nedenfor hvis du ikke er sikker på hva dette er.

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

Tjenesten vår er oversatt til over 25 forskjellige språk. Alle API-svarmeldinger oversettes til den siste språkinnstillingen som ble oppdaget for brukeren som sendte API-forespørselen. Du kan overstyre dette ved å sende en tilpasset Accept-Language-header. Prøv det gjerne ut ved hjelp av rullegardinmenyen for språk nederst på denne siden.

Paginering støttes av alle API-endepunkter som viser resultater.

Bare oppgi spørrestrengegenskapene page (og eventuelt limit).

Egenskapen page skal være et tall større enn eller lik 1. Hvis du oppgir limit (også et tall), er minimumsverdien 10 og maksimumsverdien 50 (med mindre annet er angitt).

For å avgjøre om det finnes flere resultater, tilbyr vi disse HTTP-svarhodene (som du kan analysere for å paginere programmatisk):

Eksempelforespørsel:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Hent logger

API-et vårt lar deg programmatisk laste ned logger for kontoen din. Hvis du sender en forespørsel til dette endepunktet, behandles alle loggene for kontoen din, og de sendes til deg som et vedlegg (Gzip komprimert CSV regnearkfil) når det er fullført.

Dette lar deg opprette bakgrunnsjobber med en Cron-jobb eller bruke vår Node.js jobbplanleggingsprogramvare Bree til å motta logger når du ønsker det. Merk at dette endepunktet er begrenset til 10 forespørsler per dag.

Vedlegget er en liten form av email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz, og selve e-posten inneholder et kort sammendrag av loggene som er hentet. Du kan også laste ned logger når som helst fra Min konto → Logger.

GET /v1/logs/download

Eksempelforespørsel:

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

Eksempel på Cron-jobb (ved midnatt hver dag):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Merk at du kan bruke tjenester som Crontab.guru for å validere syntaksen for cron-jobbens uttrykk.

Eksempel på Cron-jobb (ved midnatt hver dag og med logger for forrige dag):

For MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

For Linux og Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Opprett konto

POST /v1/account

Eksempelforespørsel:

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

Hent konto

GET /v1/account

Eksempelforespørsel:

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

Oppdater konto

PUT /v1/account

Eksempelforespørsel:

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

Liste over kontakter

GET /v1/contacts

Kommer snart

Opprett kontakt

POST /v1/contacts

Kommer snart

Hent kontakt

GET /v1/contacts/:id

Kommer snart

Oppdater kontakt

PUT /v1/contacts/:id

Kommer snart

Slett kontakt

DELETE /v1/contacts/:id

Kommer snart

Liste over kalendere

GET /v1/calendars

Kommer snart

Opprett kalender

POST /v1/calendars

Kommer snart

Hent kalender

GET /v1/calendars/:id

Kommer snart

Oppdater kalender

PUT /v1/calendars/:id

Kommer snart

Slett kalender

DELETE /v1/calendars/:id

Kommer snart

Sørg for at du har fulgt konfigurasjonsinstruksjonene for domenet ditt.

Disse instruksjonene finner du i FAQ-seksjonen vår Støtter dere mottak av e-post med IMAP?.

Vis og søk etter meldinger

GET /v1/messages

Kommer snart

Opprett melding

POST /v1/messages

Kommer snart

Hent melding

GET /v1/messages/:id

Kommer snart

Oppdater melding

PUT /v1/messages/:id

Kommer snart

Slett melding

DELETE /v1/messages:id

Kommer snart

Liste over mapper

GET /v1/folders

Kommer snart

Opprett mappe

POST /v1/folders

Kommer snart

Hent mappe

GET /v1/folders/:id

Kommer snart

Oppdater mappe

PUT /v1/folders/:id

Kommer snart

Slett mappen

DELETE /v1/folders/:id

Kommer snart

Kopier mappe

POST /v1/folders/:id/copy

Kommer snart

Sørg for at du har fulgt konfigurasjonsinstruksjonene for domenet ditt.

Disse instruksjonene finner du på Min konto → Domener → Innstillinger → Utgående SMTP-konfigurasjon. Du må sørge for at DKIM, Return-Path og DMARC er satt opp for å sende utgående SMTP med domenet ditt.

Hent grense for utgående SMTP-e-post

Dette er et enkelt endepunkt som returnerer et JSON-objekt som inneholder count og limit for antall daglige utgående SMTP-meldinger per konto.

GET /v1/emails/limit

Eksempelforespørsel:

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

Vis utgående SMTP-e-poster

Merk at dette endepunktet ikke returnerer egenskapsverdier for message, headers eller rejectedErrors i en e-post.

For å returnere disse egenskapene og verdiene deres, bruk Hent e-post-endepunktet med en e-post-ID.

GET /v1/emails

Eksempelforespørsel:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Opprett utgående SMTP-e-post

Vårt API for å opprette e-poster er inspirert av og utnytter Nodemailers konfigurasjon av meldingsalternativer. Vennligst referer til Konfigurasjon av Nodemailer-meldinger for alle brødtekstparametere nedenfor.

Merk at med unntak av envelope og dkim (siden vi angir disse automatisk for deg), støtter vi alle Nodemailer-alternativer. Vi angir automatisk disableFileAccess- og disableUrlAccess-alternativene til true av sikkerhetshensyn.

Du bør enten sende det enkle alternativet raw med den fullstendige e-posten din, inkludert overskrifter, eller sende individuelle alternativer for brødtekstparametere nedenfor.

Dette API-endepunktet vil automatisk kode emojier for deg hvis de finnes i overskriftene (f.eks. blir emnelinjen Subject: 🤓 Hello automatisk konvertert til Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Målet vårt var å lage et ekstremt utviklervennlig og dummy-sikkert e-post-API.

POST /v1/emails

Eksempelforespø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"

Eksempelforespørsel:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Hent utgående SMTP-e-post

GET /v1/emails/:id

Eksempelforespørsel:

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

Slett utgående SMTP-e-post

Sletting av e-post vil sette statusen til "rejected" (og deretter ikke behandle den i køen) hvis og bare hvis gjeldende status er en av "pending", "queued" eller "deferred". Vi kan slette e-poster automatisk 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 e-post-ID-verdien vår i databasen din hvis ønskelig – denne verdien returneres fra både Opprett e-post- og Hent e-post-endepunktene.

DELETE /v1/emails/:id

Eksempelforespørsel:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Liste over domener

GET /v1/domains

Eksempelforespørsel:

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

Opprett domene

POST /v1/domains

Eksempelforespørsel:

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

Hent domene

GET /v1/domains/example.com

Eksempelforespørsel:

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

Bekreft domeneoppføringer

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

Eksempelforespørsel:

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

Bekreft domenets SMTP-oppføringer

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

Eksempelforespørsel:

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

List opp domeneomfattende samlepassord

GET /v1/domains/example.com/catch-all-passwords

Eksempelforespørsel:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Opprett et domeneomfattende catch-all-passord

POST /v1/domains/example.com/catch-all-passwords

Eksempelforespørsel:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Fjern domeneomfattende catch-all-passord

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Eksempelforespørsel:

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

Oppdater domenet

PUT /v1/domains/example.com

Eksempelforespørsel:

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

Slett domenet

DELETE /v1/domains/:domain_name

Eksempelforespørsel:

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

Godta domeneinvitasjon

GET /v1/domains/:domain_name/invites

Eksempelforespørsel:

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

Opprett domeneinvitasjon

POST /v1/domains/example.com/invites

Eksempelforespø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

Eksempelforespø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

Eksempelforespø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

Eksempelforespørsel:

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

Generer et aliaspassord

Merk at hvis du ikke sender instruksjoner via e-post, vil brukernavnet og passordet være i JSON-svarinnholdet i en vellykket forespørsel i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Eksempelforespørsel:

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

Liste over domenealiaser

GET /v1/domains/example.com/aliases

Eksempelforespørsel:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Opprett nytt domenealias

POST /v1/domains/example.com/aliases

Eksempelforespørsel:

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

Hent domenealias

Du kan hente et domenealias enten ved hjelp av verdien id eller name.

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

Eksempelforespørsel:

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

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

Eksempelforespø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

Eksempelforespø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

Eksempelforespørsel:

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

Vi lar deg kryptere poster selv med gratisabonnementet uten kostnad. Personvern bør ikke være en funksjon, det bør være innebygd i alle aspekter av et produkt. Som sterkt etterspurt i en Diskusjon om personvernveiledninger og på våre GitHub-problemer har vi lagt til dette.

Krypter TXT-oppføring

POST /v1/encrypt

Eksempelforespørsel:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"