E-mail-API

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

Den nuværende HTTP-basis-URI-sti er: https://api.forwardemail.net.

Alle slutpunkter kræver, at din API-nøgle er angivet som "brugernavn"-værdien i anmodningens Grundlæggende autorisation-header (med undtagelse af Aliaskontakter, Aliaskalendere og Alias-postkasser, som bruger en genereret alias brugernavn og adgangskode).

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

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

Vores tjeneste 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 tilføje en brugerdefineret Accept-Language-header. Du er velkommen til at prøve det af ved hjælp af sprog-rullemenuen nederst på denne side.

Paginering understøttes af alle API-slutpunkter, der viser resultater.

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

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

For at afgøre, om der er flere resultater tilgængelige, leverer vi disse HTTP-svarheadere (som du kan analysere 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 mulighed for programmatisk at downloade logfiler til din konto. Hvis du sender en anmodning til dette slutpunkt, behandles alle logfiler til din konto, og de sendes til dig via e-mail som en vedhæftet fil (Gzip komprimeret CSV regnearksfil), når den er færdig.

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

Den vedhæftede fil 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 logfiler når som helst fra Min konto → Logfiler.

GET /v1/logs/download

Eksempel på anmodning:

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

Eksempel på 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 Crontab.guru til at validere din cron-jobudtrykssyntaks.

Eksempel på Cron-job (ved midnat hver dag og med logfiler for den 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"

Liste over 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

Vis 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

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

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

Vis og søg efter beskeder

GET /v1/messages

Kommer snart

Opret besked

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

Vis 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ætningsvejledningen for dit domæne.

Disse instruktioner kan findes på Min konto → Domæner → Indstillinger → Udgående SMTP-konfiguration. Du skal sørge for at konfigurere DKIM, Return-Path og DMARC til at sende udgående SMTP med dit domæne.

Hent grænse for udgående SMTP-e-mail

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:

Vis udgående SMTP-e-mails

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

For at returnere disse egenskaber og deres værdier skal du bruge Hent e-mail-slutpunktet 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 oprettelse af en e-mail er inspireret af og udnytter Nodemailers konfiguration af beskedindstillinger. Se venligst Nodemailer-meddelelseskonfiguration for alle brødtekstparametre nedenfor.

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

Du skal enten sende den enkelte indstilling raw med din rå fulde e-mail inklusive headere eller sende individuelle parameterindstillinger for brødtekst nedenfor.

Dette API-slutpunkt vil automatisk kode emojis for dig, hvis de findes i headerne (f.eks. konverteres emnelinjen Subject: 🤓 Hello automatisk til Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). 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-mails vil sætte status til "rejected" (og efterfølgende ikke behandle den i køen), hvis og kun hvis den aktuelle status er en af "pending", "queued" eller "deferred". Vi kan slette e-mails automatisk 30 dage efter, at de blev oprettet og/eller sendt – derfor bør du gemme 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 både Opret e-mail og Hent e-mail slutpunkter.

DELETE /v1/emails/:id

Eksempel på anmodning:

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

Liste over 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:

Bekræft domænets SMTP-poster

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

Eksempel på anmodning:

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

Vis domæneomfattende catch-all-adgangskoder

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

Eksempel på anmodning:

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

Opret domæneomfattende adgangskode

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

Eksempel på anmodning:

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

Fjern domæneomfattende adgangskode

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

Eksempel på anmodning:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -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:

Generer en aliasadgangskode

Bemærk, at hvis du ikke sender instruktioner via e-mail, vil brugernavn og adgangskode være i JSON-svarteksten i 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:

Vis domænealiasser

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 enten ved hjælp af dets id- eller 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 poster, selv med gratisabonnementet, uden omkostninger. Privatliv bør ikke være en funktion, det bør være indbygget i alle aspekter af et produkt. Som meget efterspurgt i Diskussion om privatlivsvejledninger og på vores GitHub-problemer har vi tilføjet dette.

Krypter TXT-post

POST /v1/encrypt

Eksempel på anmodning:

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