E-mail-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 email naar api@forwardemail.net als u op de hoogte wilt worden gehouden wanneer de API-wrapper van een bepaalde programmeertaal wordt vrijgegeven. Ondertussen kunt u deze aanbevolen HTTP-verzoekbibliotheken in uw toepassing gebruiken, of gewoon krullen zoals in de onderstaande voorbeelden.

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

Voor alle eindpunten is uw API sleutel in te stellen als de "gebruikersnaam" waarde van de aanvraag's Basisautorisatie kop. 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 het API-verzoek een gedetailleerd foutbericht.

Onze service is vertaald in meer dan 25 verschillende talen. Alle API-antwoordberichten worden vertaald naar de laatst gedetecteerde landinstelling van de gebruiker die het API-verzoek doet. Je kunt dit overschrijven door een gewoonte door te geven Accept-Language kop. Voel je vrij om het uit te proberen met behulp van de taal drop-down onderaan deze pagina.

Als u op de hoogte wilt worden gehouden wanneer paginering beschikbaar is, stuur dan een e-mail naar api@forwardemail.net.

Logboeken ophalen

Met onze API kunt u programmatisch logboeken voor uw account downloaden. Als u een verzoek indient bij dit eindpunt, worden alle logboeken voor uw account verwerkt en als bijlage naar u verzonden (Gzip gecomprimeerd CSV spreadsheetbestand) zodra het voltooid is.

Hiermee kunt u achtergrondtaken maken met een Cron-taak of gebruik onze Node.js taakplanningssoftware Bree om logs te ontvangen wanneer u maar wilt. Houd er rekening mee dat dit eindpunt beperkt is tot 10 aanvragen per dag.

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

GET /v1/logs/download

Voorbeeldaanvraag:

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

Voorbeeld 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 kunt gebruiken zoals Crontab.guru om de syntaxis van uw cronjob-expressie te valideren.

Voorbeeld 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

Voorbeeldaanvraag:

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

Account ophalen

GET /v1/account

Voorbeeldaanvraag:

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

Account bijwerken

PUT /v1/account

Voorbeeldaanvraag:

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

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. U moet ervoor zorgen dat DKIM, Return-Path en DMARC zijn ingesteld voor het verzenden van uitgaande SMTP met uw domein.

Maak een lijst van e-mails

Houd er rekening mee dat dit eindpunt geen reeds gemaakte e-mails retourneert message, headers, accepted, noch rejectedErrors eigenschappen.

Om die eigenschappen en hun waarden te retourneren, gebruikt u de E-mail ophalen eindpunt met een e-mail-ID.

Dit eindpunt keert hoogstens terug 50 resultaten tegelijk. Als u meerdere pagina's wilt opvragen, voegt u deze toe ?page=NUMBER waar NUMBER is een geheel getal, b.v. ?page=1.

GET /v1/emails

Voorbeeldaanvraag:

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

E-mail maken

Onze API voor het maken van een e-mail is geïnspireerd op en maakt gebruik van de berichtoptieconfiguratie van Nodemailer. Gelieve uit te stellen naar de Nodemailer-berichtconfiguratie voor alle lichaamsparameters hieronder.

Merk op dat met uitzondering van envelope en dkim (aangezien we die automatisch voor u instellen), ondersteunen we alle Nodemailer-opties. We stellen automatisch in disableFileAccess en disableUrlAccess opties om true voor veiligheidsdoeleinden.

U moet ofwel de enkele optie doorgeven raw met uw onbewerkte volledige e-mail inclusief headers of geef de individuele body-parameteropties hieronder door.

POST /v1/emails

Voorbeeldaanvraag:

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"

Voorbeeldaanvraag:

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

E-mail ophalen

GET /v1/emails/:id

Voorbeeldaanvraag:

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

E-mail verwijderen

Bij het verwijderen van e-mail wordt de status ingesteld op "rejected" (en vervolgens niet verwerken in de wachtrij) als en alleen als de huidige status een van is "pending", "queued", of "deferred". We kunnen e-mails automatisch verwijderen na 30 dagen nadat ze zijn gemaakt 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-waarde in uw database - deze waarde wordt door beide geretourneerd E-mail maken en E-mail ophalen eindpunten.

DELETE /v1/emails/:id

Voorbeeldaanvraag:

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

Lijst domeinen

GET /v1/domains

Voorbeeldaanvraag:

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

Domein aanmaken

POST /v1/domains

Voorbeeldaanvraag:

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

Voorbeeldaanvraag:

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

Controleer domeinrecords

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

Voorbeeldaanvraag:

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

Domein updaten

PUT /v1/domains/example.com

Voorbeeldaanvraag:

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

Domein verwijderen

DELETE /v1/domains/:domain_name

Voorbeeldaanvraag:

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

Domeinuitnodiging accepteren

GET /v1/domains/:domain_name/invites

Voorbeeldaanvraag:

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

Maak een domeinuitnodiging

POST /v1/domains/example.com/invites

Voorbeeldaanvraag:

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

Voorbeeldaanvraag:

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

Domeinlid updaten

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

Voorbeeldaanvraag:

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

Voorbeeldaanvraag:

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

Domeinaliassen weergeven

GET /v1/domains/example.com/aliases

Voorbeeldaanvraag:

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

Maak een nieuwe domeinalias aan

POST /v1/domains/example.com/aliases

Voorbeeldaanvraag:

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

Domeinalias ophalen

U kunt een domeinalias ophalen door ofwel zijn id of het is name waarde.

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

Voorbeeldaanvraag:

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

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

Voorbeeldaanvraag:

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

Domeinalias updaten

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

Voorbeeldaanvraag:

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

Domeinalias verwijderen

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

Voorbeeldaanvraag:

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