Email API

Lige nu har vi endnu ikke udgivet nogen API-indpakning, men vi planlægger at gøre det i den nærmeste fremtid. Send en mail til api@forwardemail.net hvis du gerne vil have besked, når et bestemt programmeringssprogs API-indpakning frigives. I mellemtiden kan du bruge disse anbefalede HTTP-anmodningsbiblioteker i din applikation eller blot bruge krølle som i nedenstående eksempler.

Den aktuelle HTTP-basis-URI-sti er: https://api.forwardemail.net.

Alle endepunkter kræver din API nøgle skal indstilles som "brugernavn"-værdien for anmodningens Grundlæggende autorisation header (med undtagelse af Alias kontakter, Alias kalendere, og Alias postkasser som bruger en genereret alias brugernavn og adgangskode)..

Bare rolig – eksempler er givet nedenfor til dig, hvis du ikke er sikker på, hvad det er.

Hvis der opstår fejl, vil API-anmodningens svartekst indeholde en detaljeret fejlmeddelelse.

[!TIP] Hvis du modtager en 5xx statuskode (hvilket ikke burde ske), så kontakt os venligst på api@forwardemail.net og vi hjælper dig med at løse dit problem med det samme.

Vores service er oversat til over 25 forskellige sprog. Alle API-svarmeddelelser oversættes til den sidst registrerede lokalitet for den bruger, der foretager API-anmodningen. Du kan tilsidesætte dette ved at overføre en brugerdefineret Accept-Language header. Du er velkommen til at prøve det ved at bruge sprogrullemenuen nederst på denne side.

[!NOTE] Fra den 1. november 2024 er API-endepunkterne for Liste domæner og Liste domænealiasser vil som standard være 1000 max resultater pr. side. Hvis du gerne vil tilmelde dig denne adfærd tidligt, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL'en for slutpunktsforespørgslen.

Sideinddeling understøttes af alle API-endepunkter, der viser resultater.

Angiv blot forespørgselsstrengegenskaberne page (og eventuelt limit).

Ejendommen page skal være et tal større end eller lig med 1. Hvis du giver limit (også et tal), så er minimumsværdien 10 og maksimum er 50 (medmindre andet er angivet).

For at afgøre, om flere resultater er tilgængelige eller ej, leverer vi disse HTTP-svarheaders (som du kan parse for at paginere programmatisk):

Eksempel på anmodning:

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

Hent logfiler

Vores API giver dig programmatisk mulighed for at downloade logfiler til din konto. Indsendelse af en anmodning til dette slutpunkt vil behandle alle logfiler for din konto og e-maile dem til dig som en vedhæftet fil (Gzip komprimeret CSV regnearksfil), når den er fuldført.

Dette giver dig mulighed for at oprette baggrundsjob med en Cron job eller ved at bruge vores Node.js jobplanlægningssoftware Bree at modtage logs, når du ønsker det. Bemærk, at dette endepunkt er begrænset til 10 anmodninger om dagen.

Vedhæftningen er den lille form af email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz og selve e-mailen indeholder en kort oversigt over de hentede logfiler. Du kan også downloade logs til enhver tid fra Min konto → Logfiler

GET /v1/logs/download

Eksempel på anmodning:

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

Eksempel Cron job (ved midnat hver dag):

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

Bemærk at du kan bruge tjenester som f.eks Crontab.guru for at validere din cron job udtrykssyntaks.

Eksempel Cron job (ved midnat hver dag og med logs for foregående dag):

Til 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

Til 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

Opret konto

POST /v1/account

Eksempel på anmodning:

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

Hent konto

GET /v1/account

Eksempel på anmodning:

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

Opdater konto

PUT /v1/account

Eksempel på anmodning:

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

[!NOTE] I modsætning til andre API-endepunkter kræver disse Godkendelse "brugernavn" svarende til aliasbrugernavnet og "adgangskode" svarende til den aliasgenererede adgangskode som Basic Authorization-headers.

[!ADVARSEL] Denne endepunktssektion er et igangværende arbejde og vil blive frigivet (forhåbentlig) i 2024. I mellemtiden bedes du bruge en IMAP-klient fra rullemenuen "Apps" i navigationen på vores hjemmeside.

[!NOTE] CardDAV-support er endnu ikke tilgængelig, følg denne diskussion på GitHub for opdateringer.

Liste kontakter

GET /v1/contacts

Kommer snart

Opret kontakt

POST /v1/contacts

Kommer snart

Hent kontakt

GET /v1/contacts/:id

Kommer snart

Opdater kontakt

PUT /v1/contacts/:id

Kommer snart

Slet kontakt

DELETE /v1/contacts/:id

