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.

TaalBibliotheek
RobijnFaraday
Pythonverzoeken
JavaokHttp
PHPslikken
javascriptsuperagent (wij zijn beheerders)
Node.jssuperagent (wij zijn beheerders)
Gaannet / http
.NETRustScherp

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.

CodeNaam
200OK
400Foutief verzoek
401Ongeautoriseerd
403Verboden
404Niet gevonden
429Te veel verzoeken
500Interne Server Fout
501Niet geïmplementeerd
502Slechte gateway
503Service onbeschikbaar
504Time-out van gateway
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).

Querystring-parameterVerplichtTypeOmschrijving
pageNeeNummerPagina met resultaten om terug te keren. Indien niet gespecificeerd, de page waarde zal zijn 1. Moet een getal zijn dat groter is dan of gelijk is aan 1.
limitNeeNummerAantal resultaten dat per pagina wordt geretourneerd. Standaardwaarde is 10 indien niet gespecificeerd. Moet een getal zijn dat groter is dan of gelijk is aan 1, en kleiner dan of gelijk aan 50.

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

HTTP-reactieheaderVoorbeeldOmschrijving
X-Page-CountX-Page-Count: 3Het totale beschikbare aantal pagina's.
X-Page-CurrentX-Page-Current: 1De huidige pagina met geretourneerde resultaten (bijvoorbeeld op basis van page querytekenreeksparameters).
X-Page-SizeX-Page-Size: 10Het totale aantal resultaten dat op de pagina is geretourneerd (bijv. op basis van limit querystringparameter en de daadwerkelijke geretourneerde resultaten).
X-Item-CountX-Item-Count: 30Het totale aantal items dat beschikbaar is op alle pagina's.
LinkLink: <https://api.forwardemail.net/v1/emails?page=1>; rel="prev", <https://api.forwardemail.net/v1/emails?page=3>; rel="next", <https://api.forwardemail.net/v1/emails?page=3; rel="last", https://api.forwardemail.net/v1/emails?page=1; rel="first"Wij bieden een Link HTTP-responsheader die u kunt parseren zoals getoond in het voorbeeld. Dit is vergelijkbaar met GitHub (bijvoorbeeld worden niet alle waarden verstrekt als ze niet relevant of beschikbaar zijn, bijvoorbeeld "next" wordt niet verstrekt als er geen andere pagina is).

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

Querystring-parameterVerplichtTypeOmschrijving
domainNeeTekenreeks (FQDN)Filter logboeken op volledig gekwalificeerd domein ("FQDN"). Als u dit niet opgeeft, worden alle logbestanden van alle domeinen opgehaald.
qNeeDraadZoek naar logboeken op e-mail, domein, aliasnaam, IP-adres of datum (M/Y, M/D/YY, M-D, M-D-YY, of M.D.YY formaat).

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

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres
passwordJaDraadWachtwoord

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

LichaamsparameterVerplichtTypeOmschrijving
emailNeeTekenreeks (e-mail)E-mailadres
given_nameNeeDraadVoornaam
family_nameNeeDraadAchternaam
avatar_urlNeeTekenreeks (URL)Link naar avatarafbeelding

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.

WIP: Deze eindpuntsectie 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.

NOTE: CardDAV-ondersteuning is nog niet beschikbaar, volg deze discussie op GitHub voor updates.

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.

WIP: Deze eindpuntsectie 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.

WIP: Deze eindpuntsectie 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.

WIP: Deze eindpuntsectie 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

Querystring-parameterVerplichtTypeOmschrijving
qNeeString (RegExp ondersteund)Zoeken naar e-mails op metadata
domainNeeString (RegExp ondersteund)Zoek naar e-mails op domeinnaam
sortNeeDraadSorteren op een specifiek veld (voorvoegsel met een enkel streepje) - om in de omgekeerde richting van dat veld te sorteren). Standaard is created_at indien niet ingesteld.
pageNeeNummerZien Paginering voor meer inzicht
limitNeeNummerZien Paginering voor meer inzicht

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

