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 header (met uitzondering van Alias-contacten, Alias Kalenders, en Alias-mailboxen die gebruik maken van een gegenereerde alias gebruikersnaam en wachtwoord)..

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.

[!TIP] Als u een 5xx-statuscode ontvangt (wat niet zou moeten gebeuren), neem dan contact met ons op via api@forwardemail.net en we zullen u helpen om uw probleem onmiddellijk op te lossen.

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.

[!NOTE] Vanaf 1 november 2024 zijn de API-eindpunten voor Lijst domeinen en Domeinaliassen weergeven zal standaard naar 1000 max. resultaten per pagina. Als u zich vroegtijdig voor dit gedrag wilt aanmelden, kunt u ?paginate=true als een extra querystringparameter voor de URL voor de eindpuntquery.

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

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

Het pand page moet een getal zijn dat groter is dan of gelijk is aan 1. Als u verstrekt limit (ook een getal), dan is de minimumwaarde 10 en maximaal is 50 (tenzij anders vermeld).

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

Voorbeeldaanvraag:

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

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"

[!NOTE] In tegenstelling tot andere API-eindpunten vereisen deze Authenticatie "gebruikersnaam" is gelijk aan de aliasgebruikersnaam en "wachtwoord" is gelijk aan het door de alias gegenereerde wachtwoord als basisautorisatieheaders.

[!WARNING] Deze endpointsectie is nog in ontwikkeling en wordt (hopelijk) in 2024 uitgebracht. Gebruik in de tussentijd een IMAP-client uit de vervolgkeuzelijst 'Apps' in de navigatie van onze website.

Contactenlijst

GET /v1/contacts

Binnenkort beschikbaar

Contactpersoon 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

[!NOTE] In tegenstelling tot andere API-eindpunten vereisen deze Authenticatie "gebruikersnaam" is gelijk aan de aliasgebruikersnaam en "wachtwoord" is gelijk aan het door de alias gegenereerde wachtwoord als basisautorisatieheaders.

[!WARNING] Deze endpointsectie is nog in ontwikkeling en wordt (hopelijk) in 2024 uitgebracht. Gebruik in de tussentijd een IMAP-client uit de vervolgkeuzelijst 'Apps' in de navigatie van onze website.

Lijst kalenders

GET /v1/calendars

Binnenkort beschikbaar

Kalender maken

POST /v1/calendars

Binnenkort beschikbaar

Kalender ophalen

GET /v1/calendars/:id

Binnenkort beschikbaar

Kalender bijwerken

PUT /v1/calendars/:id

Binnenkort beschikbaar

Kalender verwijderen

DELETE /v1/calendars/:id

Binnenkort beschikbaar

[!NOTE] In tegenstelling tot andere API-eindpunten vereisen deze Authenticatie "gebruikersnaam" is gelijk aan de aliasgebruikersnaam en "wachtwoord" is gelijk aan het door de alias gegenereerde wachtwoord als basisautorisatieheaders.

[!WARNING] Deze endpointsectie is nog in ontwikkeling en wordt (hopelijk) in 2024 uitgebracht. Gebruik in de tussentijd een IMAP-client uit de vervolgkeuzelijst 'Apps' in de navigatie van onze website.

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

Berichten weergeven en zoeken

GET /v1/messages

Binnenkort beschikbaar

Bericht maken

[!NOTE] Dit zal NOT een e-mail verzenden – het bericht wordt dan alleen maar aan uw mailboxmap toegevoegd (dit is bijvoorbeeld vergelijkbaar met de IMAP-methode). APPEND commando). Als u een e-mail wilt sturen, zie dan Uitgaande SMTP-e-mail maken hieronder. Nadat u de uitgaande SMTP-e-mail hebt gemaakt, kunt u een kopie ervan met behulp van dit eindpunt toevoegen aan de mailbox van uw alias voor opslagdoeleinden.

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

[!TIP] Map-eindpunten met het pad van een map /v1/folders/:path omdat hun eindpunten uitwisselbaar zijn met de ID van een map :idDit betekent dat u naar de map kunt verwijzen via de naam path of id waarde.

[!WARNING] Deze endpointsectie is nog in ontwikkeling en wordt (hopelijk) in 2024 uitgebracht. Gebruik in de tussentijd een IMAP-client uit de vervolgkeuzelijst 'Apps' in de navigatie van onze website.

Mappen weergeven

GET /v1/folders

Binnenkort beschikbaar

Map maken

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

Kopieer map

POST /v1/folders/:id/copy

Binnenkort beschikbaar

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

Deze instructies vindt u 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.

Uitgaande SMTP-e-maillimiet ophalen

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

GET /v1/emails/limit

Voorbeeldaanvraag:

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

Lijst met uitgaande SMTP-e-mails

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

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

GET /v1/emails

Voorbeeldaanvraag:

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

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

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

Uitgaande SMTP-e-mail ophalen

GET /v1/emails/:id

Voorbeeldaanvraag:

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

Uitgaande SMTP-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:

[!TIP] Domeineindpunten met een domeinnaam /v1/domains/:domain_name omdat hun eindpunten uitwisselbaar zijn met de ID van een domein :domain_id. Dit betekent dat u naar het domein kunt verwijzen door ofwel zijn name of id waarde.

Lijst domeinen

[!NOTE] Vanaf 1 november 2024 zijn de API-eindpunten voor Lijst domeinen en Domeinaliassen weergeven zal standaard naar 1000 max. resultaten per pagina. Als u zich vroegtijdig voor dit gedrag wilt aanmelden, kunt u ?paginate=true als een extra querystringparameter voor de URL voor de eindpuntquery. Zie Paginering voor meer inzicht.

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:

Controleer domein SMTP-records

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

Voorbeeldaanvraag:

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

Domeinbrede catch-all-wachtwoorden opsommen

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

Voorbeeldaanvraag:

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

Maak een domeinbreed catch-all-wachtwoord aan

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

Voorbeeldaanvraag:

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

Verwijder domeinbrede catch-all-wachtwoorden

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

Voorbeeldaanvraag:

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

[!BELANGRIJK] Als de gebruiker die wordt uitgenodigd al een geaccepteerd lid is van andere domeinen waarvan de beheerder die hen uitnodigt lid is, wordt de uitnodiging automatisch geaccepteerd en wordt er geen e-mail verzonden.

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:

Genereer een aliaswachtwoord

Houd er rekening mee dat als u geen instructies per e-mail verzendt, de gebruikersnaam en het wachtwoord in de JSON-antwoordtekst van een succesvol verzoek staan in de indeling { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Voorbeeldaanvraag:

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

Domeinaliassen weergeven

[!NOTE] Vanaf 1 november 2024 zijn de API-eindpunten voor Lijst domeinen en Domeinaliassen weergeven zal standaard naar 1000 max. resultaten per pagina. Als u zich vroegtijdig voor dit gedrag wilt aanmelden, kunt u ?paginate=true als een extra querystringparameter voor de URL voor de eindpuntquery. Zie Paginering voor meer inzicht.

GET /v1/domains/example.com/aliases

Voorbeeldaanvraag:

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

We staan u toe om zelfs met het gratis abonnement kosteloos gegevens te versleutelen. Privacy mag geen kenmerk zijn, het moet inherent ingebouwd zijn in alle aspecten van een product. Zoals zeer gevraagd in a Discussie over privacygidsen en verder onze GitHub-problemen wij hebben dit toegevoegd.

Versleutel TXT-record

POST /v1/encrypt

Voorbeeldaanvraag:

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