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 header (med unntak av Alias kontakter, Alias kalendere, og Alias postkasser som bruker en generert alias brukernavn og passord)..

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.

[!TUPP] Hvis du mottar en 5xx-statuskode (noe som ikke skal skje), vennligst kontakt oss på api@forwardemail.net og vi hjelper deg med å løse problemet umiddelbart.

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.

[!NOTE] Fra 1. november 2024 er API-endepunktene for Liste domener og List opp domenealiaser vil som standard 1000 maks resultater per side. Hvis du ønsker å melde deg på denne atferden tidlig, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL-en for endepunktspørringen.

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

Bare oppgi søkestrengegenskapene page (og eventuelt limit).

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

For å finne ut om flere resultater er tilgjengelige eller ikke, tilbyr vi disse HTTP-svarhodene (som du kan analysere for å paginere programmatisk):

Eksempel forespørsel:

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

Hent logger

Vår API programmert lar deg laste ned logger for kontoen din. Ved å sende inn en forespørsel til dette endepunktet vil alle logger for kontoen din behandles og sendes via e-post til deg som et vedlegg (Gzip komprimert CSV regnearkfil) når den er fullført.

Dette lar deg lage bakgrunnsjobber med en Cron jobb eller bruke vår Node.js jobbplanleggingsprogramvare Bree å motta logger når du måtte ønske 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

Eksempel forespørsel:

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

Eksempel 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 f.eks Crontab.guru for å validere syntaksen for cron jobbuttrykk.

Eksempel 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

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"

[!NOTE] I motsetning til andre API-endepunkter krever disse Godkjenning "brukernavn" lik aliasbrukernavnet og "passord" lik det aliasgenererte passordet som Basic Authorization-hoder.

[!ADVARSEL] Denne endepunktseksjonen er under arbeid og vil bli utgitt (forhåpentligvis) i 2024. I mellomtiden vennligst bruk en IMAP-klient fra rullegardinmenyen "Apper" i navigasjonen på nettstedet vårt.

[!NOTE] CardDAV-støtte er ennå ikke tilgjengelig, følg denne diskusjonen på GitHub for oppdateringer.

Liste 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

[!NOTE] I motsetning til andre API-endepunkter krever disse Godkjenning "brukernavn" lik aliasbrukernavnet og "passord" lik det aliasgenererte passordet som Basic Authorization-hoder.

[!ADVARSEL] Denne endepunktseksjonen er under arbeid og vil bli utgitt (forhåpentligvis) i 2024. I mellomtiden vennligst bruk en IMAP-klient fra rullegardinmenyen "Apper" i navigasjonen på nettstedet vårt.

Liste kalendere

GET /v1/calendars

Kommer snart

Lag kalender

POST /v1/calendars

Kommer snart

Hent kalender

GET /v1/calendars/:id

Kommer snart

Oppdater kalenderen

PUT /v1/calendars/:id

Kommer snart

Slett kalender

DELETE /v1/calendars/:id

Kommer snart

[!NOTE] I motsetning til andre API-endepunkter krever disse Godkjenning "brukernavn" lik aliasbrukernavnet og "passord" lik det aliasgenererte passordet som Basic Authorization-hoder.

[!ADVARSEL] Denne endepunktseksjonen er under arbeid og vil bli utgitt (forhåpentligvis) i 2024. I mellomtiden vennligst bruk en IMAP-klient fra rullegardinmenyen "Apper" i navigasjonen på nettstedet vårt.

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

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

List og søk etter meldinger

GET /v1/messages

Kommer snart

Lag melding

[!NOTE] Dette vil NOT send en e-post – den vil bare legge til meldingen i postboksmappen din (dette ligner for eksempel på IMAP APPEND kommando). Hvis du vil sende en e-post, så se Opprett utgående SMTP-e-post under. Etter å ha opprettet den utgående SMTP-e-posten, kan du legge til en kopi av den ved å bruke dette endepunktet til aliasets postkasse for lagringsformål.

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

[!TUPP] Mappeendepunkter med en mappes bane /v1/folders/:path ettersom endepunktet deres kan byttes ut med en mappes ID :id. Dette betyr at du kan referere til mappen ved enten dens path eller id verdi.

[!ADVARSEL] Denne endepunktseksjonen er under arbeid og vil bli utgitt (forhåpentligvis) i 2024. I mellomtiden vennligst bruk en IMAP-klient fra rullegardinmenyen "Apper" i navigasjonen på nettstedet vårt.

List 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 mappe

DELETE /v1/folders/:id

Kommer snart

Kopier mappe

POST /v1/folders/:id/copy

Kommer snart

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.

Få utgående SMTP-e-postgrense

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

Eksempel forespørsel:

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

List ut utgående SMTP-e-poster

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

For å returnere disse egenskapene og deres verdier, vennligst bruk Hent e-post endepunkt med en e-post-ID.

GET /v1/emails

Eksempel forespørsel:

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

Opprett utgående SMTP-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.

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

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 utgående SMTP-e-post

GET /v1/emails/:id

Eksempel forespø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 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:

[!TUPP] Domeneendepunkter med et domenenavn /v1/domains/:domain_name ettersom endepunktet deres 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

[!NOTE] Fra 1. november 2024 er API-endepunktene for Liste domener og List opp domenealiaser vil som standard 1000 maks resultater per side. Hvis du ønsker å melde deg på denne atferden tidlig, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL-en for endepunktspørringen. Se paginering for mer innsikt.

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

[!VIKTIG] Hvis brukeren som blir invitert allerede er et akseptert medlem av andre domener administratoren som inviterer vedkommende er medlem av, vil den automatisk godta invitasjonen og ikke sende en e-post.

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:

Generer et aliaspassord

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

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

Eksempel forespørsel:

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

List opp domenealiaser

[!NOTE] Fra 1. november 2024 er API-endepunktene for Liste domener og List opp domenealiaser vil som standard 1000 maks resultater per side. Hvis du ønsker å melde deg på denne atferden tidlig, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL-en for endepunktspørringen. Se paginering for mer innsikt.

GET /v1/domains/example.com/aliases

Eksempel forespø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

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:

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

Krypter TXT-post

POST /v1/encrypt

Eksempel forespørsel:

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