LichaamsparameterVerplichtTypeOmschrijving
fromNeeTekenreeks (e-mail)Het e-mailadres van de afzender (moet bestaan als een alias van het domein).
toNeeString of ArrayDoor komma's gescheiden lijst of een array van ontvangers voor de kop 'Aan'.
ccNeeString of ArrayDoor komma's gescheiden lijst of een array van ontvangers voor de "Cc"-header.
bccNeeString of ArrayDoor komma's gescheiden lijst of een reeks ontvangers voor de "Bcc"-header.
subjectNeeDraadHet onderwerp van de e-mail.
textNeeTekenreeks of bufferDe leesbare versie van het bericht.
htmlNeeTekenreeks of bufferDe HTML-versie van het bericht.
attachmentsNeematrixEen reeks bijlage-objecten (zie De gemeenschappelijke velden van Nodemailer).
senderNeeDraadHet e-mailadres voor de header "Afzender" (zie De meer geavanceerde velden van Nodemailer).
replyToNeeDraadHet e-mailadres voor de "Reply-To"-header.
inReplyToNeeDraadDe Message-ID waarop het bericht reageert.
referencesNeeString of ArrayDoor spaties gescheiden lijst of een reeks bericht-ID's.
attachDataUrlsNeeBooleaansAls true converteert dan data: afbeeldingen in de HTML-inhoud van het bericht naar ingesloten bijlagen.
watchHtmlNeeDraadEen Apple Watch-specifieke HTML-versie van het bericht (volgens de Nodemailer-documenten, bij de nieuwste horloges hoeft dit niet ingesteld te worden).
ampNeeDraadEen AMP4EMAIL-specifieke HTML-versie van het bericht (zie Nodemailers voorbeeld).
icalEventNeeVoorwerpEen iCalendar-gebeurtenis om te gebruiken als alternatieve berichtinhoud (zie Nodemailer's kalendergebeurtenissen).
alternativesNeematrixEen array met alternatieve berichtinhoud (zie Alternatieve inhoud van Nodemailer).
encodingNeeDraadCodering voor de tekst- en HTML-tekenreeksen (standaard ingesteld op "utf-8", maar ondersteunt "hex" en "base64" coderingswaarden ook).
rawNeeTekenreeks of bufferEen op maat gegenereerd bericht in RFC822-indeling om te gebruiken (in plaats van een bericht dat is gegenereerd door Nodemailer - zie De aangepaste bron van Nodemailer).
textEncodingNeeDraadCodering die geforceerd moet worden gebruikt voor tekstwaarden (ofwel "quoted-printable" of "base64"). De standaardwaarde is de dichtstbijzijnde gedetecteerde waarde (voor ASCII-gebruik "quoted-printable").
priorityNeeDraadPrioriteitsniveau voor de e-mail (kan "high", "normal" (standaard), of "low"). Merk op dat een waarde van "normal" stelt geen prioriteitskop in (dit is het standaardgedrag). Als een waarde van "high" of "low" is ingesteld, dan is de X-Priority, X-MSMail-Priority, en Importance koppen zal dienovereenkomstig worden ingesteld.
headersNeeObject of matrixEen object of een matrix met aanvullende koptekstvelden om in te stellen (zie De aangepaste headers van Nodemailer).
messageIdNeeDraadEen optionele Message-ID-waarde voor de "Message-ID"-header (een standaardwaarde wordt automatisch gemaakt als deze niet is ingesteld - houd er rekening mee dat de waarde voldoen aan de RFC2822-specificatie).
dateNeeTekenreeks of datumEen optionele datumwaarde die wordt gebruikt als de datumkoptekst ontbreekt na het ontleden, anders wordt de huidige UTC-tekenreeks gebruikt als deze niet is ingesteld. De datumkop kan niet meer dan 30 dagen voor de huidige tijd liggen.
listNeeVoorwerpEen optioneel object van List-* koppen (zie Nodemailer's lijstkoppen).

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 de naam van een domein /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

Querystring-parameterVerplichtTypeOmschrijving
qNeeString (RegExp ondersteund)Zoek naar domeinen op naam
nameNeeString (RegExp ondersteund)Zoek naar domeinen op naam
sortNeeDraadSorteren op een specifiek veld (voorvoegsel met een enkel streepje) - om in de omgekeerde richting van dat veld te sorteren). Standaard is created_at indien niet ingesteld.
pageNeeNummerZien Paginering voor meer inzicht
limitNeeNummerZien Paginering voor meer inzicht

Voorbeeldaanvraag:

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

Domein aanmaken

POST /v1/domains

LichaamsparameterVerplichtTypeOmschrijving
domainJaString (FQDN of IP)Volledig gekwalificeerde domeinnaam ("FQDN") of IP-adres
planNeeString (opsommbaar)Abonnementstype (moet zijn "free", "enhanced_protection", of "team", standaard ingesteld op "free" of het huidige betaalde abonnement van de gebruiker, indien aanwezig)
catchallNeeString (gescheiden e-mailadressen) of BooleanMaak een standaard catch-all alias, standaard op true (als true het zal het e-mailadres van de API-gebruiker als ontvanger gebruiken, en als: false er wordt geen catch-all gemaakt). Als een tekenreeks wordt doorgegeven, is het een afgebakende lijst met e-mailadressen die als ontvangers kunnen worden gebruikt (gescheiden door regeleinde, spatie en/of komma)
has_adult_content_protectionNeeBooleaansOf u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protectionNeeBooleaansOf u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protectionNeeBooleaansOf de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protectionNeeBooleaansOf u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verificationNeeBooleaansAlgemene domeinstandaard om te bepalen of aliasontvangers op een e-mailverificatielink moeten klikken om e-mails door te laten stromen
ignore_mx_checkNeeBooleaansOf de MX-recordcontrole op het domein ter verificatie moet worden genegeerd. Dit is voornamelijk bedoeld voor gebruikers die geavanceerde MX-uitwisselingsconfiguratieregels hebben en hun bestaande MX-uitwisseling moeten behouden en doorsturen naar de onze.
retention_daysNeeNummerGeheel getal tussen 0 en 30 dat komt overeen met het aantal bewaardagen voor het opslaan van uitgaande SMTP-e-mails zodra ze succesvol zijn afgeleverd of als er een permanente fout is opgetreden. Standaard ingesteld op 0, wat betekent dat uitgaande SMTP-e-mails voor uw veiligheid onmiddellijk worden verwijderd en geredigeerd.
bounce_webhookNeeString (URL) of Booleaans (false)De http:// of https:// webhook URL van uw keuze om bounce webhooks naar te sturen. We zullen een POST verzoek naar deze URL met informatie over uitgaande SMTP-fouten (bijv. zachte of harde fouten, zodat u uw abonnees kunt beheren en uw uitgaande e-mail programmatisch kunt beheren).
max_quota_per_aliasNeeDraadOpslagmaximumquotum voor aliassen op deze domeinnaam. Voer een waarde in zoals "1 GB" die door bytes.

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

LichaamsparameterVerplichtTypeOmschrijving
smtp_portNeeTekenreeks of nummerAangepaste poort om te configureren voor SMTP-forwarding (standaard is "25")
has_adult_content_protectionNeeBooleaansOf u de bescherming van inhoud voor volwassenen met Spam Scanner op dit domein wilt inschakelen
has_phishing_protectionNeeBooleaansOf u de phishing-beveiliging van Spam Scanner op dit domein wilt inschakelen
has_executable_protectionNeeBooleaansOf de uitvoerbare bescherming van Spam Scanner op dit domein moet worden ingeschakeld
has_virus_protectionNeeBooleaansOf u Spam Scanner-virusbescherming op dit domein wilt inschakelen
has_recipient_verificationNeeBooleaansAlgemene domeinstandaard om te bepalen of aliasontvangers op een e-mailverificatielink moeten klikken om e-mails door te laten stromen
ignore_mx_checkNeeBooleaansOf de MX-recordcontrole op het domein ter verificatie moet worden genegeerd. Dit is voornamelijk bedoeld voor gebruikers die geavanceerde MX-uitwisselingsconfiguratieregels hebben en hun bestaande MX-uitwisseling moeten behouden en doorsturen naar de onze.
retention_daysNeeNummerGeheel getal tussen 0 en 30 dat komt overeen met het aantal bewaardagen voor het opslaan van uitgaande SMTP-e-mails zodra ze succesvol zijn afgeleverd of als er een permanente fout is opgetreden. Standaard ingesteld op 0, wat betekent dat uitgaande SMTP-e-mails voor uw veiligheid onmiddellijk worden verwijderd en geredigeerd.
bounce_webhookNeeString (URL) of Booleaans (false)De http:// of https:// webhook URL van uw keuze om bounce webhooks naar te sturen. We zullen een POST verzoek naar deze URL met informatie over uitgaande SMTP-fouten (bijv. zachte of harde fouten, zodat u uw abonnees kunt beheren en uw uitgaande e-mail programmatisch kunt beheren).
max_quota_per_aliasNeeDraadOpslagmaximumquotum voor aliassen op deze domeinnaam. Voer een waarde in zoals "1 GB" die door bytes.

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

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres om uit te nodigen voor de ledenlijst van het domein
groupJaString (opsommbaar)Groep om de gebruiker aan het domeinlidmaatschap toe te voegen (kan een van zijn) "admin" of "user")

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