Kommer snart

[!NOTE] I modsætning til andre API-endepunkter kræver disse Godkendelse "brugernavn" svarende til aliasbrugernavnet og "adgangskode" svarende til den aliasgenererede adgangskode som Basic Authorization-headers.

[!ADVARSEL] Denne endepunktssektion er et igangværende arbejde og vil blive frigivet (forhåbentlig) i 2024. I mellemtiden bedes du bruge en IMAP-klient fra rullemenuen "Apps" i navigationen på vores hjemmeside.

Liste kalendere

GET /v1/calendars

Kommer snart

Opret kalender

POST /v1/calendars

Kommer snart

Hent kalender

GET /v1/calendars/:id

Kommer snart

Opdater kalender

PUT /v1/calendars/:id

Kommer snart

Slet kalender

DELETE /v1/calendars/:id

Kommer snart

[!NOTE] I modsætning til andre API-endepunkter kræver disse Godkendelse "brugernavn" svarende til aliasbrugernavnet og "adgangskode" svarende til den aliasgenererede adgangskode som Basic Authorization-headers.

[!ADVARSEL] Denne endepunktssektion er et igangværende arbejde og vil blive frigivet (forhåbentlig) i 2024. I mellemtiden bedes du bruge en IMAP-klient fra rullemenuen "Apps" i navigationen på vores hjemmeside.

Sørg for, at du har fulgt opsætningsinstruktionerne for dit domæne.

Disse instruktioner kan findes i vores FAQ-sektion Understøtter du modtagelse af e-mail med IMAP?.

Liste og søg efter beskeder

GET /v1/messages

Kommer snart

Opret besked

