E-mail API

Momenteel hebben we nog geen API-wrappers uitgebracht, maar we zijn van plan dit in de nabije toekomst te doen. Stuur een e-mail naar [email protected] als u op de hoogte wilt worden gehouden wanneer de API-wrapper van een specifieke programmeertaal beschikbaar is. In de tussentijd kunt u deze aanbevolen HTTP-aanvraagbibliotheken in uw applicatie gebruiken of gewoon krul gebruiken, zoals in de onderstaande voorbeelden.

Het huidige HTTP-basis-URI-pad is: https://api.forwardemail.net.

Voor alle eindpunten moet uw API-sleutel worden ingesteld als de waarde voor de gebruikersnaam in de Basisautorisatie-header van de aanvraag (met uitzondering van Alias-contacten, Alias-kalenders en Alias-mailboxen, die een gegenereerde alias gebruikersnaam en wachtwoord gebruiken).

Maakt u zich geen zorgen: hieronder vindt u voorbeelden als u niet zeker weet wat dit is.

Als er fouten optreden, bevat de antwoordtekst van de API-aanvraag een gedetailleerd foutbericht.

Onze service is vertaald naar meer dan 25 verschillende talen. Alle API-responsberichten worden vertaald naar de laatst gedetecteerde landinstellingen van de gebruiker die de API-aanvraag indient. U kunt dit overschrijven door een aangepaste Accept-Language-header toe te voegen. Probeer het gerust uit met behulp van de taalkeuzelijst onderaan deze pagina.

Paginering wordt ondersteund door alle API-eindpunten die resultaten weergeven.

Geef eenvoudig de querystringeigenschappen page op (en optioneel limit).

De eigenschap page moet een getal zijn dat groter is dan of gelijk is aan 1. Als u limit (ook een getal) opgeeft, is de minimumwaarde 10 en de maximumwaarde 50 (tenzij anders vermeld).

Om te kunnen bepalen of er meer resultaten beschikbaar zijn, bieden we de volgende HTTP-responsheaders aan (die u kunt parseren om programmatisch te pagineren):

Voorbeeldverzoek:

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

Logs ophalen

Met onze API kunt u programmatisch logs voor uw account downloaden. Door een aanvraag in te dienen bij dit eindpunt, worden alle logs voor uw account verwerkt en als bijlage (Gzip gecomprimeerd CSV spreadsheetbestand) naar u gemaild zodra deze voltooid zijn.

Hiermee kunt u achtergrondtaken aanmaken met een Cron-taak of met onze Node.js-taakplanningssoftware Bree om logs te ontvangen wanneer u dat wilt. Let op: dit eindpunt is beperkt tot 10-verzoeken per dag.

De bijlage is de kleine letter email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz en de e-mail zelf bevat een korte samenvatting van de opgehaalde logs. U kunt logs ook op elk gewenst moment downloaden van Mijn account → Logboeken.

GET /v1/logs/download

Voorbeeldverzoek:

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

Voorbeeld van een cronjob (elke dag om middernacht):

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

Houd er rekening mee dat u services zoals Crontab.guru kunt gebruiken om de syntaxis van uw cron-taakexpressies te valideren.

Voorbeeld van een cronjob (elke dag om middernacht en met logs van de vorige dag):

Voor 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

Voor Linux en 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

Account aanmaken

POST /v1/account

Voorbeeldverzoek:

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

Rekening ophalen

GET /v1/account

Voorbeeldverzoek:

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

Account bijwerken

PUT /v1/account

Voorbeeldverzoek:

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

Contactenlijst

GET /v1/contacts

Binnenkort beschikbaar

