Email API

Op dit moment hebben we nog geen API wrappers uitgebracht, maar we zijn van plan dit in de nabije toekomst te doen. Stuur een e-mail naar api@forwardemail.net als je op de hoogte gehouden wilt worden wanneer een API wrapper voor een bepaalde programmeertaal wordt uitgebracht. In de tussentijd kun je deze aanbevolen HTTP request bibliotheken gebruiken in je applicatie, of simpelweg curl gebruiken zoals in de onderstaande voorbeelden.

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

Alle eindpunten vereisen authenticatie met behulp van Basic Authorization. We ondersteunen twee authenticatiemethoden:

API Token Authenticatie (Aanbevolen voor de meeste eindpunten)

Stel je API-sleutel in als de "gebruikersnaam" waarde met een leeg wachtwoord:

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

Let op de dubbele punt (:) na de API-token – dit geeft een leeg wachtwoord aan in Basic Auth-formaat.

Alias Credentials Authenticatie (Voor uitgaande e-mail)

Het Create outbound SMTP email eindpunt ondersteunt ook authenticatie met je alias e-mailadres en een gegenereerd alias wachtwoord:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Deze methode is handig bij het verzenden van e-mails vanuit applicaties die al SMTP-gegevens gebruiken en maakt de migratie van SMTP naar onze API naadloos.

Alleen Alias Eindpunten

Alias Contacts, Alias Calendars, Alias Messages, en Alias Folders eindpunten vereisen alias credentials en ondersteunen geen API token authenticatie.

Maak je geen zorgen – er zijn voorbeelden hieronder voor je als je niet zeker weet wat dit is.

Als er fouten optreden, bevat de response body van het API-verzoek een gedetailleerd foutbericht.

Onze dienst is vertaald in meer dan 25 verschillende talen. Alle API-responsberichten worden vertaald naar de laatst gedetecteerde locale van de gebruiker die het API-verzoek doet. Je kunt dit overschrijven door een aangepaste Accept-Language header mee te geven. Probeer het gerust uit met de taalkeuzelijst onderaan deze pagina.

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

Geef eenvoudigweg de querystring-eigenschappen page (en optioneel limit) op.

De eigenschap page moet een getal zijn groter dan of gelijk aan 1. Als je limit opgeeft (ook een getal), dan is de minimale waarde 10 en de maximale waarde 50 (tenzij anders vermeld).

Voorbeeldverzoek:

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

Logs ophalen

Onze API stelt u programmatisch in staat om logs voor uw account te downloaden. Het indienen van een verzoek naar deze endpoint verwerkt alle logs voor uw account en stuurt ze u per e-mail als bijlage (Gzip gecomprimeerd CSV spreadsheetbestand) zodra dit voltooid is.

Dit stelt u in staat om achtergrondtaken te maken met een Cron job of met onze Node.js job scheduling software Bree om logs te ontvangen wanneer u dat wenst. Let op dat deze endpoint beperkt is tot 10 verzoeken per dag.

De bijlage heeft de kleine letters vorm van 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 ook op elk moment logs downloaden via Mijn Account → Logs

GET /v1/logs/download

Voorbeeldverzoek:

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

Voorbeeld Cron job (elke dag om middernacht):

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

Let op dat u diensten zoals Crontab.guru kunt gebruiken om de syntax van uw cron job expressie te valideren.

