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 rubrik. 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.

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.

Om du vill bli meddelad när paginering är tillgänglig, vänligen maila api@forwardemail.net.

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"

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.

Lista e-postmeddelanden

Observera att denna slutpunkt inte returnerar ett redan skapat e-postmeddelande message, headers, accepted, inte heller rejectedErrors egenskaper.

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

Denna slutpunkt kommer som mest tillbaka 50 resultat åt gången. Om du vill fråga efter flera sidor, lägg till ?page=NUMBER var NUMBER är ett heltal, t.ex. ?page=1.

GET /v1/emails

Exempelförfrågan:

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

Skapa 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.

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 e-post

GET /v1/emails/:id

Exempelförfrågan:

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

Ta bort 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:

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

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:

Lista domänalias

GET /v1/domains/example.com/aliases

Exempelförfrågan:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: