E-post API

Just nu har vi ännu inte släppt några API-omslag, men vi planerar att göra det inom en snar framtid. Skicka ett mail till api@forwardemail.net om du vill bli meddelad när ett visst programmeringsspråks API-omslag släpps. Under tiden kan du använda dessa rekommenderade HTTP-förfrågningsbibliotek i din applikation, eller helt enkelt använda ringla som i exemplen nedan.

Den aktuella HTTP-bas-URI-sökvägen är: https://api.forwardemail.net.

Alla slutpunkter kräver din API-nyckel ställas in som "användarnamn"-värdet för begäran Grundläggande auktorisation header (med undantag för Alias kontakter, Alias kalendrar, och Alias brevlådor som använder en genererat alias användarnamn och lösenord)..

Oroa dig inte – exempel ges nedan för dig om du inte är säker på vad detta är.

Om några fel uppstår kommer svarstypen för API-begäran att innehålla ett detaljerat felmeddelande.

[!DRICKS] Om du får en 5xx-statuskod (vilket inte borde hända), vänligen kontakta oss på api@forwardemail.net och vi hjälper dig att lösa ditt problem omedelbart.

Vår tjänst är översatt till över 25 olika språk. Alla API-svarsmeddelanden översätts till den senast upptäckta lokalen för användaren som gör API-begäran. Du kan åsidosätta detta genom att skicka en anpassad Accept-Language rubrik. Testa gärna med hjälp av rullgardinsmenyn för språk längst ner på denna sida.

[!NOTERA] Från och med den 1 november 2024 är API-slutpunkterna för Lista domäner och Lista domänalias kommer som standard till 1000 max resultat per sida. Om du vill välja detta beteende tidigt kan du gå igenom ?paginate=true som en extra frågesträngsparameter till URL:en för ändpunktsfrågan.

Paginering stöds av alla API-slutpunkter som visar resultat.

Ange helt enkelt querystring-egenskaperna page (och valfritt limit).

Fastigheten page bör vara ett tal större än eller lika med 1. Om du tillhandahåller limit (också ett tal), då är minimivärdet 10 och maximum är 50 (om inget annat anges).

För att avgöra om fler resultat är tillgängliga eller inte, tillhandahåller vi dessa HTTP-svarsrubriker (som du kan tolka för att paginera programmatiskt):

Exempelförfrågan:

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

Hämta loggar

Vårt API låter dig programmässigt ladda ner loggar för ditt konto. Om du skickar en begäran till denna slutpunkt kommer alla loggar för ditt konto att bearbetas och du skickar dem via e-post som en bilaga (Gzip komprimerad CSV kalkylarksfil) när den är klar.

Detta gör att du kan skapa bakgrundsjobb med en Cron jobb eller använder vår Node.js jobbschemaläggningsprogram Bree att ta emot loggar när du vill. Observera att denna slutpunkt är begränsad till 10 förfrågningar per dag.

Bilagan är en gemen form av email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz och själva e-postmeddelandet innehåller en kort sammanfattning av loggarna som hämtats. Du kan också ladda ner loggar när som helst från Mitt konto → Loggar

GET /v1/logs/download

Exempelförfrågan:

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

Exempel på Cron-jobb (vid midnatt varje dag):

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

Observera att du kan använda tjänster som t.ex Crontab.guru för att validera syntaxen för ditt cron-jobbuttryck.

Exempel på Cron-jobb (vid midnatt varje dag och med loggar för föregående dag):

För 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

För Linux och 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

Skapa konto

POST /v1/account

Exempelförfrågan:

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

Hämta konto

GET /v1/account

Exempelförfrågan:

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

Uppdatera konto

PUT /v1/account

Exempelförfrågan:

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

[!NOTERA] Till skillnad från andra API-slutpunkter kräver dessa autentisering "användarnamn" lika med alias användarnamn och "lösenord" lika med det alias genererade lösenordet som Basic Authorization headers.

[!VARNING] Denna slutpunktssektion är ett pågående arbete och kommer att släppas (förhoppningsvis) 2024. Under tiden, använd en IMAP-klient från rullgardinsmenyn "Appar" i navigeringen på vår webbplats.

[!NOTE] CardDAV-stöd är ännu inte tillgängligt, följ denna diskussion på GitHub för uppdateringar.

Lista kontakter

GET /v1/contacts

Kommer snart

Skapa kontakt

POST /v1/contacts

Kommer snart

Hämta kontakt

GET /v1/contacts/:id

Kommer snart

Uppdatera kontakt

PUT /v1/contacts/:id

Kommer snart

Ta bort kontakt