Voorbeeld Cron job (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"

Account 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"

Contacten weergeven

GET /v1/contacts

Binnenkort beschikbaar

Contact aanmaken

POST /v1/contacts

Binnenkort beschikbaar

Contact ophalen

GET /v1/contacts/:id

Binnenkort beschikbaar

Contact bijwerken

PUT /v1/contacts/:id

Binnenkort beschikbaar

Contact verwijderen

DELETE /v1/contacts/:id

Binnenkort beschikbaar

Agenda's weergeven

GET /v1/calendars

Binnenkort beschikbaar

Agenda aanmaken

POST /v1/calendars

Binnenkort beschikbaar

Agenda ophalen

GET /v1/calendars/:id

Binnenkort beschikbaar

Agenda bijwerken

PUT /v1/calendars/:id

Binnenkort beschikbaar

Agenda verwijderen

DELETE /v1/calendars/:id

Binnenkort beschikbaar

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

Deze instructies zijn te vinden in onze FAQ-sectie Ondersteunen jullie het ontvangen van e-mail met IMAP?.

Berichten weergeven en zoeken

GET /v1/messages

Binnenkort beschikbaar

Bericht aanmaken

POST /v1/messages

Binnenkort beschikbaar

Bericht ophalen

GET /v1/messages/:id

Binnenkort beschikbaar

Bericht bijwerken

PUT /v1/messages/:id

Binnenkort beschikbaar

Bericht verwijderen

DELETE /v1/messages:id

Binnenkort beschikbaar

Mappen weergeven

GET /v1/folders

Binnenkort beschikbaar

Map aanmaken

POST /v1/folders

Binnenkort beschikbaar

Map ophalen

GET /v1/folders/:id

Binnenkort beschikbaar

Map bijwerken

PUT /v1/folders/:id

Binnenkort beschikbaar

Map verwijderen

DELETE /v1/folders/:id

Binnenkort beschikbaar

Map kopiëren

POST /v1/folders/:id/copy

Binnenkort beschikbaar

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

Deze instructies zijn te vinden bij Mijn Account → Domeinen → Instellingen → Uitgaande SMTP Configuratie. Je moet de setup van DKIM, Return-Path en DMARC voor het verzenden van uitgaande SMTP met je domein zekerstellen.

Verkrijg limiet voor uitgaande SMTP e-mail

Dit is een eenvoudige endpoint die een JSON-object retourneert met de count en limit 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:

Lijst van uitgaande SMTP e-mails

Let op dat deze endpoint geen eigenschapswaarden retourneert voor de message, headers of rejectedErrors van een e-mail.

Om die eigenschappen en hun waarden te verkrijgen, gebruik je de E-mail ophalen endpoint met een e-mail-ID.

GET /v1/emails

Voorbeeldverzoek:

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

Maak uitgaande SMTP e-mail aan

Onze API voor het aanmaken van een e-mail is geïnspireerd op en maakt gebruik van Nodemailer's message option configuratie. Raadpleeg de Nodemailer message configuratie voor alle body parameters hieronder.

Let op dat we, met uitzondering van envelope en dkim (aangezien wij die automatisch voor je instellen), alle Nodemailer opties ondersteunen. We zetten automatisch de opties disableFileAccess en disableUrlAccess op true voor beveiligingsdoeleinden.

Je moet óf de enkele optie raw doorgeven met je ruwe volledige e-mail inclusief headers of de individuele body parameter opties hieronder.

Deze API endpoint codeert automatisch emoji's voor je als ze in de headers worden gevonden (bijv. een onderwerpregel Subject: 🤓 Hello wordt automatisch omgezet naar Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Ons doel was een uiterst ontwikkelaarsvriendelijke en foutbestendige e-mail API te maken.

Authenticatie: Deze endpoint ondersteunt zowel API token authenticatie als alias credentials authenticatie. Zie de sectie Authenticatie hierboven voor details.

POST /v1/emails

Voorbeeldverzoek (API-token):

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"

Voorbeeldverzoek (Alias-referenties):

curl -X POST https://api.forwardemail.net/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Voorbeeldverzoek (Raw Email):

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

Ophalen uitgaande SMTP-e-mail

GET /v1/emails/:id

Voorbeeldverzoek:

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

Verwijderen uitgaande SMTP-e-mail

Het verwijderen van e-mail zal de status instellen op "rejected" (en deze vervolgens niet verwerken in de wachtrij) als en alleen als de huidige status een van de volgende is: "pending", "queued", of "deferred". We kunnen e-mails automatisch verwijderen na 30 dagen nadat ze zijn aangemaakt en/of verzonden – daarom moet u een kopie van uitgaande SMTP-e-mails bewaren in uw client, database of applicatie. U kunt onze e-mail-ID waarde in uw database refereren indien gewenst – deze waarde wordt teruggegeven door zowel de Create email als Retrieve email endpoints.

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

GET /v1/domains/example.com

Voorbeeldverzoek:

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

Domeinrecords verifiëren

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

Voorbeeldverzoek:

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

SMTP-records van domein verifiëren

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

Voorbeeldverzoek:

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

Lijst met domeinbrede catch-all wachtwoorden

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

Voorbeeldverzoek:

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

Domeinbreed catch-all wachtwoord aanmaken

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

Voorbeeldverzoek:

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

Domeinbreed catch-all wachtwoord verwijderen

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 bijwerken

PUT /v1/domains/example.com

Voorbeeldverzoek:

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

Domein verwijderen

DELETE /v1/domains/:domain_name

Voorbeeldverzoek:

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

Domeinuitnodiging accepteren

GET /v1/domains/:domain_name/invites

Voorbeeldverzoek:

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

Domeinuitnodiging aanmaken

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

Domeinuitnodiging verwijderen

DELETE /v1/domains/:domain_name/invites

Voorbeeldverzoek:

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

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

Domeinlid verwijderen

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:

Een aliaswachtwoord genereren

Let op: als je geen instructies per e-mail verstuurt, staan de gebruikersnaam en het wachtwoord in de JSON-respons van een succesvolle aanvraag in het formaat { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Example Request:

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

Lijst domeinaliases

GET /v1/domains/example.com/aliases

Example Request:

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

Nieuwe domeinalias aanmaken

POST /v1/domains/example.com/aliases

Voorbeeldverzoek:

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

Haal domeinalias op

Je kunt een domeinalias ophalen via de id of de name waarde.

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:

Werk domeinalias bij

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:

Verwijder domeinalias

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 staan toe dat je records versleutelt, zelfs op het gratis abonnement zonder kosten. Privacy zou geen functie moeten zijn, het zou inherent ingebouwd moeten zijn in alle aspecten van een product. Zoals veel gevraagd in een Privacy Guides discussie en op onze GitHub issues hebben we dit toegevoegd.

Versleutel TXT-record

POST /v1/encrypt

Voorbeeldverzoek:

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