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

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.

Hvis du gerne vil have besked, når paginering er tilgængelig, så send en e-mail api@forwardemail.net.

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"

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.

Liste e-mails

Bemærk, at dette slutpunkt ikke returnerer en allerede oprettet e-mail message, headers, accepted, heller ikke rejectedErrors ejendomme.

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

Dette endepunkt vender højst tilbage 50 resultater ad gangen. Hvis du vil forespørge efter flere sider, skal du tilføje ?page=NUMBER hvor NUMBER er et heltal, f.eks. ?page=1.

GET /v1/emails

Eksempel på anmodning:

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

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

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

GET /v1/emails/:id

Eksempel på anmodning:

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

Slet 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:

Liste domæner

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

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:

Liste domænealiasser

GET /v1/domains/example.com/aliases

Eksempel på anmodning:

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