DELETE /v1/contacts/:id

Kommer snart

[!NOTERA] Till skillnad från andra API-slutpunkter kräver dessa autentisering "användarnamn" lika med alias användarnamn och "lösenord" lika med det alias genererade lösenordet som Basic Authorization headers.

[!VARNING] Denna slutpunktssektion är ett pågående arbete och kommer att släppas (förhoppningsvis) 2024. Under tiden, använd en IMAP-klient från rullgardinsmenyn "Appar" i navigeringen på vår webbplats.

Lista kalendrar

GET /v1/calendars

Kommer snart

Skapa kalender

POST /v1/calendars

Kommer snart

Hämta kalender

GET /v1/calendars/:id

Kommer snart

Uppdatera kalender

PUT /v1/calendars/:id

Kommer snart

Ta bort kalender

DELETE /v1/calendars/:id

Kommer snart

[!NOTERA] Till skillnad från andra API-slutpunkter kräver dessa autentisering "användarnamn" lika med alias användarnamn och "lösenord" lika med det alias genererade lösenordet som Basic Authorization headers.

[!VARNING] Denna slutpunktssektion är ett pågående arbete och kommer att släppas (förhoppningsvis) 2024. Under tiden, använd en IMAP-klient från rullgardinsmenyn "Appar" i navigeringen på vår webbplats.

Se till att du har följt installationsinstruktionerna för din domän.

Dessa instruktioner finns i vår FAQ-sektion Stöder du att ta emot e-post med IMAP?.

Lista och sök efter meddelanden

GET /v1/messages

Kommer snart

Skapa meddelande

[!NOTERA] Detta kommer NOT skicka ett e-postmeddelande – det kommer bara att lägga till meddelandet i din brevlådemapp (t.ex. liknar det IMAP APPEND kommando). Om du vill skicka ett e-postmeddelande, se då Skapa utgående SMTP-e-post nedan. När du har skapat den utgående SMTP-e-posten kan du lägga till en kopia av den med denna slutpunkt till ditt alias brevlåda för lagringsändamål.

POST /v1/messages

Kommer snart

Hämta meddelande

GET /v1/messages/:id

Kommer snart

Uppdatera meddelande

PUT /v1/messages/:id

Kommer snart

Ta bort meddelande

DELETE /v1/messages:id

Kommer snart

[!DRICKS] Mappslutpunkter med en mapps sökväg /v1/folders/:path eftersom deras slutpunkt är utbytbara med en mapps ID :id. Detta innebär att du kan referera till mappen med antingen dess path eller id värde.

[!VARNING] Denna slutpunktssektion är ett pågående arbete och kommer att släppas (förhoppningsvis) 2024. Under tiden, använd en IMAP-klient från rullgardinsmenyn "Appar" i navigeringen på vår webbplats.

Lista mappar

GET /v1/folders

Kommer snart

Skapa mapp

POST /v1/folders

Kommer snart

Hämta mapp

GET /v1/folders/:id

Kommer snart

Uppdatera mapp

PUT /v1/folders/:id

Kommer snart

Ta bort mapp

DELETE /v1/folders/:id

Kommer snart

Kopiera mapp

POST /v1/folders/:id/copy

Kommer snart

Se till att du har följt installationsinstruktionerna för din domän.

Dessa instruktioner finns på Mitt konto → Domäner → Inställningar → Utgående SMTP-konfiguration. Du måste säkerställa installationen av DKIM, Return-Path och DMARC för att skicka utgående SMTP med din domän.

Få utgående SMTP-e-postgräns

Detta är en enkel slutpunkt som returnerar ett JSON-objekt som innehåller count och limit för antalet dagliga utgående SMTP-meddelanden per konto.

GET /v1/emails/limit

Exempelförfrågan:

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

Lista utgående SMTP-e-postmeddelanden

Observera att denna slutpunkt inte returnerar egenskapsvärden för ett e-postmeddelande message, headers, inte heller rejectedErrors.

För att returnera dessa egenskaper och deras värden, använd Hämta e-post slutpunkt med ett e-post-ID.

GET /v1/emails

Exempelförfrågan:

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

Skapa utgående SMTP-e-post

Vårt API för att skapa ett e-postmeddelande är inspirerat av och utnyttjar Nodemailers meddelandealternativkonfiguration. Vänligen hänvisa till Nodemailer-meddelandekonfiguration för alla kroppsparametrar nedan.

Observera att med undantag för envelope och dkim (eftersom vi ställer in dem automatiskt åt dig) stöder vi alla Nodemailer-alternativ. Vi ställer in automatiskt disableFileAccess och disableUrlAccess alternativ till true av säkerhetsskäl.