[!NOTE] Dette vil NOT send en e-mail - det vil kun tilføje beskeden til din postkassemappe (det ligner f.eks. IMAP'en APPEND kommando). Hvis du gerne vil sende en e-mail, så se Opret udgående SMTP-e-mail under. Når du har oprettet den udgående SMTP-e-mail, kan du tilføje en kopi af den ved hjælp af dette slutpunkt til dit alias' postkasse til opbevaringsformål.

POST /v1/messages

Kommer snart

Hent besked

GET /v1/messages/:id

Kommer snart

Opdater besked

PUT /v1/messages/:id

Kommer snart

Slet besked

DELETE /v1/messages:id

Kommer snart

[!TIP] Mappeslutpunkter med en mappes sti /v1/folders/:path da deres endepunkt kan udskiftes med en mappes ID :id. Dette betyder, at du kan henvise til mappen ved enten dens path eller id værdi.

[!ADVARSEL] Denne endepunktssektion er et igangværende arbejde og vil blive frigivet (forhåbentlig) i 2024. I mellemtiden bedes du bruge en IMAP-klient fra rullemenuen "Apps" i navigationen på vores hjemmeside.

Liste mapper

GET /v1/folders

Kommer snart

Opret mappe

POST /v1/folders

Kommer snart

Hent mappe

GET /v1/folders/:id

Kommer snart

Opdater mappe

PUT /v1/folders/:id

Kommer snart

Slet mappe

DELETE /v1/folders/:id

Kommer snart

Kopiér mappe

POST /v1/folders/:id/copy

Kommer snart

Sørg for, at du har fulgt opsætningsinstruktionerne for dit domæne.

Disse instruktioner kan findes på Min konto → Domæner → Indstillinger → Udgående SMTP-konfiguration. Du skal sikre opsætning af DKIM, Return-Path og DMARC for at sende udgående SMTP med dit domæne.

Få udgående SMTP-e-mail-grænse

Dette er et simpelt slutpunkt, der returnerer et JSON-objekt, der indeholder count og limit for antallet af daglige udgående SMTP-meddelelser pr. konto.

GET /v1/emails/limit

Eksempel på anmodning:

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

Liste udgående SMTP-e-mails

Bemærk, at dette slutpunkt ikke returnerer egenskabsværdier for en e-mail message, headers, heller ikke rejectedErrors.

For at returnere disse egenskaber og deres værdier skal du bruge Hent e-mail slutpunkt med et e-mail-id.

GET /v1/emails

Eksempel på anmodning:

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

Opret udgående SMTP-e-mail

Vores API til at oprette en e-mail er inspireret af og udnytter Nodemailers konfiguration af meddelelsesmuligheder. Henvis venligst til Nodemailer-meddelelseskonfiguration for alle kropsparametre nedenfor.

Bemærk, at med undtagelse af envelope og dkim (da vi indstiller dem automatisk for dig), understøtter vi alle Nodemailer-muligheder. Vi indstiller automatisk disableFileAccess og disableUrlAccess muligheder for at true af sikkerhedsmæssige årsager.

Du bør enten bestå den enkelte mulighed for raw med din rå fulde e-mail inklusive overskrifter eller videregive individuelle kropsparametre nedenfor.

Dette API-slutpunkt vil automatisk kode emojis for dig, hvis de findes i overskrifterne (f.eks. en emnelinje på Subject: 🤓 Hello bliver konverteret til Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automatisk). Vores mål var at lave en ekstremt udviklervenlig og dummy-sikker e-mail API.

POST /v1/emails

Eksempel på anmodning:

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 på anmodning:

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

Hent udgående SMTP-e-mail

GET /v1/emails/:id

Eksempel på anmodning:

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

Slet udgående SMTP-e-mail

Sletning af e-mail vil sætte status til "rejected" (og efterfølgende ikke behandle det i køen) hvis og kun hvis den aktuelle status er en af "pending", "queued", eller "deferred". Vi kan slette e-mails automatisk efter 30 dage efter de blev oprettet og/eller sendt – derfor bør du opbevare en kopi af udgående SMTP-e-mails i din klient, database eller applikation. Du kan referere til vores e-mail-id-værdi i din database, hvis det ønskes - denne værdi returneres fra begge Opret e-mail og Hent e-mail endepunkter.

DELETE /v1/emails/:id

Eksempel på anmodning:

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

[!TIP] Domæneendepunkter med et domænenavn /v1/domains/:domain_name da deres endepunkt kan udskiftes med et domænes ID :domain_id. Det betyder, at du kan henvise til domænet ved enten dets name eller id værdi.

Liste domæner

[!NOTE] Fra den 1. november 2024 er API-endepunkterne for Liste domæner og Liste domænealiasser vil som standard være 1000 max resultater pr. side. Hvis du gerne vil tilmelde dig denne adfærd tidligt, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL'en for slutpunktsforespørgslen. Se Sideinddeling for mere indsigt.

GET /v1/domains

Eksempel på anmodning:

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

Opret domæne

POST /v1/domains

Eksempel på anmodning:

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

Hent domæne

GET /v1/domains/example.com

Eksempel på anmodning:

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

Bekræft domæneregistreringer

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

Eksempel på anmodning:

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

Opdater domæne

PUT /v1/domains/example.com

Eksempel på anmodning:

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

Slet domæne

DELETE /v1/domains/:domain_name

Eksempel på anmodning:

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

Accepter domæneinvitation

GET /v1/domains/:domain_name/invites

Eksempel på anmodning:

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

Opret domæneinvitation

POST /v1/domains/example.com/invites

Eksempel på anmodning:

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

[!VIGTIG] Hvis brugeren, der inviteres, allerede er et accepteret medlem af andre domæner, som administratoren, der inviterer dem, er medlem af, vil den automatisk acceptere invitationen og ikke sende en e-mail.

Fjern domæneinvitation

DELETE /v1/domains/:domain_name/invites

Eksempel på anmodning:

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

Opdater domænemedlem

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

Eksempel på anmodning:

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

Fjern domænemedlem

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

Eksempel på anmodning:

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

Generer en alias adgangskode

Bemærk, at hvis du ikke sender instruktioner via e-mail, vil brugernavnet og adgangskoden være i JSON-svarteksten for en vellykket anmodning i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Eksempel på anmodning:

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

Liste domænealiasser

[!NOTE] Fra den 1. november 2024 er API-endepunkterne for Liste domæner og Liste domænealiasser vil som standard være 1000 max resultater pr. side. Hvis du gerne vil tilmelde dig denne adfærd tidligt, kan du bestå ?paginate=true som en ekstra querystring-parameter til URL'en for slutpunktsforespørgslen. Se Sideinddeling for mere indsigt.

GET /v1/domains/example.com/aliases

Eksempel på anmodning:

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

Opret nyt domænealias

POST /v1/domains/example.com/aliases

Eksempel på anmodning:

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

Hent domænealias

Du kan hente et domænealias ved enten dets id eller dens name værdi.

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

Eksempel på anmodning:

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

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

Eksempel på anmodning:

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

Opdater domænealias

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

Eksempel på anmodning:

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

Slet domænealias

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

Eksempel på anmodning:

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

Vi giver dig mulighed for at kryptere optegnelser selv på den gratis plan uden omkostninger. Privatlivets fred bør ikke være en funktion, det bør være indbygget i alle aspekter af et produkt. Som meget efterspurgt i en Diskussion om privatlivsguider og på vores GitHub-problemer vi har tilføjet dette.

Krypter TXT Record

POST /v1/encrypt

Eksempel på anmodning:

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