E-post-API

Just nu har vi inte släppt några API-omslag, men vi planerar att göra det inom en snar framtid. Skicka ett e-postmeddelande 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 nuvarande HTTP-bas-URI-sökvägen är: https://api.forwardemail.net.

Alla slutpunkter kräver att din API-nyckel anges som värdet "användarnamn" i begäranens Grundläggande auktorisering-rubrik (med undantag för Aliaskontakter, Aliaskalendrar och Alias-brevlådor som använder en genererat alias användarnamn och lösenord).

Oroa dig inte – exempel finns nedan om du är osäker på vad det här är.

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

Vår tjänst är översatt till över 25 olika språk. Alla API-svarsmeddelanden översätts till den senast identifierade språkinställningen för användaren som gjorde API-förfrågan. Du kan åsidosätta detta genom att skicka en anpassad Accept-Language-rubrik. Testa gärna med hjälp av språkmenyn längst ner på den här sidan.

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

Ange helt enkelt frågesträngegenskaperna page (och valfritt limit).

Egenskapen page ska vara ett tal större än eller lika med 1. Om du anger limit (också ett tal) är det minsta värdet 10 och det högsta värdet 50 (om inget annat anges).

För att avgöra om fler resultat finns tillgängliga tillhandahåller vi dessa HTTP-svarsrubriker (som du kan analysera 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 programmatiskt ladda ner loggar för ditt konto. Om du skickar en begäran till denna slutpunkt bearbetas alla loggar för ditt konto och skickas till dig via e-post som en bilaga (Gzip komprimerad CSV kalkylbladsfil) när den är klar.

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

Bilagan är i gemener för email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz och själva e-postmeddelandet innehåller en kort sammanfattning av de hämtade loggarna. 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 Crontab.guru för att validera syntaxen för ditt cron-jobb.

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"

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

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 kalendern

DELETE /v1/calendars/:id

Kommer snart

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

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

Lista och sök efter meddelanden

GET /v1/messages

Kommer snart

Skapa meddelande

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

Lista mappar

GET /v1/folders

Kommer snart

Skapa mapp

POST /v1/folders

Kommer snart

Hämta mapp

GET /v1/folders/:id

Kommer snart

Uppdatera mappen

PUT /v1/folders/:id

Kommer snart

Ta bort mappen

DELETE /v1/folders/:id

Kommer snart

Kopiera mapp

POST /v1/folders/:id/copy

Kommer snart

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

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

Hämta gräns för utgående SMTP-e-post

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-postmeddelandes message, headers eller rejectedErrors.

För att returnera dessa egenskaper och deras värden, använd slutpunkten Hämta e-post 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 använder Nodemailers konfiguration av meddelandealternativ. Vänligen hänvisa till Konfiguration av Nodemailer-meddelande för alla brödtextparametrar 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 automatiskt in alternativen disableFileAccess och disableUrlAccess till true av säkerhetsskäl.

Du bör antingen skicka det enda alternativet raw med din fullständiga råa e-postadress inklusive rubriker eller skicka individuella alternativ för brödtextparametern nedan.

Denna API-slutpunkt kommer automatiskt att koda emojis åt dig om de finns i rubrikerna (t.ex. konverteras ämnesraden Subject: 🤓 Hello automatiskt till Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). 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

Borttagning av e-postmeddelanden kommer att sätta statusen till "rejected" (och därefter inte bearbeta den i kön) om och endast om den aktuella statusen är en av "pending", "queued" eller "deferred". Vi kan komma att rensa e-postmeddelanden automatiskt 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åde 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:

Lista domäner

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änposter

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

Exempelförfrågan:

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

Verifiera domänens SMTP-poster

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

Exempelförfrågan:

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

Lista domänomfattande lösenord

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

Exempelförfrågan:

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

Skapa domänomfattande lösenord

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

Exempelförfrågan:

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

Ta bort domänomfattande lösenord

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

Exempelförfrågan:

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

Uppdatera domänen

PUT /v1/domains/example.com

Exempelförfrågan:

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

Ta bort domänen

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

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:

Generera ett aliaslösenord

Observera att om du inte skickar instruktioner via e-post kommer användarnamnet och lösenordet att finnas i JSON-svarstexten 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

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 antingen med hjälp av dess id- eller 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:

Ta bort 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 låter dig kryptera poster även med gratisplanen utan kostnad. Sekretess bör inte vara en funktion, den bör vara inbyggd i alla aspekter av en produkt. Som efterfrågats i Diskussion om sekretessguider och på våra GitHub-problem har vi 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"