Contactpersoon {#create-contact} aanmaken

POST /v1/contacts

Binnenkort beschikbaar

Contactpersoon ophalen

GET /v1/contacts/:id

Binnenkort beschikbaar

Contactpersoon bijwerken

PUT /v1/contacts/:id

Binnenkort beschikbaar

Contactpersoon verwijderen

DELETE /v1/contacts/:id

Binnenkort beschikbaar

Kalenders weergeven

GET /v1/calendars

Binnenkort beschikbaar

Kalender aanmaken

POST /v1/calendars

Binnenkort beschikbaar

Agenda ophalen

GET /v1/calendars/:id

Binnenkort beschikbaar

Kalender bijwerken

PUT /v1/calendars/:id

Binnenkort beschikbaar

Verwijder agenda

DELETE /v1/calendars/:id

Binnenkort beschikbaar

Zorg ervoor dat u de installatie-instructies voor uw domein hebt gevolgd.

Deze instructies vindt u in onze FAQ-sectie Ondersteunt u het ontvangen van e-mail via IMAP?.

Lijst en zoek naar berichten

GET /v1/messages

Binnenkort beschikbaar

Bericht maken

POST /v1/messages

Binnenkort beschikbaar

Bericht ophalen

GET /v1/messages/:id

Binnenkort beschikbaar

Bericht bijwerken

PUT /v1/messages/:id

Binnenkort beschikbaar

Verwijder bericht

DELETE /v1/messages:id

Binnenkort beschikbaar

Mappen weergeven

GET /v1/folders

Binnenkort beschikbaar

Maak map

POST /v1/folders

Binnenkort beschikbaar

Haal map {#retrieve-folder} op

GET /v1/folders/:id

Binnenkort beschikbaar

Map {#update-folder} bijwerken

PUT /v1/folders/:id

Binnenkort beschikbaar

Verwijder map

DELETE /v1/folders/:id

Binnenkort beschikbaar

Kopieer map

POST /v1/folders/:id/copy

Binnenkort beschikbaar

Zorg ervoor dat u de installatie-instructies voor uw domein hebt gevolgd.

Deze instructies zijn te vinden op Mijn account → Domeinen → Instellingen → Uitgaande SMTP-configuratie. Zorg ervoor dat DKIM, Return-Path en DMARC zijn ingesteld voor het verzenden van uitgaande SMTP met uw domein.

Uitgaande SMTP-e-maillimiet ophalen

Dit is een eenvoudig eindpunt dat een JSON-object retourneert dat count en limit bevat voor het aantal dagelijkse uitgaande SMTP-berichten per account.

GET /v1/emails/limit

Voorbeeldverzoek:

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

Uitgaande SMTP-e-mails weergeven

Houd er rekening mee dat dit eindpunt geen eigenschapswaarden retourneert voor message, headers en rejectedErrors van een e-mail.

Om deze eigenschappen en hun waarden te retourneren, gebruikt u het eindpunt E-mail ophalen met een e-mailadres.

GET /v1/emails

Voorbeeldverzoek:

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

Uitgaande SMTP-e-mail maken

Onze API voor het maken van een e-mail is geïnspireerd op en maakt gebruik van de berichtopties van Nodemailer. Raadpleeg Nodemailer-berichtconfiguratie voor alle onderstaande bodyparameters.

Houd er rekening mee dat we, met uitzondering van envelope en dkim (aangezien we die automatisch voor u instellen), alle opties van Nodemailer ondersteunen. Om beveiligingsredenen stellen we de opties disableFileAccess en disableUrlAccess automatisch in op true.

U dient ofwel de enkele optie raw door te geven met uw volledige e-mail inclusief headers of individuele hoofdparameteropties hieronder door te geven.

Dit API-eindpunt codeert automatisch emoji's als ze in de headers voorkomen (een onderwerpregel van Subject: 🤓 Hello wordt bijvoorbeeld automatisch omgezet naar Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Ons doel was om een uiterst ontwikkelaarsvriendelijke en onfeilbare e-mail-API te maken.

POST /v1/emails

Voorbeeldverzoek:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "[email protected]" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Voorbeeldverzoek:

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

Uitgaande SMTP-e-mail ophalen

GET /v1/emails/:id

Voorbeeldverzoek:

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

Verwijder uitgaande SMTP-e-mail

Het verwijderen van e-mails zet de status op "rejected" (en verwerkt deze vervolgens niet in de wachtrij) als en alleen als de huidige status "pending", "queued" of "deferred" is. We kunnen e-mails automatisch verwijderen na 30 dagen nadat ze zijn aangemaakt en/of verzonden. Bewaar daarom een kopie van uitgaande SMTP-e-mails in uw client, database of applicatie. U kunt desgewenst verwijzen naar onze e-mail-ID in uw database. Deze waarde wordt geretourneerd door zowel E-mail maken als E-mail ophalen eindpunten.

DELETE /v1/emails/:id

Voorbeeldverzoek:

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

Domeinen weergeven

GET /v1/domains

Voorbeeldverzoek:

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

Domein {#create-domain} aanmaken

POST /v1/domains

Voorbeeldverzoek:

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

Domein {#retrieve-domain} ophalen

GET /v1/domains/example.com

Voorbeeldverzoek:

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

Controleer domeinrecords

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

Voorbeeldverzoek:

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

Controleer domein SMTP-records

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

Voorbeeldverzoek:

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

Domeinbrede catch-all-wachtwoorden weergeven

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

Voorbeeldverzoek:

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

Maak een domeinbreed catch-all-wachtwoord

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

Voorbeeldverzoek:

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

Verwijder domeinbrede catch-all-wachtwoord

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

Voorbeeldverzoek:

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

Domein {#update-domain} bijwerken

PUT /v1/domains/example.com

Voorbeeldverzoek:

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

Domein {#delete-domain} verwijderen

DELETE /v1/domains/:domain_name

Voorbeeldverzoek:

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

Accepteer domeinuitnodiging

GET /v1/domains/:domain_name/invites

Voorbeeldverzoek:

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

Maak domeinuitnodiging

POST /v1/domains/example.com/invites

Voorbeeldverzoek:

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

Verwijder domeinuitnodiging

DELETE /v1/domains/:domain_name/invites

Voorbeeldverzoek:

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

Domeinlid {#update-domain-member} bijwerken

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

Voorbeeldverzoek:

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

Verwijder domeinlid

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

Voorbeeldverzoek:

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

Genereer een aliaswachtwoord

Houd er rekening mee dat als u geen instructies per e-mail verstuurt, de gebruikersnaam en het wachtwoord in de JSON-responsbody van een succesvolle aanvraag worden weergegeven in de indeling { username: '[email protected]', password: 'some-generated-password' }.

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

Voorbeeldverzoek:

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

Domeinaliassen weergeven

GET /v1/domains/example.com/aliases

Voorbeeldverzoek:

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

Maak een nieuwe domeinalias

POST /v1/domains/example.com/aliases

Voorbeeldverzoek:

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

Domeinalias ophalen

U kunt een domeinalias ophalen aan de hand van de waarde id of name.

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

Voorbeeldverzoek:

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

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

Voorbeeldverzoek:

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

Domeinalias {#update-domain-alias} bijwerken

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

Voorbeeldverzoek:

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

Domeinalias {#delete-domain-alias} verwijderen

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

Voorbeeldverzoek:

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

We bieden u de mogelijkheid om records te versleutelen, zelfs met het gratis abonnement, zonder extra kosten. Privacy zou geen feature moeten zijn, maar inherent ingebouwd in alle aspecten van een product. Zoals dringend gevraagd in een Discussie over privacygidsen en op onze GitHub-problemen, hebben we dit toegevoegd.

TXT-record versleutelen

POST /v1/encrypt

Voorbeeldverzoek:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "[email protected]"