LichaamsparameterVerplichtTypeOmschrijving
emailJaTekenreeks (e-mail)E-mailadres om te verwijderen uit de ledenlijst van het domein

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

LichaamsparameterVerplichtTypeOmschrijving
groupJaString (opsommbaar)Groep om de gebruiker bij te werken naar het domeinlidmaatschap met (kan een van zijn) "admin" of "user")

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

LichaamsparameterVerplichtTypeOmschrijving
new_passwordNeeDraadUw aangepaste nieuwe wachtwoord dat u voor de alias kunt gebruiken. Houd er rekening mee dat u dit leeg kunt laten of helemaal kunt laten ontbreken in de hoofdtekst van uw API-verzoek als u een willekeurig gegenereerd en sterk wachtwoord wilt ontvangen.
passwordNeeDraadBestaand wachtwoord voor alias om het wachtwoord te wijzigen zonder de bestaande IMAP-mailboxopslag te verwijderen (zie is_override optie hieronder als u niet langer over het bestaande wachtwoord beschikt).
is_overrideNeeBooleaansUSE WITH CAUTION: Dit zal het bestaande aliaswachtwoord en de database volledig overschrijven, en zal de bestaande IMAP-opslag permanent verwijderen en de SQLite-e-maildatabase van de alias volledig opnieuw instellen. Maak indien mogelijk een back-up als u een bestaande mailbox aan deze alias heeft gekoppeld.
emailed_instructionsNeeDraadE-mailadres waarnaar het wachtwoord van de alias en installatie-instructies moeten worden verzonden.

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

