Email API-sleutels

Laatst gecontroleerd

Met een Email API-sleutel kan een app (een website, een webshop, een boekingssysteem, een script) één mailbox gebruiken: mail versturen namens de mailbox, de mail lezen, of de mail lezen en wijzigen. De app logt in met het mailboxadres en de sleutel in plaats van met iemands wachtwoord.

Een sleutel hoort bij het account, niet bij de persoon die hem maakte. Hij blijft werken als die persoon het team verlaat of zijn login reset, en de regel voor beveiligingssleutels van het account geldt er niet voor, omdat niemand er met de hand mee inlogt.

Voordat je begint

  • Je bent de eigenaar (Owner), een beheerder (Administrator) of een Developer van het account, of je beheert de e-mail van de site waar de mailbox bij hoort.
  • De mailbox bestaat. Een aparte mailbox, zoals noreply@example.com of orders@example.com, houdt de mail van de app gescheiden van die van mensen en maakt de verzendlimieten overzichtelijk (Een mailbox aanmaken).

Een sleutel maken

  1. Open Email, zoek de mailbox, open het menu van de rij en kies Email API keys….
  2. Geef de sleutel onder Create a key een Name naar de app die hem gaat gebruiken, bijvoorbeeld "Bestelmails webshop".
  3. Kies wat The app may doen:
    • Send mail: mail versturen als de mailbox (en zijn aliassen).
    • Read mail: berichten opsommen, doorzoeken en downloaden. Dit verandert niets, zelfs geen markering als gelezen.
    • Change mail: markeren als gelezen, een vlag zetten, verplaatsen, verwijderen en concepten opslaan. Lezen zit erbij.
  4. Optioneel: zet in Allowed from de serveradressen of adresbereiken van je app, één per regel (bijvoorbeeld 203.0.113.7 of 2001:db8::/48). Laat het leeg om elk adres toe te staan. Maximaal 20 regels. Heeft je server zowel IPv4 als IPv6, zet ze dan allebei erin.
  5. Kies wanneer de sleutel verloopt (Expires): 30 days, 90 days en 1 year, of Never. Een sleutel die nooit verloopt, moet Allowed from ingevuld hebben.
  6. Klik op Create key en bevestig je wachtwoord.

De sleutel wordt één keer getoond, samen met de verbindingsinstellingen en, voor een sleutel die mag versturen, een kant-en-klaar .env-fragment. Kopieer hem meteen naar je app: niemand kan hem je opnieuw laten zien, ook wij niet. Ben je hem kwijt, roteer of trek hem dan in en maak een nieuwe.

Je app koppelen

Instelling Waarde
Gebruikersnaam het mailboxadres
Wachtwoord de Email API-sleutel
Versturen (SMTP) smtp.veldhost.eu, poort 2525, STARTTLS
Lezen (IMAP) imap.veldhost.eu, poort 993, SSL/TLS

Email API-sleutels versturen alleen via poort 2525. Wachtwoorden van mensen en app-wachtwoorden blijven de gewone poorten gebruiken en werken niet op 2525. Voorbeelden stap voor stap: E-mail versturen vanuit je app en E-mail lezen vanuit je app.

Roteren, intrekken en vervallen

  • Rotate… in het menu van een sleutel maakt een nieuwe sleutel met dezelfde rechten, toegestane adressen en vervaldatum. De oude sleutel blijft nog 24 uur werken, zodat je de app zonder onderbreking kunt bijwerken, en stopt daarna.
  • Revoke zet een sleutel meteen stop.
  • De eigenaar en de beheerders van het account krijgen 14 dagen voordat een sleutel verloopt een e-mail. Een verlopen sleutel werkt niet meer; roteer hem op tijd om de app draaiende te houden.
  • Een mailbox heeft maximaal 25 sleutels.

De lijst laat zien wanneer elke sleutel voor het laatst is gebruikt (Last used), wie hem maakte, en een badge Sending paused zolang de maandelijkse uitgavenlimiet van het account het versturen stopt (Prijzen van de Email API).

Via de API of een AI-assistent

Met een API-token of een gekoppelde AI-assistent kun je de sleutels van een mailbox bekijken en er een intrekken, bijvoorbeeld als een sleutel is uitgelekt:

  • GET /mail/mailboxes/MAILBOX/api-keys toont de sleutels (read-scope): wat elke sleutel mag, de toegestane adressen, de vervaldatum en het laatste gebruik. De sleutel zelf wordt nooit getoond.
  • DELETE /mail/mailboxes/MAILBOX/api-keys/KEY_ID trekt er meteen een in (manage-scope).

Een sleutel maken blijft in het portaal, omdat het geheim één keer aan jou wordt getoond en nooit aan een assistent. Een assistent geeft je in plaats daarvan de link naar de juiste pagina.

Note: Een sleutel hoort bij het mailboxadres. Verwijder je de mailbox, dan stoppen de sleutels. Krijgt de mailbox een ander adres, dan stoppen de sleutels ook, en de pagina Email API keys zegt welke: maak nieuwe sleutels voor het nieuwe adres en werk de app bij.

Gerelateerd

Kom je er niet uit? Neem contact op met support — antwoord binnen één werkdag.