Aanmelding bij mailbox opschorten via API

Door de aanmelding op te schorten, kan iemand niet meer bij een mailbox terwijl de mailbox zelf blijft werken. E-mail wordt normaal bezorgd en blijft voor de gebruiker klaarstaan; niets wordt teruggestuurd of gaat verloren. Deze pagina is de opdrachtenreferentie voor deze instelling.

Dezelfde bediening staat in het dashboard onder Mailboxen → (een mailbox) → Limieten. Ze is beschikbaar bij elk abonnement en kost niets extra.

Opschorten of pauzeren: verschillende aanroepen

Gebruik :suspend-login voor een klant die niet heeft betaald, iemand tussen twee contracten of iedereen van wie u de e-mail nog wilt opvangen. Gebruik :pause wanneer de mailbox volledig moet stoppen, ook voor afzenders.

Er is een derde status die met geen van beide aanroepen kan worden ingesteld. Als uitgaande activiteit erop wijst dat het wachtwoord van een mailbox is misbruikt, kan TrekMail verzending vanuit die mailbox stoppen terwijl aanmelding en bezorging blijven werken. Verzendingen geven dan 403 mailbox_sending_paused terug. Zowel :resume als :resume-login heft dit niet op, en de aanroep herhalen helpt evenmin: het wachtwoord moet worden gewijzigd en support schakelt de verzending weer in. Zie Waarom kan ik geen e-mail verzenden?.

Vereist bereik

mailboxes:write, hetzelfde bereik waarmee elk ander mailboxveld wordt bijgewerkt. Alle onderstaande endpoints accepteren een Idempotency-Key-header.

Eén mailbox

curl -s -X POST "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}:suspend-login" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: suspend-{MAILBOX_ID}-invoice-42" \
  -d '{"reason":"Unpaid invoice 42"}'

{ "status": "login_suspended", "message": "Sign-in has been suspended. The mailbox keeps receiving mail." }

reason is optioneel en mag maximaal 255 tekens bevatten. De reden wordt in uw dashboard weergegeven en door de API teruggegeven; de opgeschorte gebruiker ziet deze nooit.

Zo heft u de opschorting op:

curl -s -X POST "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}:resume-login" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Idempotency-Key: resume-{MAILBOX_ID}"

De status lezen

Zowel GET /api/v1/mailboxes/{id} als het lijst-endpoint bevat de status, zodat u een controle kunt uitvoeren zonder iets te wijzigen:

{ "data": { "id": 1701, "email": "sam@example.com", "status": "active",
            "login_suspended": true,
            "login_suspended_at": "2026-08-16T14:02:11+00:00",
            "login_suspended_reason": "Unpaid invoice 42", "...": "..." } }

Let erop dat status active blijft. Dit is geen fout die u moet omzeilen: de mailbox is actief en ontvangt e-mail. Lees login_suspended voor de aanmelding en status om te bepalen of de mailbox zelf actief is.

Meerdere mailboxen tegelijk

curl -s -X POST "https://trekmail.net/api/v1/mailboxes:login-access" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: suspend-domain-123-august" \
  -d '{"domain_id":123,"login_suspended":true,"reason":"Unpaid invoice 42"}'

Geef precies één selectiecriterium door:

Het antwoord laat zien wat er is gebeurd:

{ "data": { "login_suspended": true, "matched": 24, "updated": 21, "skipped": 3 } }

matched is het aantal mailboxen dat met het selectiecriterium is gevonden, updated het aantal dat daadwerkelijk is gewijzigd en skipped het aantal waarop de aanroep niet kon worden toegepast. Mailboxen die al de gevraagde status hebben, worden wel gevonden maar niet bijgewerkt. De aanroep kan dus veilig worden herhaald, wat handig is als een factureringstaak deze elke nacht uitvoert.

Stel "login_suspended": false in om dezelfde groep te herstellen.

Met een MCP-agent

suspend_mailbox_login(mailbox_id=1701, reason="Unpaid invoice 42")
resume_mailbox_login(mailbox_id=1701)
set_mailboxes_login_access(domain_id=123, login_suspended=true, reason="Unpaid invoice 42")

Alle drie de tools zijn beschikbaar voor een agent met het vereiste bereik. Bij een lokaal gehoste MCP-server kan de beheerder expliciete goedkeuring voor schrijfacties vereisen. Zo wordt voorkomen dat een agent gebruikers per ongeluk buitensluit.

Wat een opgeschorte mailbox doet

De opschorting wordt bij elke toegang afgedwongen en is niet alleen in de interface verborgen:

• aanmelden bij webmail wordt geweigerd en elke reeds geopende sessie wordt beëindigd
• IMAP-, POP- en SMTP-verificatie wordt geweigerd, waardoor e-mailapps niet meer werken en niets kan worden verzonden
• CalDAV en CardDAV worden geweigerd, waardoor agenda en contacten niet meer met telefoons en laptops worden gesynchroniseerd
• berichttokens (tm_msg_) voor de mailbox antwoorden met 422 mailbox_login_suspended. Ze worden niet ingetrokken en werken dus weer zodra de aanmelding is hersteld
• apparaatwachtwoorden voor bestandssynchronisatie worden ingetrokken, en dat is permanent; na het opheffen van de opschorting worden nieuwe aangemaakt
• links voor het opnieuw instellen van het wachtwoord en herstelcodes werken niet meer, en nieuwe kunnen niet worden uitgegeven; het wachtwoord opnieuw instellen herstelt de toegang niet, omdat het wachtwoord de blokkering niet veroorzaakt
• inkomende e-mail wordt normaal bezorgd, en doorstuurregels en filters blijven werken

Er wordt niets verwijderd. Elk bericht, contact, agenda-item en bestand blijft staan waar het stond, en de mailbox blijft meetellen voor uw abonnement en de opslag ervan. De e-mail blijft binnenkomen.

Migraties naar een opgeschorte mailbox

Een migratie naar een opgeschorte mailbox kan niet worden gestart: POST /api/v1/migrations antwoordt met 422 mailbox_login_suspended. Het importprogramma meldt zich aan om de gekopieerde e-mail te bezorgen, waardoor de taak onderweg zou mislukken. Herstel de aanmelding, voer de migratie uit en schort deze daarna opnieuw op als dat nog nodig is.

Gedeelde mailboxen

Gedeelde mailboxen worden op het afzonderlijke endpoint geweigerd met 422 mailbox_unavailable en door het bulkendpoint overgeslagen, maar nog wel geteld. Niemand meldt zich rechtstreeks aan bij een gedeelde mailbox: uw team opent deze vanuit de eigen mailbox. Door de mailbox van die persoon op te schorten, sluit u dus ook de toegang tot de gedeelde mailbox. Een opschorting opslaan in de gedeelde rij zou de indruk wekken dat er iets gebeurt, maar niets veranderen.

Mogelijke fouten