Querystring-parameterVerplichtTypeOmschrijving
qNeeString (RegExp ondersteund)Zoek naar aliassen in een domein op naam, label of ontvanger
nameNeeString (RegExp ondersteund)Zoek op naam naar aliassen in een domein
recipientNeeString (RegExp ondersteund)Zoek naar aliassen in een domein op ontvanger
sortNeeDraadSorteren op een specifiek veld (voorvoegsel met een enkel streepje) - om in de omgekeerde richting van dat veld te sorteren). Standaard is created_at indien niet ingesteld.
pageNeeNummerZien Paginering voor meer inzicht
limitNeeNummerZien Paginering voor meer inzicht

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

LichaamsparameterVerplichtTypeOmschrijving
nameNeeDraadAliasnaam (indien niet opgegeven of leeg, wordt een willekeurige alias gegenereerd)
recipientsNeeString of ArrayLijst met ontvangers (moet door een regeleinde/spatie/komma worden gescheiden. String of array van geldige e-mailadressen, volledig gekwalificeerde domeinnamen ("FQDN"), IP-adressen en/of webhook-URL's – en indien niet opgegeven of leeg Array, dan wordt het e-mailadres van de gebruiker dat het API-verzoek doet, ingesteld als de ontvanger)
descriptionNeeDraadAliasbeschrijving
labelsNeeString of ArrayLijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
has_recipient_verificationNeeBooleaansVereisen dat ontvangers op een e-mailverificatielink klikken om e-mails door te laten stromen (standaard is de domeininstelling als deze niet expliciet is ingesteld in de hoofdtekst van het verzoek)
is_enabledNeeBooleaansOf deze alias moet worden in- of uitgeschakeld (indien uitgeschakeld, worden e-mails nergens naartoe gerouteerd, maar worden succesvolle statuscodes geretourneerd). Als een waarde wordt doorgegeven, wordt deze geconverteerd naar een Booleaanse waarde met behulp van booleaans)
error_code_if_disabledNeeNummer (ook 250, 421, of 550)Inkomende e-mail naar deze alias zal weigeren als is_enabled is false met beide 250 (rustig nergens afleveren, bijv. blackhole of /dev/null), 421 (zachte afwijzing; en opnieuw proberen gedurende maximaal ~5 dagen) of 550 permanente mislukking en afwijzing. Standaard ingesteld op 250.
has_imapNeeBooleaansOf IMAP-opslag voor deze alias moet worden in- of uitgeschakeld (indien uitgeschakeld, worden ontvangen inkomende e-mails niet opgeslagen in IMAP-opslag. Als een waarde wordt doorgegeven, wordt deze geconverteerd naar een Booleaanse waarde met behulp van booleaans)
has_pgpNeeBooleaansOf u dit nu wilt in- of uitschakelen OpenPGP-codering voor IMAP/POP3/CalDAV-gecodeerde e-mailopslag gebruik van de alias' public_key.
public_keyNeeDraadOpenPGP publieke sleutel in ASCII Armor-formaat (klik hier om een voorbeeld te bekijken; bijv. GPG-sleutel voor support@forwardemail.net). Dit geldt alleen als u dat heeft has_pgp ingesteld op true. Lees meer over end-to-end-encryptie in onze FAQ.
max_quotaNeeDraadOpslagmaximumquotum voor deze alias. Laat leeg om te resetten naar het huidige maximumquotum van het domein of voer een waarde in zoals "1 GB" die wordt geparseerd door bytesDeze waarde kan alleen door domeinbeheerders worden aangepast.

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