Du bör antingen passera det enda alternativet raw med din råa fullständiga e-post inklusive rubriker eller skicka individuella kroppsparameteralternativ nedan.

Denna API-slutpunkt kommer automatiskt att koda emojis åt dig om de finns i rubrikerna (t.ex. en ämnesrad för Subject: 🤓 Hello konverteras till Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello automatiskt). Vårt mål var att skapa ett extremt utvecklarvänligt och dummysäkert e-post-API.

POST /v1/emails

Exempelförfrågan:

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"

Exempelförfrågan:

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

Hämta utgående SMTP-e-post

GET /v1/emails/:id

Exempelförfrågan:

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

Ta bort utgående SMTP-e-post

Radering av e-post kommer att ställa in statusen till "rejected" (och därefter inte bearbeta det i kön) om och bara om den aktuella statusen är en av "pending", "queued", eller "deferred". Vi kan rensa e-postmeddelanden automatiskt efter 30 dagar efter att de skapades och/eller skickades – därför bör du behålla en kopia av utgående SMTP-e-postmeddelanden i din klient, databas eller applikation. Du kan referera till vårt e-post-ID-värde i din databas om så önskas – detta värde returneras från båda Skapa e-post och Hämta e-post slutpunkter.

DELETE /v1/emails/:id

Exempelförfrågan:

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

[!DRICKS] Domänändpunkter med ett domännamn /v1/domains/:domain_name eftersom deras slutpunkt är utbytbara med en domäns ID :domain_id. Detta innebär att du kan referera till domänen med antingen dess name eller id värde.

Lista domäner

[!NOTERA] Från och med den 1 november 2024 är API-slutpunkterna för Lista domäner och Lista domänalias kommer som standard till 1000 max resultat per sida. Om du vill välja detta beteende tidigt kan du gå igenom ?paginate=true som en extra frågesträngsparameter till URL:en för ändpunktsfrågan. Se Paginering för mer insikt.

GET /v1/domains

Exempelförfrågan:

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

Skapa domän

POST /v1/domains

Exempelförfrågan:

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

Hämta domän

GET /v1/domains/example.com

Exempelförfrågan:

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

Verifiera domänregister

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

Exempelförfrågan:

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

Uppdatera domän

PUT /v1/domains/example.com

Exempelförfrågan:

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

Radera domän

DELETE /v1/domains/:domain_name

Exempelförfrågan:

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

Acceptera domäninbjudan

GET /v1/domains/:domain_name/invites

Exempelförfrågan:

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

Skapa domäninbjudan

POST /v1/domains/example.com/invites

Exempelförfrågan:

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

[!VIKTIG] Om användaren som bjuds in redan är en accepterad medlem av någon annan domän som administratören som bjuder in dem är medlem i, kommer den att automatiskt acceptera inbjudan och inte skicka ett e-postmeddelande.

Ta bort domäninbjudan

DELETE /v1/domains/:domain_name/invites

Exempelförfrågan:

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

Uppdatera domänmedlem

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

Exempelförfrågan:

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

Ta bort domänmedlem

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

Exempelförfrågan:

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

Skapa ett aliaslösenord

Observera att om du inte skickar instruktioner via e-post kommer användarnamnet och lösenordet att finnas i JSON-svartexten för en lyckad begäran i formatet { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Exempelförfrågan:

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

Lista domänalias

[!NOTERA] Från och med den 1 november 2024 är API-slutpunkterna för Lista domäner och Lista domänalias kommer som standard till 1000 max resultat per sida. Om du vill välja detta beteende tidigt kan du gå igenom ?paginate=true som en extra frågesträngsparameter till URL:en för ändpunktsfrågan. Se Paginering för mer insikt.

GET /v1/domains/example.com/aliases

Exempelförfrågan:

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

Skapa nytt domänalias

POST /v1/domains/example.com/aliases

Exempelförfrågan:

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

Hämta domänalias

Du kan hämta ett domänalias med antingen dess id eller dess name värde.

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

Exempelförfrågan:

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

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

Exempelförfrågan:

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

Uppdatera domänalias

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

Exempelförfrågan:

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

Radera domänalias

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

Exempelförfrågan:

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

Vi tillåter dig att kryptera poster även på gratisplanen utan kostnad. Sekretess ska inte vara en funktion, den ska vara inbyggd i alla aspekter av en produkt. Som mycket efterfrågat i en Diskussion om sekretessguider och igen våra GitHub-problem vi har lagt till detta.

Kryptera TXT-post

POST /v1/encrypt

Exempelförfrågan:

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