LichaamsparameterVerplichtTypeOmschrijving
nameNeeDraadAlias naam
recipientsNeeString of ArrayLijst met ontvangers (moet een regelafbreking / spatie / door komma's gescheiden string of array van geldige e-mailadressen, volledig gekwalificeerde domeinnamen ("FQDN"), IP-adressen en / of webhook-URL's zijn)
descriptionNeeDraadAliasbeschrijving
labelsNeeString of ArrayLijst met labels (moet een regeleinde / spatie / door komma's gescheiden string of array zijn)
has_recipient_verificationNeeBooleaansVereisen dat ontvangers op een e-mailverificatielink klikken om e-mails door te laten stromen (standaard is de domeininstelling als deze niet expliciet is ingesteld in de hoofdtekst van het verzoek)
is_enabledNeeBooleaansOf deze alias moet worden in- of uitgeschakeld (indien uitgeschakeld, worden e-mails nergens naartoe gerouteerd, maar worden succesvolle statuscodes geretourneerd). Als een waarde wordt doorgegeven, wordt deze geconverteerd naar een Booleaanse waarde met behulp van booleaans)
error_code_if_disabledNeeNummer (ook 250, 421, of 550)Inkomende e-mail naar deze alias zal weigeren als is_enabled is false met beide 250 (rustig nergens afleveren, bijv. blackhole of /dev/null), 421 (zachte afwijzing; en opnieuw proberen gedurende maximaal ~5 dagen) of 550 permanente mislukking en afwijzing. Standaard ingesteld op 250.
has_imapNeeBooleaansOf IMAP-opslag voor deze alias moet worden in- of uitgeschakeld (indien uitgeschakeld, worden ontvangen inkomende e-mails niet opgeslagen in IMAP-opslag. Als een waarde wordt doorgegeven, wordt deze geconverteerd naar een Booleaanse waarde met behulp van booleaans)
has_pgpNeeBooleaansOf u dit nu wilt in- of uitschakelen OpenPGP-codering voor IMAP/POP3/CalDAV-gecodeerde e-mailopslag gebruik van de alias' public_key.
public_keyNeeDraadOpenPGP publieke sleutel in ASCII Armor-formaat (klik hier om een voorbeeld te bekijken; bijv. GPG-sleutel voor support@forwardemail.net). Dit geldt alleen als u dat heeft has_pgp ingesteld op true. Lees meer over end-to-end-encryptie in onze FAQ.
max_quotaNeeDraadOpslagmaximumquotum voor deze alias. Laat leeg om te resetten naar het huidige maximumquotum van het domein of voer een waarde in zoals "1 GB" die wordt geparseerd door bytesDeze waarde kan alleen door domeinbeheerders worden aangepast.

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

LichaamsparameterVerplichtTypeOmschrijving
inputJaDraadElke geldige TXT-record voor doorsturen van e-mail in platte tekst

Voorbeeldaanvraag:

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