Compare commits

...
5 Commits
Author SHA1 Message Date
zemion 22c8d0af43 fix(ui): align contextual documentation with headings
Verified with the coordinated workspace changes by devkit full run
2026-09-08T225814-186389-0000-3e3ed7cd (all seven phases passed).
This shared UI pass does not mark the individual module reviews complete.
2026-09-09 02:03:54 +02:00
zemion d926298214 fix(mail): bind POP3 imports to stable maildrop identity
Module Package Release / publish-packages (push) Successful in 14s
Release v0.1.28. Coordinated integrity review: GovOPlaN/govoplan-core#298.
2026-09-08 12:19:39 +02:00
zemion 480c18c67c Release govoplan-mail v0.1.27: stabilize credentials, folder encoding and transport progress
Module Package Release / publish-packages (push) Successful in 11s
2026-09-08 01:32:44 +02:00
zemion c62c7783d6 feat: inventory SMTP infrastructure dependencies
Module Package Release / publish-packages (push) Successful in 12s
2026-08-24 14:56:27 +02:00
zemion ecc1283de7 feat: contribute Messages product surface
Module Package Release / publish-packages (push) Successful in 11s
2026-08-24 12:53:44 +02:00
39 changed files with 3883 additions and 1052 deletions
+11
View File
@@ -6,6 +6,17 @@
GovOPlaN Mail is the mail transport module. It owns reusable SMTP/IMAP/JMAP profile management, an explicitly enabled legacy POP3 import path, mail profile policy enforcement, mock mail infrastructure, and the mail WebUI package. GovOPlaN Mail is the mail transport module. It owns reusable SMTP/IMAP/JMAP profile management, an explicitly enabled legacy POP3 import path, mail profile policy enforcement, mock mail infrastructure, and the mail WebUI package.
POP3 is part of this same `mail` module, not a separately installed module.
Its **Legacy import** navigation entry opens a dedicated Mail workflow because
retrieving historical messages requires explicit permissions, duplicate checks,
and retained-source evidence. It shares Mail's profiles, server definitions,
credential ownership, migrations, and release package.
Deutsch: POP3 gehört zum selben Modul **Mail**. Der eigene Navigationseintrag
**Altbestand importieren** öffnet lediglich einen gesonderten Mail-Arbeitsablauf
mit ausdrücklichen Berechtigungen, Dublettenprüfung und Herkunftsnachweisen;
es gibt kein separat zu installierendes POP3-Modul.
## Ownership ## Ownership
This repository owns: This repository owns:
+17 -2
View File
@@ -9,7 +9,7 @@ mailbox, policy, and delivery-evidence consequences described here.
| Surface | Primary task | Archetype | Consequence | Pattern evidence | | Surface | Primary task | Archetype | Consequence | Pattern evidence |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| `/mail` folder, message, and preview panes | Browse and inspect an authorized mailbox without changing provider state | Directory/explorer | Medium because message metadata and content are private, although navigation is read-only | Full-height three-pane workspace, bounded paging, stable keyboard selection, contextual Help Center link, explicit no-profile blocker | | `/mail` folder, message, and preview panes | Browse and inspect an authorized mailbox without changing provider state | Directory/explorer | Medium because message metadata and content are private, although navigation is read-only | Full-height three-pane workspace, bounded paging, stable keyboard selection, contextual Help Center link, explicit no-profile blocker |
| `/mail` toolbar, page filter, and pagination | Select a profile, refresh bounded indexes, and find a message on the current page | Explorer actions and local filtering | Low for refresh; medium for provider access | Shared actions expose loading/profile/folder blockers; profile transport summary is non-secret; loading and errors use Core components | | `/mail` toolbar, page filter, and pagination | Select a profile, refresh the current bounded mailbox context, and find a message | Explorer actions and local filtering | Low for refresh; medium for provider access | Persistent `WorkspaceFrame`/`WorkspaceActionBar` keeps one right-aligned Reload; shared `FormField` profile selection; labelled Mailbox tools `Dialog` groups targeted refreshes and related diagnostics through `FormSection`; loading/profile/folder/permission blockers remain visible |
| System/tenant/group/user/campaign profile surfaces | Compare profiles, protocol servers, reusable credentials, status, and scope | Administration/configuration | High because endpoints, credentials, and inheritance control external communication | Shared `ConnectionTree`, stable row actions, textual status, permission/target blockers, and contextual admin help | | System/tenant/group/user/campaign profile surfaces | Compare profiles, protocol servers, reusable credentials, status, and scope | Administration/configuration | High because endpoints, credentials, and inheritance control external communication | Shared `ConnectionTree`, stable row actions, textual status, permission/target blockers, and contextual admin help |
| Profile creation and focused profile/server/credential editors | Create a governed transport identity or edit one hierarchy object | Guided setup plus adaptive create/edit | High because saving may enable provider access or replace encrypted credentials | Shared `Dialog` and `StageRail` for multi-object setup; focused edit modes show only the selected hierarchy object; field help, connection tests, unsaved-draft guard, and disabled-save reasons | | Profile creation and focused profile/server/credential editors | Create a governed transport identity or edit one hierarchy object | Guided setup plus adaptive create/edit | High because saving may enable provider access or replace encrypted credentials | Shared `Dialog` and `StageRail` for multi-object setup; focused edit modes show only the selected hierarchy object; field help, connection tests, unsaved-draft guard, and disabled-save reasons |
| Mail profile policy card | Narrow visible profiles, lower-scope definitions, hosts, senders, and recipients | Effective-policy editor | High because inherited allow/deny rules govern delivery and lower scopes | Shared policy rows, typed selectors, source path, locked/read-only blocker, dirty-save state, and contextual policy help | | Mail profile policy card | Narrow visible profiles, lower-scope definitions, hosts, senders, and recipients | Effective-policy editor | High because inherited allow/deny rules govern delivery and lower scopes | Shared policy rows, typed selectors, source path, locked/read-only blocker, dirty-save state, and contextual policy help |
@@ -42,6 +42,15 @@ mailbox, policy, and delivery-evidence consequences described here.
copy distinguishes retained reusable credentials from scrubbed owned secrets. copy distinguishes retained reusable credentials from scrubbed owned secrets.
- Mailbox browsing is read-only. Listing or previewing must not mark messages - Mailbox browsing is read-only. Listing or previewing must not mark messages
read, move, delete, reply, or expose unbounded content. read, move, delete, reply, or expose unbounded content.
- The mailbox Reload rechecks authorized profiles and refreshes the current
catalogue, bounded page, and still-selected message. IMAP retains its page;
JMAP refresh starts a new cursor chain while keeping the search. Selecting a
synthetic grouping refreshes only the catalogue. Refresh failures retain
usable data and a retry; request identities reject previous-profile/tenant
results. Folder expansion is independent of labels and refreshes. Advanced
targeted reads and bounce diagnostics remain in the labelled tools dialog,
not a second persistent toolbar. Escape in that dialog leaves message
selection intact.
## Accessibility, responsive, and privacy evidence ## Accessibility, responsive, and privacy evidence
@@ -52,8 +61,14 @@ reasons are keyboard-focusable. Status always has text in addition to color.
Contextual links identify their destination to assistive technology. Contextual links identify their destination to assistive technology.
Profile/policy grids collapse to one column below 900 px. The mailbox changes Profile/policy grids collapse to one column below 900 px. The mailbox changes
from three panes to two below 1250 px and to a single-column toolbar and message from three panes to two below 1280 px and to single-column message
rows below 760 px while preserving source order and independent scroll regions. rows below 760 px while preserving source order and independent scroll regions.
Core owns toolbar wrapping, with Reload right-aligned even on narrow screens.
The two-row mailbox layout shares the available height between list and preview
instead of reserving a fixed preview minimum that can squeeze message rows to
zero height. Narrow screens stack compact folders, a usable message index, and
the preview within a vertically scrollable bounded workspace. The action
header never scrolls away, and each pane retains its own bounded scroll region.
Long identities and transport summaries wrap or ellipsize inside stable bounds. Long identities and transport summaries wrap or ellipsize inside stable bounds.
Profile and mailbox APIs return non-secret transport metadata and bounded Profile and mailbox APIs return non-secret transport metadata and bounded
+181 -7
View File
@@ -61,6 +61,14 @@ conflicting profile is preserved unless the reviewed fragment explicitly sets
`on_conflict` to `update`. Credential bindings are added idempotently and are `on_conflict` to `update`. Credential bindings are added idempotently and are
never removed merely because a package omits a credential reference. never removed merely because a package omits a credential reference.
Mail also registers a module-owned infrastructure dependency provider. Its
authorized Ops inventory lists every persisted SMTP endpoint and legacy SMTP
profile by stable non-secret reference, state and scope, together with numeric
credential-binding evidence. Before the host deployer changes or removes
`mail.smtp`, it requires a fresh, complete inventory from the same installation
and displays these dependencies in the plan. The inventory never contains
transport credentials or decrypted envelope data.
Preflight does not prove SMTP reachability. After apply, use the normal Mail Preflight does not prove SMTP reachability. After apply, use the normal Mail
profile test and Ops health surfaces. If the receipt says SMTP is unavailable, profile test and Ops health surfaces. If the receipt says SMTP is unavailable,
is invalid, or is not mounted, import is blocked with an operator-facing is invalid, or is not mounted, import is blocked with an operator-facing
@@ -106,6 +114,16 @@ profile/server. Empty roles retain automatic behavior. The historical
for compatibility; a Campaign-specific Sent override still wins for that for compatibility; a Campaign-specific Sent override still wins for that
Campaign. Campaign.
Use readable Unicode names such as `Entwürfe`, not IMAP wire encodings such as
`Entw&APw-rfe`. Discovery decodes modified UTF-7 before detecting standard
folder roles; SELECT, STATUS, and Sent APPEND encode and quote the chosen name
for the active connection. Literal ampersands, quotes, backslashes, and Unicode
characters round-trip without renaming remote folders. Previously saved
wire-form names are resolved against that account's live folder list; if the
same string is also an actual readable folder name, the readable name wins.
Rediscovery and an explicit profile save replace old encoded configuration
values with readable names; background reads never rewrite configuration.
Profiles may be scoped to system, tenant, user, group, or campaign context. Profiles may be scoped to system, tenant, user, group, or campaign context.
Scope controls where a profile can be discovered; effective policy can narrow Scope controls where a profile can be discovered; effective policy can narrow
that further. A visible profile is not automatically authorized for every that further. A visible profile is not automatically authorized for every
@@ -183,6 +201,19 @@ non-production provider and mailbox first. A successful connection test does
not prove policy authorization for a later Campaign context, deliverability, not prove policy authorization for a later Campaign context, deliverability,
recipient acceptance, SPF/DKIM/DMARC alignment, or future availability. recipient acceptance, SPF/DKIM/DMARC alignment, or future availability.
Campaign runtime authorization follows the protocol being used: SMTP batch and
single-message calls enforce the explicit SMTP credential policy, while
append-to-Sent enforces the IMAP credential policy. A valid SMTP call does not
need to carry an unrelated IMAP credential just because the profile supports
both protocols. Full campaign authoring validation and complete profile
summaries continue to require both configured selections when their policies
forbid inherited credentials. The selected protocol's missing credential,
inactive/unauthorized binding or stale transport revision still stops the
operation before decryption or provider contact. Resolving a policy rejection
never requires disabling TLS or weakening either credential policy. Correcting
this runtime check does not change stored configuration or approved builds,
reset job state, or retry/send messages automatically.
Testing a saved profile requires both `mail:profile:test` and Testing a saved profile requires both `mail:profile:test` and
`mail:profile:use`, and the profile must be active. Profile creation or test `mail:profile:use`, and the profile must be active. Profile creation or test
authority alone is not enough. authority alone is not enough.
@@ -193,10 +224,46 @@ ordinary consumers to bypass reusable profiles.
### Read a mailbox ### Read a mailbox
The persistent workspace header contains the profile selector, **Mailbox tools**,
Help, and one right-aligned **Reload**. These controls remain available when the
mailbox is empty or no usable profile is configured. Reload rechecks the permitted
profiles and refreshes the current folder catalogue and bounded message page;
it also rereads a selected message if that message remains on the page. IMAP
keeps the page offset. JMAP starts a fresh cursor chain at page one while keeping
the search term. An unavailable profile is replaced only by another currently
authorized active profile, or the explicit no-profile state.
Folder icons expand or collapse; labels select. Synthetic grouping labels select
the group without reading a nonexistent provider folder, and Reload in that
state refreshes only the folder catalogue. Refreshes keep user-controlled
expansion. A failed refresh preserves usable loaded data, shows the error, and
leaves Reload available for retry; late responses from an earlier profile or
tenant cannot replace the current context.
Mailbox context reads bypass browser response/promise reuse so an immediate
Reload really rechecks permissions and state. Mail's bounded server-side index
is unchanged; its explicit refresh flag and live/cached provenance still apply.
Failed pagination restores the page and page-size labels belonging to retained
rows. Dismissing or changing the preview while Reload is pending takes
precedence over its remembered selection.
On narrow screens, scroll vertically through folders, message list, and preview
within the mailbox workspace; the profile/tools/Reload header remains visible.
**Mailbox tools** groups the occasional profile-only, folder-only, and
message-only refreshes in a dialog, separate from **Bounce status**. Bounce
status requires `mail:bounce:read` or `mail:bounce:manage`; without either it
remains visible and disabled with an explanation. Escape closes this dialog
without clearing the selected message. These read controls do not grant profile
administration, send SMTP messages, APPEND messages, or change mailbox flags.
The current mailbox UI and API are read-only. An authorized user can list IMAP The current mailbox UI and API are read-only. An authorized user can list IMAP
or JMAP folders, page through messages, and inspect a bounded full message. or JMAP folders, page through messages, and inspect a bounded full message.
IMAP folder names are parsed and quoted defensively; Sent-folder discovery uses IMAP folder names are decoded for display and encoded and quoted defensively
provider flags and common names. JMAP discovers the Session and Mail account, for mailbox commands; Sent-folder discovery uses provider flags and common
readable names. The default IMAP4rev1 mode uses modified UTF-7. A connection
that has explicitly enabled `UTF8=ACCEPT` uses UTF-8 instead; merely advertising
that capability does not change encoding. Invalid provider encodings produce
an explicit error rather than a replacement name that could address another
folder. Refresh any already-loaded folder list after upgrading. JMAP discovers the Session and Mail account,
uses `Mailbox/get` hierarchy and roles, runs text search with `Email/query`, and uses `Mailbox/get` hierarchy and roles, runs text search with `Email/query`, and
uses `Email/get` for bounded summaries/details. `Email/changes` exposes a uses `Email/get` for bounded summaries/details. `Email/changes` exposes a
bounded incremental cursor; an expired state tells the caller to perform a full bounded incremental cursor; an expired state tells the caller to perform a full
@@ -206,6 +273,9 @@ page came directly from the provider, from the bounded mailbox index, or from
an index while a refresh is in progress, including the index timestamp when an index while a refresh is in progress, including the index timestamp when
available. available.
The mailbox-name boundary follows [RFC 3501 section 5.1.3](https://www.rfc-editor.org/rfc/rfc3501.html#section-5.1.3)
and, only after explicit activation, [RFC 6855 section 3](https://www.rfc-editor.org/rfc/rfc6855.html#section-3).
Message HTML is displayed only in the shared sandboxed message component. Message HTML is displayed only in the shared sandboxed message component.
Remote URLs and active markup are removed, embedded `data:`/`cid:` image Remote URLs and active markup are removed, embedded `data:`/`cid:` image
references remain isolated, and plain text is always available when supplied. references remain isolated, and plain text is always available when supplied.
@@ -332,6 +402,19 @@ account's user scope. Grant `mail:profile:write_own` for self-service;
An update that omits a password preserves the current encrypted password. A An update that omits a password preserves the current encrypted password. A
credential replacement never depends on reading the old cleartext value back. credential replacement never depends on reading the old cleartext value back.
The shared credential editor resolves Mail server restrictions from the
authorized metadata catalogue when it opens. Names appear as loading completes;
no page refresh is required, and typing in a draft does not reload the catalogue.
Closing and reopening refreshes the available servers and can retry a temporary
metadata failure. Inactive servers remain labelled inactive; deleted or
unauthorized references remain visible as unavailable and are never silently
removed from the credential. Labels do not grant permission to use a server,
and the lookup does not retrieve secrets.
If saving a reusable credential fails, the editor shows the error beside the
unchanged draft. Retry explicitly after correcting the cause. Saving disables
editing and closing until the request finishes; a failed save never silently
discards a replacement secret that has not been stored.
### Delete a profile ### Delete a profile
Profile deletion is immediate for Mail-owned secrets and audit evidence: Profile deletion is immediate for Mail-owned secrets and audit evidence:
@@ -360,13 +443,32 @@ Effective policy is contextual. Administrators should document:
- allowed and denied SMTP/IMAP/JMAP hosts; - allowed and denied SMTP/IMAP/JMAP hosts;
- permitted From, envelope sender (including bounce address), and envelope - permitted From, envelope sender (including bounce address), and envelope
recipient-domain patterns; recipient-domain patterns;
- whether SMTP/IMAP credentials inherit from the reusable profile; and - whether SMTP/IMAP may use a default credential or require an explicit Mail-owned credential selection; and
- which lower-level settings are locked by a parent policy. - which lower-level settings are locked by a parent policy.
Campaign delivery requires reusable profile credentials. A legacy policy that In **Mail profile policy → Credential selection**, SMTP and IMAP have separate
requires campaign-local credentials fails closed with guidance to store them on controls. **Allow profile default credential** (`inherit: true`) permits either
the Mail profile and enable effective inheritance. This preserves compatibility the selected server's default credential or an explicit authorized Mail-owned
of the policy model without reopening a consumer-owned secret store. credential. **Require explicit Mail credential** (`inherit: false`) requires a
server and credential reference in Campaign Mail settings. Neither option
permits campaign-local passwords or copies a secret into Campaign.
**Inherit policy from parent** leaves the local value unset; it is different
from allowing a server's default credential. System policy always has a concrete
choice. Other scopes show the local choice alongside the saved effective result
and policy path. **Allow override** controls
`allow_lower_level_limits["smtp_credentials.inherit"]` and the equivalent IMAP
key. It is not a separate `allow_override` field in the credential object. A
parent's explicit-credential requirement may be changed by a child only while
that parent allows overrides. Locked fields and their override controls remain
read-only; a lower scope cannot unlock them. Campaign policy has no lower-level
override controls. Editing any policy still requires that scope's policy-write
permission and an unlocked workflow.
Policy saves retain their draft after a failed write and require an explicit
retry. If the policy was saved but a dependent screen refresh fails, the editor
reports that the policy was saved and advises reloading the display; it does not
report a failed save or repeat the accepted write.
Policy reads are available through system/tenant/context routes to suitably Policy reads are available through system/tenant/context routes to suitably
authorized actors. Adaptive Docs exposes a safe explanation of the effective authorized actors. Adaptive Docs exposes a safe explanation of the effective
@@ -443,6 +545,78 @@ treated as an unknown provider mutation.
confirmed absence records verified recovery and permits only a new, confirmed absence records verified recovery and permits only a new,
deliberate attempt identifier. deliberate attempt identifier.
### Bounded IMAP append batches / Begrenzte IMAP-Ablagestapel
Campaign's bulk Sent-folder operation can use the optional
`mail.campaign_delivery.campaign_imap_batch(tenant_id=..., campaign_id=...)`
context. Opening this context has no provider effect. Mail opens a connection
only after an individual message passes its current authorization, selected
IMAP credential policy, both frozen transport revisions and durable recovery
checks. Subsequent messages reuse that authenticated connection and its detected
Sent folder, including the provider's original Unicode mailbox wire encoding.
Authorization and credential resolution are performed for every message, not
cached. Changing the authorized profile, selected references, folder or resolved
credentials releases the previous connection before the next APPEND.
Each message still receives one sequential APPEND and its own recovery evidence.
There is no parallel APPEND, MULTIAPPEND, automatic SMTP resend or replay after
APPEND starts. A lost APPEND reply remains outcome-unknown and requires explicit
mailbox reconciliation. Failures while connecting, before any APPEND, may use a
bounded reconnect; rejected authentication is not retried. A failure to finalize
accepted recovery evidence closes the batch. Cleanup/logout failure does not
turn an accepted APPEND into a failed one. Session state is scoped to the current
batch, never shared across tenants or campaigns, and is released on exit.
Deployment controls apply to batch connection reuse, not campaign authorization:
| Environment variable | Default | Range / effect |
| --- | --- | --- |
| `GOVOPLAN_IMAP_BATCH_REUSE` | `true` | `false`, `0`, `no` or `off` disables reuse. |
| `GOVOPLAN_IMAP_BATCH_MAX_MESSAGES` | `100` | 110,000 successful APPENDs per connection. |
| `GOVOPLAN_IMAP_BATCH_MAX_AGE_SECONDS` | `300` | 13,600 seconds; rotate before the next message, not during an APPEND. |
| `GOVOPLAN_IMAP_BATCH_IDLE_HEALTH_CHECK_SECONDS` | `30` | 03,600 seconds idle before a NOOP; 0 checks every reuse. |
| `GOVOPLAN_IMAP_BATCH_RECONNECT_ATTEMPTS` | `1` | 05 extra connection attempts, only before APPEND. |
Invalid numeric values use defaults; out-of-range numbers are clamped. An active
session keeps the policy with which it was created. Existing single-message
callers retain one connection per call and no automatic connection retries.
Older Mail capabilities without this optional context keep the single-message
behavior. Safe outcome fields include connection sequence, session reuse and
reconnect count; they contain no hosts, credentials, provider responses or MIME
content. Fewer logins and folder discoveries improve connection overhead, not
the provider's intrinsic per-message APPEND or durable-evidence latency.
Deutsch: Die Sammelablage im Gesendet-Ordner kann eine begrenzte authentifizierte
IMAP-Verbindung wiederverwenden. Der Stapelkontext allein verbindet sich nicht.
Vor jeder Nachricht prüft Mail erneut Berechtigung, IMAP-Zugangsdatenrichtlinie,
beide eingefrorenen Transportrevisionen und Wiederherstellungsnachweise; die
Zugangsdaten werden weiterhin je Nachricht aufgelöst. Profil, ausgewählte
Referenzen, Ordner oder aufgelöste Zugangsdaten dürfen nicht stillschweigend von
einer älteren Verbindung übernommen werden. Ordnererkennung und ursprüngliche
Provider-Kodierung bleiben ausschließlich an dieselbe Verbindung gebunden.
Jede Nachricht erhält weiterhin einen einzelnen, sequenziellen APPEND und einen
eigenen Nachweis. Es gibt kein paralleles APPEND, kein MULTIAPPEND und keine
automatische Wiederholung nach Beginn von APPEND. Ein unbekanntes Ergebnis muss
am Postfach abgeglichen werden; eine fehlende Gesendet-Kopie darf keinen erneuten
SMTP-Versand auslösen. Nur Verbindungsaufbau vor APPEND darf begrenzt wiederholt
werden, nicht eine abgelehnte Anmeldung. Ein Fehler beim Abschluss des
Wiederherstellungsnachweises schließt den Stapel; ein reiner Abmeldefehler macht
eine bestätigte Ablage nicht rückgängig. Mandanten und Kampagnen teilen keine
Stapelverbindung.
Die obigen Betriebsvariablen bedeuten standardmäßig: Wiederverwendung aktiv,
höchstens 100 Nachrichten bzw. 300 Sekunden pro Verbindung, NOOP nach 30 Sekunden
Leerlauf und höchstens einen zusätzlichen Verbindungsversuch vor APPEND. Der
Wechsel erfolgt vor der nächsten Nachricht, niemals mitten im APPEND. `0` beim
Leerlaufintervall prüft jede Wiederverwendung; deaktivierte Wiederverwendung
verwendet weiterhin einzelne APPENDs. Ungültige Zahlen verwenden den Standard,
Zahlen außerhalb des Wertebereichs werden begrenzt. Eine aktive Verbindung
behält ihre beim Aufbau gelesene Richtlinie. Einzelaufrufe und ältere optionale
Mail-Verträge bleiben kompatibel. Verbindungszähler enthalten keine Zugangsdaten
oder Providerdetails. Die Optimierung spart Verbindungsaufbau und Ordnersuche;
Provider-Ablage und dauerhafte Einzelnachweise benötigen weiterhin ihre Zeit.
### Delivery-status and calendar-reply sources ### Delivery-status and calendar-reply sources
An authorized Mail bounce source scans a bounded IMAP UID range without An authorized Mail bounce source scans a bounded IMAP UID range without
+3 -3
View File
@@ -1,14 +1,14 @@
{ {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.18", "@govoplan/core-webui": "^0.1.45",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
+2 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"private": true, "private": true,
"type": "module", "type": "module",
"main": "webui/src/index.ts", "main": "webui/src/index.ts",
@@ -19,7 +19,7 @@
"LICENSE" "LICENSE"
], ],
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.18", "@govoplan/core-webui": "^0.1.45",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
+2 -2
View File
@@ -4,14 +4,14 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-mail" name = "govoplan-mail"
version = "0.1.24" version = "0.1.28"
description = "GovOPlaN mail module with backend and WebUI integration." description = "GovOPlaN mail module with backend and WebUI integration."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
license = { file = "LICENSE" } license = { file = "LICENSE" }
authors = [{ name = "GovOPlaN" }] authors = [{ name = "GovOPlaN" }]
dependencies = [ dependencies = [
"govoplan-core>=0.1.18", "govoplan-core>=0.1.45",
"pydantic>=2,<3", "pydantic>=2,<3",
"redis>=5,<6", "redis>=5,<6",
"SQLAlchemy>=2,<3", "SQLAlchemy>=2,<3",
+107 -3
View File
@@ -5,12 +5,14 @@ from contextvars import ContextVar
from dataclasses import dataclass from dataclasses import dataclass
from email.message import EmailMessage from email.message import EmailMessage
from email.utils import formatdate, make_msgid from email.utils import formatdate, make_msgid
from threading import get_ident
from typing import Any, Iterator from typing import Any, Iterator
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from govoplan_core.core.mail import NotificationMailDeliveryRequest from govoplan_core.core.mail import NotificationMailDeliveryRequest
from govoplan_core.core.modules import ModuleContext from govoplan_core.core.modules import ModuleContext
from govoplan_mail.backend.config import ImapConfig
from govoplan_mail.backend.mail_profiles import ( from govoplan_mail.backend.mail_profiles import (
MailProfileError, MailProfileError,
_assert_campaign_inherits_profile_credentials, _assert_campaign_inherits_profile_credentials,
@@ -38,6 +40,7 @@ from govoplan_mail.backend.recovery import (
) )
from govoplan_mail.backend.sending.imap import ( from govoplan_mail.backend.sending.imap import (
ImapAppendError, ImapAppendError,
ImapBatchSession,
ImapConfigurationError, ImapConfigurationError,
append_message_to_sent, append_message_to_sent,
) )
@@ -72,6 +75,78 @@ class CampaignSmtpDeliveryResult:
@dataclass(frozen=True, slots=True) @dataclass(frozen=True, slots=True)
class CampaignImapAppendResult: class CampaignImapAppendResult:
folder: str folder: str
connection_sequence: int = 1
session_reused: bool = False
reconnect_count: int = 0
class CampaignImapBatchState:
"""Lazy transport reuse; authorization and recovery remain per message."""
def __init__(self, *, tenant_id: str, campaign_id: str):
self.tenant_id = tenant_id
self.campaign_id = campaign_id
self._session: ImapBatchSession | None = None
self._binding: tuple[Any, ...] | None = None
self._previous_connections = 0
self._previous_reconnects = 0
self._closed = False
self._owner_thread = get_ident()
@property
def connection_count(self) -> int:
return self._previous_connections + (self._session.connection_count if self._session else 0)
@property
def reconnect_count(self) -> int:
return self._previous_reconnects + (self._session.reconnect_count if self._session else 0)
def assert_scope(self, *, tenant_id: str, campaign_id: str) -> None:
if (
self._closed or get_ident() != self._owner_thread
or tenant_id != self.tenant_id or campaign_id != self.campaign_id
):
raise ImapConfigurationError("The IMAP batch does not match this campaign scope")
def session_for(self, config: ImapConfig, *, binding: tuple[Any, ...]) -> ImapBatchSession:
if self._closed:
raise ImapConfigurationError("The IMAP batch is closed")
if self._session is not None and (
self._binding != binding or not self._session.matches_config(config)
):
self._release_session()
if self._session is None:
self._session = ImapBatchSession(config)
self._binding = binding
return self._session
def _release_session(self) -> None:
if self._session is not None:
self._previous_connections += self._session.connection_count
self._previous_reconnects += self._session.reconnect_count
self._session.close()
self._session = None
def close(self) -> None:
self._closed = True
self._release_session()
_ACTIVE_IMAP_BATCH: ContextVar[CampaignImapBatchState | None] = ContextVar(
"govoplan_mail_active_imap_batch", default=None,
)
@contextmanager
def campaign_imap_batch(*, tenant_id: str, campaign_id: str) -> Iterator[CampaignImapBatchState]:
"""Open no connection until an individual append passes its current checks."""
state = CampaignImapBatchState(tenant_id=tenant_id, campaign_id=campaign_id)
token = _ACTIVE_IMAP_BATCH.set(state)
try:
yield state
finally:
_ACTIVE_IMAP_BATCH.reset(token)
state.close()
@dataclass(frozen=True, slots=True) @dataclass(frozen=True, slots=True)
@@ -155,6 +230,7 @@ def _authorized_campaign_profile(
campaign_id: str, campaign_id: str,
profile_id: str, profile_id: str,
selection: dict[str, str | None] | None = None, selection: dict[str, str | None] | None = None,
credential_protocol: str | None = None,
): ):
profile = ensure_mail_profile_allowed_for_campaign( profile = ensure_mail_profile_allowed_for_campaign(
session, session,
@@ -164,7 +240,7 @@ def _authorized_campaign_profile(
require_active=True, require_active=True,
) )
policy = effective_mail_profile_policy(session, tenant_id=tenant_id, campaign_id=campaign_id) policy = effective_mail_profile_policy(session, tenant_id=tenant_id, campaign_id=campaign_id)
_assert_campaign_inherits_profile_credentials(profile, policy, selection) _assert_campaign_inherits_profile_credentials(profile, policy, selection, protocol=credential_protocol)
return profile return profile
@@ -343,6 +419,7 @@ def campaign_smtp_batch(
campaign_id=campaign_id, campaign_id=campaign_id,
profile_id=profile_id, profile_id=profile_id,
selection=selection, selection=selection,
credential_protocol="smtp",
) )
except MailProfileError: except MailProfileError:
raise raise
@@ -444,6 +521,7 @@ def send_campaign_email_bytes(
campaign_id=campaign_id, campaign_id=campaign_id,
profile_id=profile_id, profile_id=profile_id,
selection=selection, selection=selection,
credential_protocol="smtp",
) )
except MailProfileError: except MailProfileError:
raise raise
@@ -593,6 +671,9 @@ def append_campaign_message_to_sent(
recovery_resource_type: str | None = None, recovery_resource_type: str | None = None,
recovery_resource_id: str | None = None, recovery_resource_id: str | None = None,
) -> CampaignImapAppendResult: ) -> CampaignImapAppendResult:
batch = _ACTIVE_IMAP_BATCH.get()
if batch is not None:
batch.assert_scope(tenant_id=tenant_id, campaign_id=campaign_id)
selection = _selection_payload( selection = _selection_payload(
profile_id=profile_id, profile_id=profile_id,
smtp_server_id=smtp_server_id, smtp_server_id=smtp_server_id,
@@ -607,6 +688,7 @@ def append_campaign_message_to_sent(
campaign_id=campaign_id, campaign_id=campaign_id,
profile_id=profile_id, profile_id=profile_id,
selection=selection, selection=selection,
credential_protocol="imap",
) )
except MailProfileError: except MailProfileError:
raise raise
@@ -681,6 +763,15 @@ def append_campaign_message_to_sent(
) )
except MailProfileError: except MailProfileError:
raise MailProfileError("Appending to Sent is blocked by the effective Mail policy.") from None raise MailProfileError("Appending to Sent is blocked by the effective Mail policy.") from None
batch_session = None
if batch is not None:
batch_session = batch.session_for(
imap,
binding=(
tenant_id, campaign_id, profile_id, smtp_server_id, smtp_credential_id,
imap_server_id, imap_credential_id, smtp_revision, imap_revision, folder,
),
)
try: try:
recovery = begin_provider_effect_recovery( recovery = begin_provider_effect_recovery(
kind="imap-append", kind="imap-append",
@@ -701,7 +792,12 @@ def append_campaign_message_to_sent(
outcome_unknown=True, outcome_unknown=True,
) )
try: try:
result = append_message_to_sent(message_bytes, imap_config=imap, folder=folder) if batch_session is None:
result = append_message_to_sent(message_bytes, imap_config=imap, folder=folder)
else:
result = append_message_to_sent(
message_bytes, imap_config=imap, folder=folder, batch_session=batch_session,
)
except ImapAppendError as exc: except ImapAppendError as exc:
sanitized = _sanitized_imap_error(exc) sanitized = _sanitized_imap_error(exc)
if recovery is not None: if recovery is not None:
@@ -728,11 +824,18 @@ def append_campaign_message_to_sent(
try: try:
recovery.succeed_imap(folder=result.folder) recovery.succeed_imap(folder=result.folder)
except Exception: except Exception:
if batch is not None:
batch.close()
raise ImapAppendError( raise ImapAppendError(
"IMAP APPEND returned success, but durable recovery evidence could not be finalized.", "IMAP APPEND returned success, but durable recovery evidence could not be finalized.",
outcome_unknown=True, outcome_unknown=True,
) from None ) from None
return CampaignImapAppendResult(folder=result.folder) return CampaignImapAppendResult(
folder=result.folder,
connection_sequence=batch.connection_count if batch else getattr(result, "connection_sequence", 1),
session_reused=getattr(result, "session_reused", False),
reconnect_count=batch.reconnect_count if batch else getattr(result, "reconnect_count", 0),
)
class MailCampaignCapability: class MailCampaignCapability:
@@ -745,6 +848,7 @@ class MailCampaignCapability:
mail_profile_id_from_campaign_json = staticmethod(mail_profile_id_from_campaign_json) mail_profile_id_from_campaign_json = staticmethod(mail_profile_id_from_campaign_json)
campaign_profile_delivery_summary = staticmethod(campaign_profile_delivery_summary) campaign_profile_delivery_summary = staticmethod(campaign_profile_delivery_summary)
campaign_smtp_batch = staticmethod(campaign_smtp_batch) campaign_smtp_batch = staticmethod(campaign_smtp_batch)
campaign_imap_batch = staticmethod(campaign_imap_batch)
send_campaign_email_bytes = staticmethod(send_campaign_email_bytes) send_campaign_email_bytes = staticmethod(send_campaign_email_bytes)
append_campaign_message_to_sent = staticmethod(append_campaign_message_to_sent) append_campaign_message_to_sent = staticmethod(append_campaign_message_to_sent)
wait_for_rate_limit = staticmethod(wait_for_rate_limit) wait_for_rate_limit = staticmethod(wait_for_rate_limit)
@@ -5,7 +5,7 @@ from dataclasses import dataclass, replace
import re import re
from typing import Any from typing import Any
from sqlalchemy import or_, select from sqlalchemy import func, or_, select
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from govoplan_core.core.configuration_packages import ( from govoplan_core.core.configuration_packages import (
@@ -24,6 +24,8 @@ from govoplan_core.core.configuration_packages import (
from govoplan_core.core.infrastructure_capabilities import ( from govoplan_core.core.infrastructure_capabilities import (
InfrastructureCapability, InfrastructureCapability,
InfrastructureCapabilityReceipt, InfrastructureCapabilityReceipt,
InfrastructureDependency,
InfrastructureDependencyProvider,
) )
from govoplan_core.security.credential_envelopes import ( from govoplan_core.security.credential_envelopes import (
CredentialAccessContext, CredentialAccessContext,
@@ -51,6 +53,9 @@ from govoplan_mail.backend.server_hierarchy import (
MAIL_CONFIGURATION_CAPABILITY = "mail.configuration" MAIL_CONFIGURATION_CAPABILITY = "mail.configuration"
MAIL_INFRASTRUCTURE_DEPENDENCY_CAPABILITY = (
"infrastructure.dependency_inventory.mail"
)
SMTP_PROFILE_FRAGMENT = "smtp_profile" SMTP_PROFILE_FRAGMENT = "smtp_profile"
_SYSTEM_CONFIGURATION_SCOPES = frozenset( _SYSTEM_CONFIGURATION_SCOPES = frozenset(
{"system:settings:write", "system:governance:write"} {"system:settings:write", "system:governance:write"}
@@ -132,8 +137,12 @@ class _ProfileTarget:
on_conflict: str on_conflict: str
class SqlMailConfigurationProvider(ConfigurationProvider): class SqlMailConfigurationProvider(
ConfigurationProvider,
InfrastructureDependencyProvider,
):
module_id = "mail" module_id = "mail"
capability_ids = ("mail.smtp",)
def describe(self) -> ConfigurationProviderDescription: def describe(self) -> ConfigurationProviderDescription:
return ConfigurationProviderDescription( return ConfigurationProviderDescription(
@@ -204,6 +213,84 @@ class SqlMailConfigurationProvider(ConfigurationProvider):
item for item in import_result.diagnostics if item.severity == "blocker" item for item in import_result.diagnostics if item.severity == "blocker"
) )
def infrastructure_dependencies(self) -> tuple[InfrastructureDependency, ...]:
with get_database().session() as session:
return _smtp_infrastructure_dependencies(session)
def _smtp_infrastructure_dependencies(
session: Session,
) -> tuple[InfrastructureDependency, ...]:
endpoints = tuple(
session.execute(
select(MailServerEndpoint)
.where(MailServerEndpoint.protocol == "smtp")
.order_by(MailServerEndpoint.id)
).scalars()
)
binding_counts = {
str(server_id): int(count)
for server_id, count in session.execute(
select(
MailServerCredentialBinding.server_id,
func.count(MailServerCredentialBinding.id),
).group_by(MailServerCredentialBinding.server_id)
)
}
dependencies: list[InfrastructureDependency] = []
endpoint_profile_ids: set[str] = set()
for endpoint in endpoints:
endpoint_profile_ids.add(endpoint.profile_id)
dependencies.append(
InfrastructureDependency(
capability_id="mail.smtp",
module_id="mail",
dependency_type="smtp_endpoint",
dependency_ref=mail_server_ref(endpoint.id) or f"mail:{endpoint.id}",
state="active" if endpoint.is_active else "inactive",
scope=str(endpoint.scope_type or "tenant"),
summary=(
"A persisted Mail SMTP endpoint is bound to the deployment relay."
),
metrics={
"credential_binding_count": binding_counts.get(endpoint.id, 0),
"default_endpoint": int(bool(endpoint.is_default)),
},
required_action=(
"Rebind, migrate, or explicitly retire this SMTP endpoint and its credential-envelope references before changing the relay capability."
),
)
)
legacy_profiles = tuple(
session.execute(
select(MailServerProfile)
.where(MailServerProfile.smtp_config.is_not(None))
.order_by(MailServerProfile.id)
).scalars()
)
for profile in legacy_profiles:
if profile.id in endpoint_profile_ids or not dict(profile.smtp_config or {}):
continue
dependencies.append(
InfrastructureDependency(
capability_id="mail.smtp",
module_id="mail",
dependency_type="legacy_smtp_profile",
dependency_ref=f"mail-profile:{profile.id}",
state="active" if profile.is_active else "inactive",
scope=str(profile.scope_type or "tenant"),
summary=(
"A persisted legacy Mail profile still contains SMTP transport configuration."
),
metrics={"credential_binding_count": 0},
required_action=(
"Migrate or explicitly retire this legacy profile before changing the relay capability."
),
)
)
return tuple(dependencies)
def _preflight_smtp_profile( def _preflight_smtp_profile(
session: Session, session: Session,
+3 -1
View File
@@ -398,8 +398,9 @@ class MailPop3Import(Base, TimestampMixin):
"tenant_id", "tenant_id",
"profile_id", "profile_id",
"pop3_server_id", "pop3_server_id",
"maildrop_identity",
"provider_uidl", "provider_uidl",
name="uq_mail_pop3_imports_source_uidl", name="uq_mail_pop3_imports_maildrop_uidl",
), ),
Index( Index(
"ix_mail_pop3_imports_review", "ix_mail_pop3_imports_review",
@@ -422,6 +423,7 @@ class MailPop3Import(Base, TimestampMixin):
index=True, index=True,
) )
pop3_credential_id: Mapped[str | None] = mapped_column(String(36), nullable=True) pop3_credential_id: Mapped[str | None] = mapped_column(String(36), nullable=True)
maildrop_identity: Mapped[str | None] = mapped_column(String(64), nullable=True)
transport_revision: Mapped[str] = mapped_column(String(120), nullable=False) transport_revision: Mapped[str] = mapped_column(String(120), nullable=False)
provider_uidl: Mapped[str] = mapped_column(String(500), nullable=False) provider_uidl: Mapped[str] = mapped_column(String(500), nullable=False)
provider_message_number: Mapped[int | None] = mapped_column(Integer, nullable=True) provider_message_number: Mapped[int | None] = mapped_column(Integer, nullable=True)
+5 -3
View File
@@ -517,9 +517,11 @@ def _credential_line(policy: dict[str, Any]) -> str:
smtp_inherit = bool((policy.get("smtp_credentials") or {}).get("inherit", True)) smtp_inherit = bool((policy.get("smtp_credentials") or {}).get("inherit", True))
imap_inherit = bool((policy.get("imap_credentials") or {}).get("inherit", True)) imap_inherit = bool((policy.get("imap_credentials") or {}).get("inherit", True))
return ( return (
f"Credential inheritance: SMTP {'inherits' if smtp_inherit else 'requires local credentials'}; " f"Credential selection: SMTP {'allows a profile default or explicit Mail credential' if smtp_inherit else 'requires an explicit Mail credential'}; "
f"IMAP {'inherits' if imap_inherit else 'requires local credentials'}. " f"IMAP {'allows a profile default or explicit Mail credential' if imap_inherit else 'requires an explicit Mail credential'}. "
"Campaign delivery is available only for protocols that inherit credentials from the selected Mail profile." "Select the authorized server and credential in Campaign Mail settings when explicit selection is required. "
"Secrets remain in Mail. Policy administrators configure each protocol under Credential selection; "
"ancestor lower-level locks cannot be overridden."
) )
@@ -197,6 +197,9 @@ GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'mail.bounce-proces
'seine mailbox lesen.'], 'seine mailbox lesen.'],
'steps': ['Öffnen Sie Mail und wählen Sie ein autorisiertes IMAP- ' 'steps': ['Öffnen Sie Mail und wählen Sie ein autorisiertes IMAP- '
'oder JMAP-fähiges Profil.', 'oder JMAP-fähiges Profil.',
'Neuladen rechts aktualisiert den gesamten aktuellen Kontext; '
'Postfachwerkzeuge enthält gezielte Aktualisierungen und '
'berechtigungsabhängige Rückläuferdiagnosen.',
'Wählen Sie einen Ordner aus, überprüfen Sie das ' 'Wählen Sie einen Ordner aus, überprüfen Sie das '
'Live/Cache-Synchronisationslabel und stellen Sie den ' 'Live/Cache-Synchronisationslabel und stellen Sie den '
'begrenzten Nachrichtenindex auf die Seite; JMAP-Suchen ' 'begrenzten Nachrichtenindex auf die Seite; JMAP-Suchen '
+12 -5
View File
@@ -1430,19 +1430,26 @@ def _assert_campaign_inherits_profile_credentials(
profile: MailServerProfile, profile: MailServerProfile,
policy: EffectiveMailProfilePolicy, policy: EffectiveMailProfilePolicy,
selection: Mapping[str, str | None] | None = None, selection: Mapping[str, str | None] | None = None,
*,
protocol: str | None = None,
) -> None: ) -> None:
for protocol in ("smtp", "imap"): # Authoring and complete transport summaries validate both protocols.
if not _profile_has_transport(profile, protocol): # An effect capability can require only the protocol it actually receives
# and uses; an SMTP call does not carry the campaign's IMAP selection.
if protocol is not None and protocol not in {"smtp", "imap"}:
raise MailProfileError("Credential policy protocol must be smtp or imap")
for selected_protocol in ((protocol,) if protocol is not None else ("smtp", "imap")):
if protocol is None and not _profile_has_transport(profile, selected_protocol):
continue continue
explicit_credential = ( explicit_credential = (
selection or {} selection or {}
).get(f"{protocol}_credential_id") ).get(f"{selected_protocol}_credential_id")
if ( if (
not _credential_policy_for_protocol(policy, protocol).inherit not _credential_policy_for_protocol(policy, selected_protocol).inherit
and not explicit_credential and not explicit_credential
): ):
raise MailProfileError( raise MailProfileError(
f"Campaign delivery cannot use the selected profile because the effective {protocol.upper()} " f"Campaign delivery cannot use the selected profile because the effective {selected_protocol.upper()} "
"credential policy requires an explicit credential selection for this campaign." "credential policy requires an explicit credential selection for this campaign."
) )
+141 -18
View File
@@ -32,7 +32,9 @@ from govoplan_core.core.modules import (
ModuleManifest, ModuleManifest,
NavItem, NavItem,
PermissionDefinition, PermissionDefinition,
ProductAvailabilityExplanation,
ProductAreaContribution, ProductAreaContribution,
ProductSurfaceContribution,
QuickAccessTool, QuickAccessTool,
RoleTemplate, RoleTemplate,
) )
@@ -46,7 +48,10 @@ from govoplan_core.core.provider_governance import (
from govoplan_core.core.search import SearchSourceProviderRegistration from govoplan_core.core.search import SearchSourceProviderRegistration
from govoplan_core.core.views import ViewSurface from govoplan_core.core.views import ViewSurface
from govoplan_core.db.base import Base from govoplan_core.db.base import Base
from govoplan_mail.backend.configuration_provider import MAIL_CONFIGURATION_CAPABILITY from govoplan_mail.backend.configuration_provider import (
MAIL_CONFIGURATION_CAPABILITY,
MAIL_INFRASTRUCTURE_DEPENDENCY_CAPABILITY,
)
from govoplan_mail.backend.documentation import ( from govoplan_mail.backend.documentation import (
documentation_configuration_states, documentation_configuration_states,
documentation_topics, documentation_topics,
@@ -445,7 +450,7 @@ POP3_PROVIDER = ExternalProviderDeclaration(
manifest = ModuleManifest( manifest = ModuleManifest(
id="mail", id="mail",
name="Mail", name="Mail",
version="0.1.24", version="0.1.28",
required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR), required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR),
optional_dependencies=("campaigns", "addresses", "calendar", "postbox", "search"), optional_dependencies=("campaigns", "addresses", "calendar", "postbox", "search"),
provides_interfaces=( provides_interfaces=(
@@ -562,6 +567,39 @@ manifest = ModuleManifest(
order=40, order=40,
), ),
), ),
product_surfaces=(
ProductSurfaceContribution(
id="communication.messages",
module_id="mail",
label="i18n:govoplan-core.product_surface.messages",
description="i18n:govoplan-core.product_surface.messages_description",
icon="mail",
entry_path="/messages",
route_path="/mail",
surface_ids=("mail.nav.mail", "mail.route.mail"),
presentations=("task", "reader"),
search_source_ids=("mail.mailbox_messages",),
help_context_ids=("mail.quick_access.messages",),
documentation_topic_ids=("mail.quick-access-and-product-area",),
required_any=("mail:mailbox:read",),
aliases=("/inbox",),
order=10,
unavailable=ProductAvailabilityExplanation(
reason="authorization",
title="i18n:govoplan-core.product_surface.messages_unavailable",
description="i18n:govoplan-core.product_surface.messages_unavailable_description",
resolution="i18n:govoplan-core.product_surface.messages_unavailable_resolution",
responsible_role="i18n:govoplan-core.access_administrator",
),
degraded=ProductAvailabilityExplanation(
reason="provider_degraded",
title="i18n:govoplan-core.product_surface.messages_degraded",
description="i18n:govoplan-core.product_surface.messages_degraded_description",
resolution="i18n:govoplan-core.product_surface.messages_degraded_resolution",
responsible_role="i18n:govoplan-core.integration_operator",
),
),
),
quick_access_tools=( quick_access_tools=(
QuickAccessTool( QuickAccessTool(
id="mail.messages", id="mail.messages",
@@ -607,6 +645,7 @@ manifest = ModuleManifest(
), ),
capability_factories={ capability_factories={
MAIL_CONFIGURATION_CAPABILITY: _configuration_provider, MAIL_CONFIGURATION_CAPABILITY: _configuration_provider,
MAIL_INFRASTRUCTURE_DEPENDENCY_CAPABILITY: _configuration_provider,
"mail.campaign_delivery": lambda context: __import__("govoplan_mail.backend.capabilities", fromlist=["campaign_capability"]).campaign_capability(context), "mail.campaign_delivery": lambda context: __import__("govoplan_mail.backend.capabilities", fromlist=["campaign_capability"]).campaign_capability(context),
CAPABILITY_MAIL_DELIVERY_OUTBOX: lambda context: __import__( CAPABILITY_MAIL_DELIVERY_OUTBOX: lambda context: __import__(
"govoplan_mail.backend.capabilities", "govoplan_mail.backend.capabilities",
@@ -636,6 +675,21 @@ manifest = ModuleManifest(
), ),
}, },
documentation=( documentation=(
DocumentationTopic(
id="mail.admin.pop3-maildrop-reconciliation",
title="Reconcile historical POP3 mailbox identities",
summary="Keep mailbox identity stable across secret rotation and reconcile legacy ambiguity without deleting evidence.",
body="Duplicate identity includes the effective canonical host, port and exact case-sensitive mailbox username within the tenant/profile/server. Password rotation or replacement credentials for the same account retain deduplication; another mailbox or endpoint is distinct. Preview revisions are bound to that identity. A reused UIDL with different bytes stops the entire selected batch with a conflict. Historical imports are retained without guessing their former account. A legacy identity conflict is not selectable: an administrator with mail:profile:use, mail:pop3:manage and mail:pop3:import must review the retained import, refresh the current mailbox preview, then POST /api/v1/mail/profiles/{profile_id}/pop3/imports/{import_id}/bind-maildrop with server_id, optional credential_id, expected_transport_revision from that preview, and confirm_binding=true. The operation re-downloads only that UIDL, verifies exact retained bytes and SHA-256, denies an existing competing binding, and audits the binding without changing content, IDs, historical fingerprints or source mail. Refresh the preview afterward. If content differs or the old source is unavailable, leave the record retained and the conflict unresolved; never delete evidence to force an import.",
layer="available", documentation_types=("user", "admin"), audience=("mail_admin", "mail_import_operator"), order=35,
conditions=(DocumentationCondition(required_modules=("mail",), any_scopes=("mail:pop3:import", "mail:pop3:manage")),),
links=(DocumentationLink(label="Legacy POP3 import", href="/mail/legacy-import", kind="runtime"), DocumentationLink(label="Bind a verified legacy maildrop", href="/api/v1/mail/profiles/{profile_id}/pop3/imports/{import_id}/bind-maildrop", kind="api")),
metadata={"kind": "reference", "related_topic_ids": ["mail.workflow.legacy-pop3-import"]},
translations={"de": {
"title": "Historische POP3-Postfachidentitäten abstimmen",
"summary": "Die Identität bei Passwortrotation erhalten und Altdatenkonflikte ohne Löschen von Nachweisen klären.",
"body": "Die Duplikaterkennung berücksichtigt innerhalb von Mandant, Profil und Server den kanonischen Host, Port und den exakten, groß-/kleinschreibungsabhängigen Postfachnamen. Passwortrotation oder neue Zugangsdaten desselben Kontos behalten die Zuordnung; andere Postfächer oder Endpunkte sind getrennt. Die Vorschaurevision ist daran gebunden. Dieselbe UIDL mit anderem Inhalt stoppt den gesamten ausgewählten Stapel als Konflikt. Historische Importe bleiben ohne erratene Kontozuordnung erhalten. Bei einem nicht auswählbaren Altdatenkonflikt prüft eine Administration mit mail:profile:use, mail:pop3:manage und mail:pop3:import den gespeicherten Import und aktualisiert die Postfachvorschau. Anschließend ruft sie POST /api/v1/mail/profiles/{profile_id}/pop3/imports/{import_id}/bind-maildrop mit server_id, optional credential_id, expected_transport_revision aus dieser Vorschau und confirm_binding=true auf. Nur diese UIDL wird erneut gelesen; exakte gespeicherte Bytes und SHA-256 müssen übereinstimmen, eine konkurrierende Zuordnung wird abgelehnt. Das Audit dokumentiert die Bindung; Inhalt, Kennungen, historische Fingerprints und Quellpostfach bleiben unverändert. Danach die Vorschau aktualisieren. Bei abweichendem Inhalt oder nicht verfügbarer Altquelle bleiben Nachweis und Konflikt erhalten; niemals Nachweise löschen, um einen Import zu erzwingen.",
}},
),
DocumentationTopic( DocumentationTopic(
id="mail.workflow.legacy-pop3-import", id="mail.workflow.legacy-pop3-import",
title="Import messages from a legacy POP3 mailbox", title="Import messages from a legacy POP3 mailbox",
@@ -684,6 +738,7 @@ manifest = ModuleManifest(
"kind": "workflow", "kind": "workflow",
"route": "/mail/legacy-import", "route": "/mail/legacy-import",
"screen": "Legacy POP3 import", "screen": "Legacy POP3 import",
"related_topic_ids": ["mail.admin.pop3-maildrop-reconciliation"],
"help_contexts": [ "help_contexts": [
"mail.pop3", "mail.pop3",
"mail.pop3.source-editor", "mail.pop3.source-editor",
@@ -843,7 +898,9 @@ manifest = ModuleManifest(
"The Mail configuration provider reads the validated mail.smtp deployment capability and derives authoritative endpoint metadata. " "The Mail configuration provider reads the validated mail.smtp deployment capability and derives authoritative endpoint metadata. "
"Missing non-secret transport fields are collected by preflight; authentication is represented only by an existing credential-envelope id. " "Missing non-secret transport fields are collected by preflight; authentication is represented only by an existing credential-envelope id. "
"Tenant scope is the default, system scope requires system authority, conflicting profiles are preserved unless update is explicitly reviewed, " "Tenant scope is the default, system scope requires system authority, conflicting profiles are preserved unless update is explicitly reviewed, "
"and an unchanged second apply is a no-op. SMTP reachability remains a separate Mail profile test." "and an unchanged second apply is a no-op. Before the host deployer changes or removes mail.smtp, Mail inventories every persisted SMTP endpoint, "
"legacy SMTP profile, and credential-binding count through the non-secret Ops dependency report. Missing, stale, or incomplete inventory blocks apply; "
"SMTP reachability remains a separate Mail profile test."
), ),
layer="configured", layer="configured",
documentation_types=("admin",), documentation_types=("admin",),
@@ -875,7 +932,9 @@ manifest = ModuleManifest(
"Der Mail-Konfigurationsprovider liest die validierte Bereitstellungsfähigkeit mail.smtp und übernimmt deren maßgebliche Endpunktdaten. " "Der Mail-Konfigurationsprovider liest die validierte Bereitstellungsfähigkeit mail.smtp und übernimmt deren maßgebliche Endpunktdaten. "
"Fehlende nicht geheime Transportangaben werden im Preflight abgefragt; Authentifizierung wird ausschließlich durch die ID eines vorhandenen Zugangsdaten-Umschlags referenziert. " "Fehlende nicht geheime Transportangaben werden im Preflight abgefragt; Authentifizierung wird ausschließlich durch die ID eines vorhandenen Zugangsdaten-Umschlags referenziert. "
"Mandantenbezug ist der Standard, Systembezug erfordert Systemberechtigung, abweichende vorhandene Profile bleiben ohne ausdrücklich geprüfte Aktualisierung unverändert, " "Mandantenbezug ist der Standard, Systembezug erfordert Systemberechtigung, abweichende vorhandene Profile bleiben ohne ausdrücklich geprüfte Aktualisierung unverändert, "
"und eine unveränderte zweite Anwendung bleibt wirkungslos. Die SMTP-Erreichbarkeit wird weiterhin separat im Mail-Profil getestet." "und eine unveränderte zweite Anwendung bleibt wirkungslos. Bevor der Host-Deployer mail.smtp ändert oder entfernt, inventarisiert Mail alle gespeicherten SMTP-Endpunkte, "
"älteren SMTP-Profile und die Anzahl ihrer Zugangsdatenbindungen im nicht geheimen Ops-Abhängigkeitsbericht. Ein fehlendes, veraltetes oder unvollständiges Inventar blockiert die Anwendung; "
"die SMTP-Erreichbarkeit wird weiterhin separat im Mail-Profil getestet."
), ),
} }
}, },
@@ -893,6 +952,9 @@ manifest = ModuleManifest(
body=( body=(
"Mail contributes its full mailbox to Communication. When Quick Access is enabled, its compact provider surface " "Mail contributes its full mailbox to Communication. When Quick Access is enabled, its compact provider surface "
"appears inside the shared Messages drawer alongside independent Postbox and future chat contributions. " "appears inside the shared Messages drawer alongside independent Postbox and future chat contributions. "
"Mail also contributes to the stable Messages product entry: `/messages` and its migration alias `/inbox` open "
"Mail only when its mailbox route is currently authorized and visible in the effective View; otherwise another "
"available Messages owner is selected or the shell explains how access can be restored. "
"Recent entries open the exact authorized profile, folder, and message; Drafts resolves the configured or " "Recent entries open the exact authorized profile, folder, and message; Drafts resolves the configured or "
"provider-detected Drafts folder, and the full Mail page keeps the versioned Quick Access return context. " "provider-detected Drafts folder, and the full Mail page keeps the versioned Quick Access return context. "
"When an active Case requests a selection, choosing a recent message returns only its tenant-bound profile, " "When an active Case requests a selection, choosing a recent message returns only its tenant-bound profile, "
@@ -914,6 +976,9 @@ manifest = ModuleManifest(
"body": ( "body": (
"Mail ordnet das vollständige Postfach Kommunikation zu. Ist der Schnellzugriff aktiviert, erscheint die kompakte " "Mail ordnet das vollständige Postfach Kommunikation zu. Ist der Schnellzugriff aktiviert, erscheint die kompakte "
"Mail-Oberfläche gemeinsam mit unabhängigen Beiträgen aus Postbox und künftig Chat unter Nachrichten. " "Mail-Oberfläche gemeinsam mit unabhängigen Beiträgen aus Postbox und künftig Chat unter Nachrichten. "
"Mail trägt außerdem zum stabilen Produkteinstieg Nachrichten bei: `/messages` und der Migrationsalias `/inbox` "
"öffnen Mail nur, wenn die Postfachroute aktuell berechtigt und in der wirksamen View sichtbar ist. Andernfalls "
"wählt die Shell einen anderen verfügbaren Nachrichten-Eigentümer oder erklärt die Wiederherstellung des Zugriffs. "
"Aktuelle Einträge öffnen das genaue berechtigte Profil, den Ordner und die Nachricht; Entwürfe verwendet " "Aktuelle Einträge öffnen das genaue berechtigte Profil, den Ordner und die Nachricht; Entwürfe verwendet "
"den konfigurierten oder vom Anbieter erkannten Entwurfsordner. Die vollständige Mail-Seite erhält den " "den konfigurierten oder vom Anbieter erkannten Entwurfsordner. Die vollständige Mail-Seite erhält den "
"versionierten Rücksprungkontext. Verfassen öffnet bewusst die konfigurierte Mail-Anwendung des Benutzers, " "versionierten Rücksprungkontext. Verfassen öffnet bewusst die konfigurierte Mail-Anwendung des Benutzers, "
@@ -1010,7 +1075,9 @@ manifest = ModuleManifest(
id="mail.profiles-and-policy", id="mail.profiles-and-policy",
title="Mail profiles and policy hierarchy", title="Mail profiles and policy hierarchy",
summary="Mail sending and mailbox access use reusable SMTP/IMAP/JMAP profiles governed by an effective system, tenant, owner, and campaign policy.", summary="Mail sending and mailbox access use reusable SMTP/IMAP/JMAP profiles governed by an effective system, tenant, owner, and campaign policy.",
body="The active policy decides whether users can only choose approved profiles or whether user, group, and campaign scopes may define additional reusable profiles. SMTP, IMAP, and JMAP host allow/deny rules are inherited independently. JMAP Session discovery fails closed when its advertised API origin differs unless an administrator explicitly allows that origin. Runtime documentation adds the current tenant posture when the actor may read mail profile policy.", body="Documentation books sit beside the Mailbox, legacy-import, bounce-processing, profile, and "
"policy headings; field help stays with its label. "
"The active policy decides whether users can only choose approved profiles or whether user, group, and campaign scopes may define additional reusable profiles. SMTP, IMAP, and JMAP host allow/deny rules are inherited independently. JMAP Session discovery fails closed when its advertised API origin differs unless an administrator explicitly allows that origin. Runtime documentation adds the current tenant posture when the actor may read mail profile policy. In the Mail profile policy editor, Credential selection separately controls SMTP and IMAP: allow a profile default or require an explicit authorized Mail-owned server and credential reference in Campaign Mail settings. Both choices keep secrets in Mail. Inherit policy leaves the local choice unset and follows the parent; it is not the same as allowing default credentials. System values are concrete, while lower scopes show local, effective, and source-path values. Allow override sets the matching allow_lower_level_limits protocol key; an ancestor lock cannot be changed or re-enabled below that scope. Campaign policy has no lower-level override controls. Scope-write permission and an unlocked workflow remain required. A failed write preserves the draft for explicit retry; a successful write followed by a dependent refresh failure remains saved and asks only to reload the display.",
layer="configured", layer="configured",
documentation_types=("admin",), documentation_types=("admin",),
audience=("tenant_admin", "mail_admin", "campaign_admin"), audience=("tenant_admin", "mail_admin", "campaign_admin"),
@@ -1037,11 +1104,23 @@ manifest = ModuleManifest(
"title": "Mail-Profile und Richtlinienhierarchie", "title": "Mail-Profile und Richtlinienhierarchie",
"summary": "Mail-Versand und Postfachzugriff über wiederverwendbare SMTP-/IMAP-/JMAP-Profile und eine wirksame Richtlinie aus System-, Mandanten-, Eigentümer- und gegebenenfalls Campaign-Ebene steuern.", "summary": "Mail-Versand und Postfachzugriff über wiederverwendbare SMTP-/IMAP-/JMAP-Profile und eine wirksame Richtlinie aus System-, Mandanten-, Eigentümer- und gegebenenfalls Campaign-Ebene steuern.",
"body": ( "body": (
"Dokumentationsbücher stehen neben den Überschriften für Postfach, Altimport, "
"Rückläuferverarbeitung, Profile und Richtlinien; Feldhilfe bleibt bei der Feldbezeichnung. "
"Die wirksame Richtlinie entscheidet, ob Personen ausschließlich freigegebene Profile auswählen dürfen " "Die wirksame Richtlinie entscheidet, ob Personen ausschließlich freigegebene Profile auswählen dürfen "
"oder ob auf Personen-, Gruppen- und Campaign-Ebene zusätzliche wiederverwendbare Profile angelegt werden können. " "oder ob auf Personen-, Gruppen- und Campaign-Ebene zusätzliche wiederverwendbare Profile angelegt werden können. "
"Host-Freigaben und -Sperren für SMTP, IMAP und JMAP werden unabhängig vererbt. Ein von der JMAP-Session " "Host-Freigaben und -Sperren für SMTP, IMAP und JMAP werden unabhängig vererbt. Ein von der JMAP-Session "
"angekündigter API-Ursprung muss bei abweichendem Ursprung ausdrücklich freigegeben sein. " "angekündigter API-Ursprung muss bei abweichendem Ursprung ausdrücklich freigegeben sein. "
"Die Laufzeitdokumentation ergänzt die aktuelle Lage des Mandanten, wenn die handelnde Person die Mail-Profilrichtlinie lesen darf." "Die Laufzeitdokumentation ergänzt die aktuelle Lage des Mandanten, wenn die handelnde Person die Mail-Profilrichtlinie lesen darf. "
"Im Mail-Profilrichtlinieneditor steuert Auswahl der Zugangsdaten SMTP und IMAP getrennt: Standard-Zugangsdaten "
"des Profils zulassen oder ausdrückliche berechtigte Mail-Server- und Zugangsdatenverweise in den Mail-Einstellungen "
"der Kampagne verlangen. Geheimnisse bleiben bei beiden Optionen in Mail. Richtlinie erben lässt den lokalen Wert "
"offen und übernimmt die übergeordnete Entscheidung; dies ist nicht dasselbe wie Standard-Zugangsdaten zu erlauben. "
"Systemwerte sind konkret; darunter werden lokale und wirksame Werte samt Richtlinienpfad angezeigt. Überschreiben "
"zulassen setzt den passenden Protokollschlüssel in allow_lower_level_limits. Eine übergeordnete Sperre kann darunter "
"weder geändert noch aufgehoben werden. Kampagnenrichtlinien haben keine Freigabe für weitere untere Bereiche. "
"Schreibberechtigung für den jeweiligen Bereich und ein entsperrter Arbeitsablauf bleiben erforderlich. Ein fehlgeschlagener "
"Schreibvorgang erhält den Entwurf für einen ausdrücklichen Wiederholungsversuch. Scheitert nach erfolgreichem Speichern "
"nur die Aktualisierung abhängiger Daten, bleibt die Richtlinie gespeichert; lediglich die Anzeige muss neu geladen werden."
), ),
} }
}, },
@@ -1062,7 +1141,8 @@ manifest = ModuleManifest(
title="Map standard folders for an IMAP profile", title="Map standard folders for an IMAP profile",
summary="Store Inbox, Sent, Drafts, Trash, Archive, and Junk mappings on the reusable Mail profile and populate them from bounded IMAP discovery.", summary="Store Inbox, Sent, Drafts, Trash, Archive, and Junk mappings on the reusable Mail profile and populate them from bounded IMAP discovery.",
body=( body=(
"Folder names are profile/server metadata, not Campaign settings. An authorized profile administrator may enter names directly or use folder discovery; empty mappings retain automatic behavior. Existing imap.sent_folder values are presented and persisted as the Sent mapping, while the compatibility field remains synchronized for consumers that still read it. A Campaign-specific Sent-folder override remains authoritative for that Campaign and is not rewritten by profile discovery. Folder discovery lists provider-visible names without creating, renaming, moving, or deleting remote folders." "Folder names are profile/server metadata, not Campaign settings. An authorized profile administrator may enter names directly or use folder discovery; empty mappings retain automatic behavior. Existing imap.sent_folder values are presented and persisted as the Sent mapping, while the compatibility field remains synchronized for consumers that still read it. A Campaign-specific Sent-folder override remains authoritative for that Campaign and is not rewritten by profile discovery. Folder discovery lists provider-visible names without creating, renaming, moving, or deleting remote folders. "
"Enter readable Unicode names such as Entwürfe, not modified UTF-7 wire names such as Entw&APw-rfe. Discovery decodes names before detecting folder roles; mailbox reads, status checks, and Sent APPEND encode and quote them for the active connection. Previously saved wire names are resolved against the same account's live folder list, with an exact readable-name match taking precedence over a legacy alias. Rediscover and save to replace old encoded configuration values explicitly; reads do not rewrite profiles. Invalid provider encodings fail explicitly instead of silently addressing a replacement folder."
), ),
layer="configured", layer="configured",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
@@ -1091,7 +1171,13 @@ manifest = ModuleManifest(
"und gespeichert, während das Kompatibilitätsfeld für ältere Verbraucher synchron bleibt. Eine Campaign-spezifische " "und gespeichert, während das Kompatibilitätsfeld für ältere Verbraucher synchron bleibt. Eine Campaign-spezifische "
"Abweichung für den Gesendet-Ordner bleibt für diese Campaign maßgeblich und wird von der Profilerkennung nicht verändert. " "Abweichung für den Gesendet-Ordner bleibt für diese Campaign maßgeblich und wird von der Profilerkennung nicht verändert. "
"Die Erkennung listet nur die beim Anbieter sichtbaren Namen auf und legt keine externen Ordner an, benennt sie nicht um, " "Die Erkennung listet nur die beim Anbieter sichtbaren Namen auf und legt keine externen Ordner an, benennt sie nicht um, "
"verschiebt sie nicht und löscht sie nicht." "verschiebt sie nicht und löscht sie nicht. Lesbare Unicode-Namen wie Entwürfe eingeben, nicht die "
"Modified-UTF-7-Übertragungsform Entw&APw-rfe. Die Erkennung dekodiert Namen vor der Rollenzuordnung; "
"Postfachzugriffe, Statusabfragen und Gesendet-APPEND kodieren und maskieren sie für die aktive Verbindung. "
"Früher gespeicherte Übertragungsformen werden anhand der aktuellen Ordnerliste desselben Kontos aufgelöst; "
"ein exakt passender lesbarer Name hat Vorrang vor einem alten Alias. Erneute Erkennung und ausdrückliches "
"Speichern ersetzen alte kodierte Konfigurationswerte; Lesezugriffe schreiben Profile nicht um. Fehlerhafte "
"Anbieterkodierungen führen zu einer klaren Fehlermeldung statt unbemerkt einen Ersatzordner anzusprechen."
), ),
} }
}, },
@@ -1164,7 +1250,7 @@ manifest = ModuleManifest(
id="mail.profile-ownership-and-consumers", id="mail.profile-ownership-and-consumers",
title="Mail owns transport profiles and credentials", title="Mail owns transport profiles and credentials",
summary="Other modules select authorized Mail profiles by stable identifier; they do not copy SMTP/IMAP settings or secrets.", summary="Other modules select authorized Mail profiles by stable identifier; they do not copy SMTP/IMAP settings or secrets.",
body="Mail encrypts credentials, tests connections, evaluates profile scope and policy, and performs revision-gated transport effects without returning resolved configuration. Random persisted revisions rotate when normalized transport or account identity changes, while password-only rotation remains transparent to built business intent. Campaign stores only server.mail_profile_id plus sanitized delivery evidence. Campaign-local transport fields are rejected, and legacy campaign records fail closed until an explicit profile migration preserves the source audit record and updates an editable version.", body="Mail encrypts credentials, tests connections, evaluates profile scope and policy, and performs revision-gated transport effects without returning resolved configuration. Random persisted revisions rotate when normalized transport or account identity changes, while password-only rotation remains transparent to built business intent. Campaign stores only server.mail_profile_id plus sanitized delivery evidence. Campaign-local transport fields are rejected, and legacy campaign records fail closed until an explicit profile migration preserves the source audit record and updates an editable version. The shared credential editor resolves server names from authorized Mail metadata on opening, without a page refresh or reading secrets. Typing does not reload this catalogue; reopening refreshes it and retries temporary metadata failures. Inactive servers retain their status, and deleted or unauthorized selected references stay visible as unavailable rather than being removed. A displayed label never grants server-use permission.",
layer="available", layer="available",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("mail_user", "mail_admin", "campaign_manager", "campaign_sender"), audience=("mail_user", "mail_admin", "campaign_manager", "campaign_sender"),
@@ -1198,7 +1284,12 @@ manifest = ModuleManifest(
"Passwortrotation bleibt für bereits aufgebauten fachlichen Willen transparent. Campaign speichert nur " "Passwortrotation bleibt für bereits aufgebauten fachlichen Willen transparent. Campaign speichert nur "
"server.mail_profile_id und bereinigte Zustellnachweise. Campaign-lokale Transportfelder werden abgelehnt; " "server.mail_profile_id und bereinigte Zustellnachweise. Campaign-lokale Transportfelder werden abgelehnt; "
"ältere Campaign-Datensätze bleiben gesperrt, bis eine ausdrückliche Profilmigration den ursprünglichen " "ältere Campaign-Datensätze bleiben gesperrt, bis eine ausdrückliche Profilmigration den ursprünglichen "
"Auditdatensatz bewahrt und eine bearbeitbare Version aktualisiert." "Auditdatensatz bewahrt und eine bearbeitbare Version aktualisiert. Der gemeinsame Zugangsdateneditor "
"löst Servernamen beim Öffnen aus berechtigten Mail-Metadaten auf, ohne die Seite neu zu laden oder "
"Geheimnisse auszulesen. Beim Tippen wird dieser Katalog nicht erneut geladen; erneutes Öffnen aktualisiert "
"ihn und wiederholt vorübergehend fehlgeschlagene Metadatenabfragen. Inaktive Server behalten ihre "
"Kennzeichnung. Gelöschte oder nicht berechtigte ausgewählte Verweise bleiben als nicht verfügbar sichtbar "
"und werden nicht entfernt. Eine angezeigte Bezeichnung erteilt niemals die Berechtigung zur Servernutzung."
), ),
} }
}, },
@@ -1274,10 +1365,16 @@ manifest = ModuleManifest(
id="mail.workflow.read-mailbox", id="mail.workflow.read-mailbox",
title="Read a permitted mailbox without changing it", title="Read a permitted mailbox without changing it",
summary="Choose an IMAP- or JMAP-enabled profile, browse folders, search or page messages, and inspect bounded content through the read-only mailbox surface.", summary="Choose an IMAP- or JMAP-enabled profile, browse folders, search or page messages, and inspect bounded content through the read-only mailbox surface.",
body="Mailbox access requires both mailbox-read and profile-use authority for a profile visible in the actor's scope. IMAP retains its existing bounded list behavior. JMAP adds capability discovery, server-side text search, query-state cursors, and bounded Email/changes synchronization; an expired state explicitly requires a full refresh. Lists expose provider read/unread flags and provenance without mutating them. Message HTML is isolated and sanitized, while attachment metadata, unavailable content, and provider failures remain explicit. Listing folders or messages must not mark mail read, move it, delete it, or expose unbounded content.", body=(
"Documentation books sit beside the Mailbox, legacy-import, bounce-processing, profile, and "
"policy headings; field help stays with its label. "
"Mailbox access requires both mailbox-read and profile-use authority for a profile visible in the actor's scope. IMAP retains its existing bounded list behavior. IMAP folder names appear as readable Unicode, including umlauts and literal ampersands, and are encoded for the active connection when opened. Refresh an already-loaded folder list after an upgrade; folder discovery does not rename remote folders. Folder icons expand or collapse the tree; labels select without changing expansion. Selecting a synthetic parent grouping highlights that group and clears message selection without opening an invented provider folder. JMAP adds capability discovery, server-side text search, query-state cursors, and bounded Email/changes synchronization; an expired state explicitly requires a full refresh. Lists expose provider read/unread flags and provenance without mutating them. Message HTML is isolated and sanitized, while attachment metadata, unavailable content, and provider failures remain explicit. Listing folders or messages must not mark mail read, move it, delete it, or expose unbounded content. "
"The persistent workspace header keeps the profile selector, Mailbox tools, Help, and one right-aligned Reload available even without a profile or message selection. Reload first rechecks authorized profiles, then refreshes the current folder catalogue and bounded message page together; a selected message is reread only if still present. IMAP retains the current page; JMAP starts a fresh cursor chain on page one while retaining the search. A selected synthetic grouping refreshes only the folder catalogue, not an invented mailbox. Folder expansion is retained. Failed refreshes preserve usable loaded data with an explicit error and retry action, never present failure as an empty mailbox, and ignore late reads from a previous profile or tenant. Mailbox tools groups the optional profile-only, folder-only, and message-only refreshes separately from Bounce status. The latter remains visible with a permission explanation when bounce-read/manage authority is absent. These controls do not grant profile administration rights, run SMTP delivery, append mail, or change read/unread flags. "
"Mailbox context reads bypass browser response reuse; bounded server-side indexes and their provenance remain governed by Mail. A failed pagination request restores the page and size that belong to the retained rows. Dismissing or changing the preview while Reload is pending takes precedence over its remembered selection. On narrow screens, scroll vertically through folders, messages, and preview inside the mailbox workspace; its action header remains visible."
),
layer="configured", layer="configured",
documentation_types=("user",), documentation_types=("user", "admin"),
audience=("mail_user",), audience=("mail_user", "mail_admin"),
order=42, order=42,
conditions=( conditions=(
DocumentationCondition( DocumentationCondition(
@@ -1295,13 +1392,32 @@ manifest = ModuleManifest(
"title": "Ein berechtigtes Postfach ohne Änderungen lesen", "title": "Ein berechtigtes Postfach ohne Änderungen lesen",
"summary": "Ein IMAP- oder JMAP-fähiges Profil auswählen, Ordner durchsuchen und begrenzte Nachrichteninhalte in der nur lesbaren Postfachoberfläche prüfen.", "summary": "Ein IMAP- oder JMAP-fähiges Profil auswählen, Ordner durchsuchen und begrenzte Nachrichteninhalte in der nur lesbaren Postfachoberfläche prüfen.",
"body": ( "body": (
"Dokumentationsbücher stehen neben den Überschriften für Postfach, Altimport, "
"Rückläuferverarbeitung, Profile und Richtlinien; Feldhilfe bleibt bei der Feldbezeichnung. "
"Der Postfachzugriff erfordert sowohl Leseberechtigung für das Postfach als auch Nutzungsberechtigung für ein " "Der Postfachzugriff erfordert sowohl Leseberechtigung für das Postfach als auch Nutzungsberechtigung für ein "
"im Bereich der handelnden Person sichtbares Profil. IMAP behält sein bisheriges Verhalten; JMAP ergänzt " "im Bereich der handelnden Person sichtbares Profil. IMAP zeigt lesbare Unicode-Ordnernamen mit Umlauten "
"und kaufmännischen Und-Zeichen; beim Öffnen werden sie für die aktive Verbindung kodiert. Eine bereits "
"geladene Ordnerliste nach einem Update neu laden; die Erkennung benennt keine externen Ordner um. "
"Ordnersymbole klappen den Baum auf oder zu; Beschriftungen wählen aus, ohne die Aufklappstellung zu ändern. "
"Eine künstliche übergeordnete Gruppe wird hervorgehoben und leert die Nachrichtenauswahl, ohne einen erfundenen Anbieterordner zu öffnen. "
"IMAP behält sein bisheriges Verhalten; JMAP ergänzt "
"serverseitige Suche, zustandsgebundene Seitennavigation und begrenzte inkrementelle Änderungen. Listen zeigen die vom Anbieter gelieferten Gelesen-/Ungelesen-Kennzeichen " "serverseitige Suche, zustandsgebundene Seitennavigation und begrenzte inkrementelle Änderungen. Listen zeigen die vom Anbieter gelieferten Gelesen-/Ungelesen-Kennzeichen "
"und die Herkunft aus Livezugriff, Zwischenspeicher oder Aktualisierung, ohne diese Zustände zu verändern. HTML-Inhalte " "und die Herkunft aus Livezugriff, Zwischenspeicher oder Aktualisierung, ohne diese Zustände zu verändern. HTML-Inhalte "
"werden isoliert und bereinigt; Anlagen, Inline-Verweise, nicht verfügbare Inhalte und Providerfehler bleiben ausdrücklich sichtbar. " "werden isoliert und bereinigt; Anlagen, Inline-Verweise, nicht verfügbare Inhalte und Providerfehler bleiben ausdrücklich sichtbar. "
"Das Auflisten von Ordnern oder Nachrichten darf keine Nachricht als gelesen markieren, verschieben oder löschen und keine " "Das Auflisten von Ordnern oder Nachrichten darf keine Nachricht als gelesen markieren, verschieben oder löschen und keine "
"unbegrenzten Inhalte offenlegen." "unbegrenzten Inhalte offenlegen. "
"Die dauerhafte Arbeitsbereichsleiste enthält Profilauswahl, Postfachwerkzeuge, Hilfe und genau einmal Neuladen rechts, auch ohne Profil- oder Nachrichtenauswahl. "
"Neuladen prüft zuerst die berechtigten Profile und aktualisiert anschließend den aktuellen Ordnerkatalog und die begrenzte Nachrichtenseite gemeinsam. "
"Eine noch vorhandene ausgewählte Nachricht wird erneut gelesen. IMAP behält die Seite; JMAP beginnt mit der bestehenden Suche eine neue Cursorfolge auf Seite eins. "
"Bei einer ausgewählten künstlichen Gruppe wird nur der Ordnerkatalog gelesen, kein erfundenes Postfach. Aufklappstellungen bleiben erhalten. "
"Fehlgeschlagene Aktualisierungen erhalten nutzbare geladene Daten mit ausdrücklicher Fehlermeldung und Wiederholungsmöglichkeit; sie erscheinen nicht als leeres Postfach. "
"Verspätete Antworten eines vorherigen Profils oder Mandanten werden verworfen. Postfachwerkzeuge trennt gezieltes Aktualisieren von Profilen, Ordnern und Nachrichten vom Rückläuferstatus. "
"Bei fehlender Rückläufer-Lese- oder Verwaltungsberechtigung bleibt dieser Einstieg mit Erklärung sichtbar und deaktiviert. "
"Diese Aktionen vergeben keine Profilverwaltungsrechte, versenden oder hängen keine Nachrichten an und ändern keine Gelesen-/Ungelesen-Kennzeichen. "
"Postfachkontext-Lesezugriffe umgehen die Wiederverwendung von Browserantworten; begrenzte serverseitige Indizes und deren Herkunft bleiben unter Kontrolle von Mail. "
"Fehlgeschlagene Seitenwechsel stellen die zu den erhaltenen Zeilen gehörige Seite und Seitengröße wieder her. "
"Das Schließen oder Wechseln der Vorschau während Neuladen hat Vorrang vor der zuvor gemerkten Auswahl. "
"Auf schmalen Bildschirmen werden Ordner, Nachrichten und Vorschau innerhalb des Postfacharbeitsbereichs vertikal gescrollt; seine Aktionsleiste bleibt sichtbar."
), ),
} }
}, },
@@ -1309,13 +1425,14 @@ manifest = ModuleManifest(
"kind": "workflow", "kind": "workflow",
"route": "/mail", "route": "/mail",
"screen": "Mail", "screen": "Mail",
"help_contexts": ["mail.list", "mail.mailbox"], "help_contexts": ["mail.list", "mail.mailbox", "mail.mailbox.reload", "mail.mailbox.tools"],
"prerequisites": [ "prerequisites": [
"An active visible profile has IMAP or JMAP configured.", "An active visible profile has IMAP or JMAP configured.",
"You may both use that profile and read its mailbox.", "You may both use that profile and read its mailbox.",
], ],
"steps": [ "steps": [
"Open Mail and choose an authorized IMAP- or JMAP-enabled profile.", "Open Mail and choose an authorized IMAP- or JMAP-enabled profile.",
"Use the right-aligned Reload for the complete current context; Mailbox tools contains optional targeted refreshes and permission-aware bounce diagnostics.",
"Select a folder, review the live/cached synchronization label, and page its bounded message index; JMAP searches run at the provider.", "Select a folder, review the live/cached synchronization label, and page its bounded message index; JMAP searches run at the provider.",
"Use the provider-derived read/unread indicator, then open only the message needed for the task.", "Use the provider-derived read/unread indicator, then open only the message needed for the task.",
"Switch between safe plain-text and isolated HTML views as needed, and review attachment or unavailable-content details before closing the preview.", "Switch between safe plain-text and isolated HTML views as needed, and review attachment or unavailable-content details before closing the preview.",
@@ -1382,7 +1499,11 @@ manifest = ModuleManifest(
id="mail.reference.campaign-delivery-contract", id="mail.reference.campaign-delivery-contract",
title="Integrate Campaign through the Mail delivery contract", title="Integrate Campaign through the Mail delivery contract",
summary="Campaign freezes a Mail profile reference and opaque revision; Mail re-authorizes, revision-checks, resolves credentials, and performs the effect in one call.", summary="Campaign freezes a Mail profile reference and opaque revision; Mail re-authorizes, revision-checks, resolves credentials, and performs the effect in one call.",
body="The mail.campaign_delivery 0.2 contract never returns decrypted credentials or resolved SMTP/IMAP configuration. Mail compares the expected random transport revision before decrypting protocol-specific credentials and returns only bounded sanitized outcomes. Synchronous batches authorize the complete recipient set and preflight DNS, egress, connectivity, TLS, and authentication before the first effect. Mail reuses the bounded connection when deployment policy permits, health-checks it before reuse, and reconnects before the next message when a stale connection is detected. A connection loss after DATA begins remains outcome-unknown and is never replayed. Systemic authentication, sender, or connectivity failures carry stable reason codes so Campaign pauses remaining queued work and shows connection, reconnect, failure, and pause progress. Campaign owns ordinary recipient jobs; report messages use Mail's encrypted idempotent delivery-command and attempt ledger. Every current SMTP and Sent-folder attempt passes a stable effect identifier into a Mail-owned Core recovery operation before provider contact. Effect-start evidence prevents blind redelivery, unknown outcomes require explicit reconciliation, and raw recipient refusals require Mail diagnostic authority. Mail outbox dispatch and retention scans are partitioned by tenant entitlement, so disabling Mail leaves accepted commands and evidence untouched for operator resolution.", body=(
"The mail.campaign_delivery 0.2 contract never returns decrypted credentials or resolved SMTP/IMAP configuration. Mail compares the expected random transport revision before decrypting protocol-specific credentials and returns only bounded sanitized outcomes. Synchronous batches authorize the complete recipient set and preflight DNS, egress, connectivity, TLS, and authentication before the first effect. Mail reuses the bounded connection when deployment policy permits, health-checks it before reuse, and reconnects before the next message when a stale connection is detected. A connection loss after DATA begins remains outcome-unknown and is never replayed. Systemic authentication, sender, or connectivity failures carry stable reason codes so Campaign pauses remaining queued work and shows connection, reconnect, failure, and pause progress. Campaign owns ordinary recipient jobs; report messages use Mail's encrypted idempotent delivery-command and attempt ledger. Every current SMTP and Sent-folder attempt passes a stable effect identifier into a Mail-owned Core recovery operation before provider contact. Effect-start evidence prevents blind redelivery, unknown outcomes require explicit reconciliation, and raw recipient refusals require Mail diagnostic authority. Mail outbox dispatch and retention scans are partitioned by tenant entitlement, so disabling Mail leaves accepted commands and evidence untouched for operator resolution."
" Runtime credential-selection checks are protocol-scoped: SMTP batch and single-message delivery enforce SMTP policy; Sent-folder append enforces IMAP policy. A valid explicit SMTP selection must not fail merely because the SMTP call does not carry an unrelated explicit IMAP credential, and vice versa. Full campaign authoring validation and complete profile summaries still check both configured protocols. Missing explicit credentials for the selected protocol, inactive or unauthorized bindings and stale transport revisions remain blocked before credential decryption or provider contact. A successful Mail connection test proves only that selected connection/login, not later campaign authorization or recipient acceptance. Correcting this runtime check changes no saved policy, credentials, build/review evidence, or delivery status and does not send messages automatically."
" The optional campaign_imap_batch context reuses a bounded authenticated IMAP connection for sequential APPENDs, never MULTIAPPEND or parallel effects. It opens lazily after each message's current authorization, both frozen revisions, IMAP-only credential resolution and recovery checks; permissions and recovery evidence are never cached. Connection-local Sent-folder discovery preserves the provider's original Unicode wire names. Different campaign/tenant scopes are rejected, and changed profile, references, folder or resolved credentials cannot reuse the prior connection. Defaults are 100 messages or 300 seconds per connection, an idle NOOP after 30 seconds, and one extra connection attempt before APPEND. GOVOPLAN_IMAP_BATCH_REUSE can disable reuse; MAX_MESSAGES, MAX_AGE_SECONDS, IDLE_HEALTH_CHECK_SECONDS and RECONNECT_ATTEMPTS with the same prefix bound deployment behavior as documented in the handbook. There is no automatic APPEND replay after transmission starts; unknown outcomes require mailbox reconciliation without SMTP resend. Accepted recovery-evidence finalization failure closes the batch; logout failure does not reverse acceptance. Per-message connection/reuse/reconnect counters expose no secrets. Older optional Mail providers retain single-message behavior."
),
layer="available", layer="available",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("integrator", "campaign_manager", "campaign_sender", "release_reviewer"), audience=("integrator", "campaign_manager", "campaign_sender", "release_reviewer"),
@@ -1418,6 +1539,8 @@ manifest = ModuleManifest(
"Wiederzustellung; unbekannte Ergebnisse erfordern ausdrückliche Abstimmung, und rohe Empfängerablehnungen erfordern Mail-Diagnoseberechtigung. " "Wiederzustellung; unbekannte Ergebnisse erfordern ausdrückliche Abstimmung, und rohe Empfängerablehnungen erfordern Mail-Diagnoseberechtigung. "
"Mail-Ausgangsverarbeitung und Aufbewahrungsläufe werden nach Mandantenberechtigung partitioniert. Das Deaktivieren von Mail lässt bereits " "Mail-Ausgangsverarbeitung und Aufbewahrungsläufe werden nach Mandantenberechtigung partitioniert. Das Deaktivieren von Mail lässt bereits "
"angenommene Befehle und Nachweise daher zur Klärung durch den Betrieb unverändert bestehen." "angenommene Befehle und Nachweise daher zur Klärung durch den Betrieb unverändert bestehen."
" Zur Laufzeit gelten Zugangsdaten-Auswahlregeln protokollbezogen: SMTP-Stapel und einzelne SMTP-Zustellungen prüfen die SMTP-Richtlinie; die Ablage im Gesendet-Ordner prüft die IMAP-Richtlinie. Eine gültige ausdrückliche SMTP-Auswahl darf nicht daran scheitern, dass der reine SMTP-Aufruf keine getrennte IMAP-Zugangsdatenkennung übergibt; umgekehrt gilt dasselbe. Vollständige Kampagnenvalidierung und Profilzusammenfassungen prüfen weiterhin beide konfigurierten Protokolle. Fehlende ausdrückliche Zugangsdaten des genutzten Protokolls, inaktive oder unberechtigte Bindungen und veraltete Transportrevisionen bleiben vor Entschlüsselung oder Providerkontakt gesperrt. Ein erfolgreicher Mail-Verbindungstest belegt nur diese Verbindung und Anmeldung, nicht spätere Kampagnenberechtigung oder Empfängerannahme. Die Korrektur verändert keine gespeicherte Richtlinie, Zugangsdaten, Build-/Prüfnachweise oder Zustellzustände und versendet nicht automatisch."
" Der optionale Kontext campaign_imap_batch verwendet eine begrenzte authentifizierte IMAP-Verbindung für sequenzielle APPENDs erneut, niemals MULTIAPPEND oder parallele Wirkungen. Er öffnet erst nach der aktuellen Berechtigungsprüfung, Prüfung beider eingefrorenen Revisionen, alleiniger Auflösung der IMAP-Zugangsdaten und Wiederherstellungsprüfung jeder Nachricht; Berechtigungen und Nachweise werden nicht zwischengespeichert. Die verbindungslokale Gesendet-Ordner-Erkennung erhält die ursprünglichen Unicode-Übertragungsnamen des Providers. Andere Mandanten oder Kampagnen werden abgelehnt; geänderte Profile, Referenzen, Ordner oder aufgelöste Zugangsdaten dürfen die bisherige Verbindung nicht weiterverwenden. Standardwerte sind 100 Nachrichten oder 300 Sekunden je Verbindung, NOOP nach 30 Sekunden Leerlauf und ein zusätzlicher Verbindungsversuch vor APPEND. GOVOPLAN_IMAP_BATCH_REUSE kann die Wiederverwendung deaktivieren; MAX_MESSAGES, MAX_AGE_SECONDS, IDLE_HEALTH_CHECK_SECONDS und RECONNECT_ATTEMPTS mit demselben Präfix begrenzen das Betriebsverhalten gemäß Handbuch. Nach Übertragungsbeginn wird APPEND niemals automatisch wiederholt; unbekannte Ergebnisse erfordern Postfachabgleich ohne erneuten SMTP-Versand. Ein Fehler beim Abschluss des Annahmenachweises schließt den Stapel; ein Abmeldefehler macht die Annahme nicht rückgängig. Verbindungs-, Wiederverwendungs- und Neuverbindungszähler enthalten keine Geheimnisse. Ältere optionale Mail-Anbieter behalten das Einzelaufrufverhalten."
), ),
} }
}, },
@@ -1426,7 +1549,7 @@ manifest = ModuleManifest(
"route": "/campaigns/{campaign_id}/mail-settings", "route": "/campaigns/{campaign_id}/mail-settings",
"screen": "Campaign Mail settings", "screen": "Campaign Mail settings",
"section": "Mail-owned profile and transport boundary", "section": "Mail-owned profile and transport boundary",
"verification": "Prove stale revisions fail before credential decryption, batch preflight fails before DATA, two messages reuse one healthy connection, a stale connection reconnects before the next message, post-DATA disconnect is never replayed, systemic failures pause remaining jobs, provider details are sanitized, and the interface/version gate passes.", "verification": "Prove stale revisions fail before credential decryption, batch preflight fails before DATA, two messages reuse one healthy connection, a stale connection reconnects before the next message, post-DATA disconnect is never replayed, systemic failures pause remaining jobs, provider details are sanitized, and the interface/version gate passes. For IMAP, prove one login and folder discovery for sequential APPENDs, count/age rotation, changed authorization or revisions block the next message before decryption, per-message recovery remains independent, unknown APPEND is never replayed, and nested/scoped contexts clean up safely.",
"related_topic_ids": [ "related_topic_ids": [
"mail.profile-ownership-and-consumers", "mail.profile-ownership-and-consumers",
"campaigns.mail-profile-user-journey", "campaigns.mail-profile-user-journey",
@@ -0,0 +1,60 @@
"""Scope POP3 imports to a stable effective maildrop.
Revision ID: b5d6e7f8091a
Revises: a4c5d6e7f809
"""
from alembic import op
import sqlalchemy as sa
revision = "b5d6e7f8091a"
down_revision = "a4c5d6e7f809"
branch_labels = None
depends_on = None
def upgrade() -> None:
# Historical effective credentials may have changed. NULL is deliberate:
# never backfill from today's account or guess from the old credential ID.
with op.batch_alter_table("mail_pop3_imports") as batch:
batch.add_column(sa.Column("maildrop_identity", sa.String(64), nullable=True))
batch.drop_constraint("uq_mail_pop3_imports_source_uidl", type_="unique")
batch.create_unique_constraint(
"uq_mail_pop3_imports_maildrop_uidl",
[
"tenant_id",
"profile_id",
"pop3_server_id",
"maildrop_identity",
"provider_uidl",
],
)
def downgrade() -> None:
connection = op.get_bind()
table = sa.table(
"mail_pop3_imports",
*(
sa.column(name)
for name in ("tenant_id", "profile_id", "pop3_server_id", "provider_uidl")
),
)
collision = connection.execute(
sa.select(sa.func.count())
.select_from(table)
.group_by(*table.c)
.having(sa.func.count() > 1)
.limit(1)
).first()
if collision is not None:
raise RuntimeError(
"POP3 downgrade would collapse different maildrops; preserve all records and resolve this explicitly before downgrading"
)
with op.batch_alter_table("mail_pop3_imports") as batch:
batch.drop_constraint("uq_mail_pop3_imports_maildrop_uidl", type_="unique")
batch.create_unique_constraint(
"uq_mail_pop3_imports_source_uidl",
["tenant_id", "profile_id", "pop3_server_id", "provider_uidl"],
)
batch.drop_column("maildrop_identity")
+158 -10
View File
@@ -2,6 +2,8 @@ from __future__ import annotations
import base64 import base64
import hashlib import hashlib
import ipaddress
import json
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timezone from datetime import datetime, timezone
from typing import Iterable from typing import Iterable
@@ -9,7 +11,12 @@ from typing import Iterable
from sqlalchemy import or_, select from sqlalchemy import or_, select
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from govoplan_core.security.secrets import encrypt_secret from govoplan_core.security.secrets import (
SecretDecryptionError,
decrypt_secret,
encrypt_secret,
)
from govoplan_mail.backend.config import Pop3Config
from govoplan_mail.backend.db.models import MailPop3Import, MailServerEndpoint from govoplan_mail.backend.db.models import MailPop3Import, MailServerEndpoint
from govoplan_mail.backend.sending.pop3 import Pop3DownloadedMessage from govoplan_mail.backend.sending.pop3 import Pop3DownloadedMessage
@@ -18,6 +25,38 @@ class Pop3ImportError(RuntimeError):
pass pass
class Pop3ImportConflict(Pop3ImportError):
pass
def maildrop_identity(config: Pop3Config) -> str:
"""Stable mailbox key, excluding credentials and secret rotation revisions."""
if not config.host or not config.port or not config.username:
raise Pop3ImportError(
"POP3 maildrop identity requires a host, port and username"
)
host = config.host.strip().rstrip(".")
try:
host = ipaddress.ip_address(host).compressed
except ValueError:
try:
host = host.encode("idna").decode("ascii").casefold()
except UnicodeError as exc:
raise Pop3ImportError("The POP3 hostname is invalid") from exc
if not host:
raise Pop3ImportError("The POP3 hostname is invalid")
material = ("pop3-maildrop-v1", host, config.port, config.username)
return hashlib.sha256(
json.dumps(material, ensure_ascii=True, separators=(",", ":")).encode("ascii")
).hexdigest()
def pop3_preview_revision(transport_revision: str, identity: str) -> str:
return hashlib.sha256(
json.dumps((transport_revision, identity)).encode("ascii")
).hexdigest()
@dataclass(frozen=True, slots=True) @dataclass(frozen=True, slots=True)
class Pop3ImportResult: class Pop3ImportResult:
imported: tuple[MailPop3Import, ...] imported: tuple[MailPop3Import, ...]
@@ -32,11 +71,16 @@ def create_pop3_imports(
pop3_server_id: str, pop3_server_id: str,
pop3_credential_id: str | None, pop3_credential_id: str | None,
transport_revision: str, transport_revision: str,
maildrop_key: str,
messages: Iterable[Pop3DownloadedMessage], messages: Iterable[Pop3DownloadedMessage],
user_id: str | None, user_id: str | None,
deletion_requested: bool, deletion_requested: bool,
) -> Pop3ImportResult: ) -> Pop3ImportResult:
downloaded = tuple(messages) downloaded = tuple(messages)
if len(maildrop_key) != 64 or any(
character not in "0123456789abcdef" for character in maildrop_key
):
raise Pop3ImportError("A resolved POP3 maildrop identity is required")
if not downloaded: if not downloaded:
raise Pop3ImportError("No POP3 messages were downloaded for import") raise Pop3ImportError("No POP3 messages were downloaded for import")
uidls = [item.uidl for item in downloaded] uidls = [item.uidl for item in downloaded]
@@ -63,17 +107,36 @@ def create_pop3_imports(
if source is None: if source is None:
raise Pop3ImportError("The selected POP3 source is unavailable") raise Pop3ImportError("The selected POP3 source is unavailable")
existing = { rows = tuple(
row.provider_uidl: row session.scalars(
for row in session.scalars(
select(MailPop3Import).where( select(MailPop3Import).where(
MailPop3Import.tenant_id == tenant_id, MailPop3Import.tenant_id == tenant_id,
MailPop3Import.profile_id == profile_id, MailPop3Import.profile_id == profile_id,
MailPop3Import.pop3_server_id == pop3_server_id, MailPop3Import.pop3_server_id == pop3_server_id,
MailPop3Import.provider_uidl.in_(uidls), MailPop3Import.provider_uidl.in_(uidls),
or_(
MailPop3Import.maildrop_identity == maildrop_key,
MailPop3Import.maildrop_identity.is_(None),
),
) )
) )
} )
# Validate the entire batch before adding records, including legacy ambiguity.
if any(row.maildrop_identity is None for row in rows):
raise Pop3ImportConflict(
"A selected UIDL has an unbound legacy import. An administrator must reconcile its maildrop identity before importing; no messages were imported or deleted."
)
existing = {row.provider_uidl: row for row in rows}
for message in downloaded:
if hashlib.sha256(message.raw).hexdigest() != message.raw_sha256:
raise Pop3ImportConflict(
"The downloaded POP3 content digest is inconsistent"
)
duplicate = existing.get(message.uidl)
if duplicate is not None and duplicate.raw_sha256 != message.raw_sha256:
raise Pop3ImportConflict(
"The maildrop reused a UIDL for different content. Review the retained and source messages; no messages were imported or deleted."
)
imported: list[MailPop3Import] = [] imported: list[MailPop3Import] = []
duplicates: list[MailPop3Import] = [] duplicates: list[MailPop3Import] = []
now = datetime.now(timezone.utc) now = datetime.now(timezone.utc)
@@ -92,6 +155,7 @@ def create_pop3_imports(
pop3_server_id=pop3_server_id, pop3_server_id=pop3_server_id,
pop3_credential_id=pop3_credential_id, pop3_credential_id=pop3_credential_id,
transport_revision=_required_revision(transport_revision), transport_revision=_required_revision(transport_revision),
maildrop_identity=maildrop_key,
provider_uidl=message.uidl, provider_uidl=message.uidl,
provider_message_number=message.message_number, provider_message_number=message.message_number,
fingerprint=_fingerprint( fingerprint=_fingerprint(
@@ -100,6 +164,7 @@ def create_pop3_imports(
pop3_server_id=pop3_server_id, pop3_server_id=pop3_server_id,
uidl=message.uidl, uidl=message.uidl,
raw_sha256=message.raw_sha256, raw_sha256=message.raw_sha256,
maildrop_key=maildrop_key,
), ),
raw_sha256=message.raw_sha256, raw_sha256=message.raw_sha256,
raw_message_encrypted=encrypted, raw_message_encrypted=encrypted,
@@ -122,6 +187,87 @@ def create_pop3_imports(
return Pop3ImportResult(imported=tuple(imported), duplicates=tuple(duplicates)) return Pop3ImportResult(imported=tuple(imported), duplicates=tuple(duplicates))
def bind_legacy_maildrop(
session: Session,
*,
tenant_id: str,
profile_id: str,
server_id: str,
import_id: str,
identity: str,
message: Pop3DownloadedMessage,
) -> MailPop3Import:
# Same lock order as import, including when two administrators reconcile.
source = session.scalar(
select(MailServerEndpoint)
.where(
MailServerEndpoint.id == server_id,
MailServerEndpoint.profile_id == profile_id,
MailServerEndpoint.protocol == "pop3",
or_(
MailServerEndpoint.tenant_id == tenant_id,
MailServerEndpoint.tenant_id.is_(None),
),
)
.with_for_update()
)
if source is None:
raise Pop3ImportError("The selected POP3 source is unavailable")
row = session.scalar(
select(MailPop3Import)
.where(
MailPop3Import.id == import_id,
MailPop3Import.tenant_id == tenant_id,
MailPop3Import.profile_id == profile_id,
MailPop3Import.pop3_server_id == server_id,
)
.with_for_update()
.execution_options(populate_existing=True)
)
if row is None:
raise Pop3ImportError("The legacy POP3 import is unavailable")
if row.maildrop_identity not in (None, identity):
raise Pop3ImportConflict(
"This POP3 import is already bound to another maildrop"
)
try:
retained = base64.b64decode(
decrypt_secret(row.raw_message_encrypted) or "", validate=True
)
except (ValueError, TypeError, SecretDecryptionError) as exc:
raise Pop3ImportConflict(
"The retained POP3 content could not be verified"
) from exc
if (
message.uidl != row.provider_uidl
or retained != message.raw
or hashlib.sha256(retained).hexdigest() != row.raw_sha256
or message.raw_sha256 != row.raw_sha256
):
raise Pop3ImportConflict(
"The current UIDL content does not match the retained legacy message; binding was refused"
)
collision = session.scalar(
select(MailPop3Import.id)
.where(
MailPop3Import.tenant_id == tenant_id,
MailPop3Import.profile_id == profile_id,
MailPop3Import.pop3_server_id == server_id,
MailPop3Import.provider_uidl == row.provider_uidl,
MailPop3Import.maildrop_identity == identity,
MailPop3Import.id != row.id,
)
.limit(1)
)
if collision is not None:
raise Pop3ImportConflict(
"Another import already owns this maildrop UIDL; no records were merged"
)
row.maildrop_identity = identity
session.flush()
return row
def list_pop3_imports( def list_pop3_imports(
session: Session, session: Session,
*, *,
@@ -130,9 +276,7 @@ def list_pop3_imports(
profile_ids: Iterable[str] | None = None, profile_ids: Iterable[str] | None = None,
limit: int = 100, limit: int = 100,
) -> tuple[MailPop3Import, ...]: ) -> tuple[MailPop3Import, ...]:
statement = select(MailPop3Import).where( statement = select(MailPop3Import).where(MailPop3Import.tenant_id == tenant_id)
MailPop3Import.tenant_id == tenant_id
)
if profile_id: if profile_id:
statement = statement.where(MailPop3Import.profile_id == profile_id) statement = statement.where(MailPop3Import.profile_id == profile_id)
elif profile_ids is not None: elif profile_ids is not None:
@@ -160,7 +304,9 @@ def mark_pop3_deletion_result(
clean_status = str(status or "").strip().casefold() clean_status = str(status or "").strip().casefold()
if clean_status not in {"succeeded", "failed", "outcome_unknown"}: if clean_status not in {"succeeded", "failed", "outcome_unknown"}:
raise Pop3ImportError("Unsupported POP3 deletion result") raise Pop3ImportError("Unsupported POP3 deletion result")
ids = tuple(dict.fromkeys(str(value).strip() for value in import_ids if str(value).strip())) ids = tuple(
dict.fromkeys(str(value).strip() for value in import_ids if str(value).strip())
)
if not ids: if not ids:
return () return ()
rows = tuple( rows = tuple(
@@ -192,6 +338,7 @@ def pop3_import_payload(row: MailPop3Import) -> dict[str, object]:
"profile_id": row.profile_id, "profile_id": row.profile_id,
"pop3_server_id": row.pop3_server_id, "pop3_server_id": row.pop3_server_id,
"transport_revision": row.transport_revision, "transport_revision": row.transport_revision,
"maildrop_identity_bound": bool(getattr(row, "maildrop_identity", None)),
"provider_uidl": row.provider_uidl, "provider_uidl": row.provider_uidl,
"message_id": row.message_id, "message_id": row.message_id,
"subject": row.subject, "subject": row.subject,
@@ -217,9 +364,10 @@ def _fingerprint(
pop3_server_id: str, pop3_server_id: str,
uidl: str, uidl: str,
raw_sha256: str, raw_sha256: str,
maildrop_key: str,
) -> str: ) -> str:
material = "\x1f".join( material = "\x1f".join(
(tenant_id, profile_id, pop3_server_id, uidl, raw_sha256) (tenant_id, profile_id, pop3_server_id, maildrop_key, uidl, raw_sha256)
).encode("utf-8") ).encode("utf-8")
return hashlib.sha256(material).hexdigest() return hashlib.sha256(material).hexdigest()
+114 -6
View File
@@ -10,6 +10,7 @@ from sqlalchemy import func, or_, select
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from govoplan_mail.backend.schemas import ( from govoplan_mail.backend.schemas import (
MailPop3BindMaildropRequest,
MailAddressLookupCandidate, MailAddressLookupCandidate,
MailAddressLookupResponse, MailAddressLookupResponse,
MailAddressWriteTarget, MailAddressWriteTarget,
@@ -105,6 +106,10 @@ from govoplan_mail.backend.config import ImapConfig, JmapConfig, Pop3Config, Smt
from govoplan_mail.backend.db.models import MailPop3Import from govoplan_mail.backend.db.models import MailPop3Import
from govoplan_mail.backend.pop3_imports import ( from govoplan_mail.backend.pop3_imports import (
Pop3ImportError, Pop3ImportError,
Pop3ImportConflict,
maildrop_identity,
pop3_preview_revision,
bind_legacy_maildrop,
create_pop3_imports, create_pop3_imports,
list_pop3_imports, list_pop3_imports,
mark_pop3_deletion_result, mark_pop3_deletion_result,
@@ -3079,20 +3084,24 @@ def preview_profile_pop3_import(
limit=payload.limit, limit=payload.limit,
) )
uidls = [message.uidl for message in result.messages] uidls = [message.uidl for message in result.messages]
imported_uidls = set( identity = maildrop_identity(resolved.config)
session.scalars( prior = list(
select(MailPop3Import.provider_uidl).where( session.execute(
select(MailPop3Import.provider_uidl, MailPop3Import.maildrop_identity).where(
MailPop3Import.tenant_id == principal.tenant_id, MailPop3Import.tenant_id == principal.tenant_id,
MailPop3Import.profile_id == profile_id, MailPop3Import.profile_id == profile_id,
MailPop3Import.pop3_server_id == resolved.server.id, MailPop3Import.pop3_server_id == resolved.server.id,
MailPop3Import.provider_uidl.in_(uidls), MailPop3Import.provider_uidl.in_(uidls),
or_(MailPop3Import.maildrop_identity == identity, MailPop3Import.maildrop_identity.is_(None)),
) )
) )
) if uidls else set() ) if uidls else []
legacy_uidls = {row.provider_uidl for row in prior if row.maildrop_identity is None}
imported_uidls = {row.provider_uidl for row in prior if row.maildrop_identity == identity}
return MailPop3PreviewResponse( return MailPop3PreviewResponse(
profile_id=profile_id, profile_id=profile_id,
server_id=resolved.server.id, server_id=resolved.server.id,
transport_revision=resolved.transport_revision, transport_revision=pop3_preview_revision(resolved.transport_revision, identity),
host=result.host, host=result.host,
port=result.port, port=result.port,
security=result.security, security=result.security,
@@ -3111,6 +3120,7 @@ def preview_profile_pop3_import(
size_bytes=message.size_bytes, size_bytes=message.size_bytes,
body_preview=message.body_preview, body_preview=message.body_preview,
already_imported=message.uidl in imported_uidls, already_imported=message.uidl in imported_uidls,
legacy_identity_conflict=message.uidl in legacy_uidls,
) )
for message in result.messages for message in result.messages
], ],
@@ -3154,7 +3164,8 @@ def import_profile_pop3_messages(
server_id=payload.server_id, server_id=payload.server_id,
credential_id=payload.credential_id, credential_id=payload.credential_id,
) )
if resolved.transport_revision != payload.expected_transport_revision: identity = maildrop_identity(resolved.config)
if pop3_preview_revision(resolved.transport_revision, identity) != payload.expected_transport_revision:
raise HTTPException( raise HTTPException(
status_code=status.HTTP_409_CONFLICT, status_code=status.HTTP_409_CONFLICT,
detail="The POP3 server or credential selection changed; refresh the preview before importing", detail="The POP3 server or credential selection changed; refresh the preview before importing",
@@ -3177,6 +3188,7 @@ def import_profile_pop3_messages(
resolved.credential.id if resolved.credential is not None else None resolved.credential.id if resolved.credential is not None else None
), ),
transport_revision=resolved.transport_revision, transport_revision=resolved.transport_revision,
maildrop_key=identity,
messages=downloaded, messages=downloaded,
user_id=principal.user.id, user_id=principal.user.id,
deletion_requested=payload.delete_after_import, deletion_requested=payload.delete_after_import,
@@ -3272,6 +3284,11 @@ def import_profile_pop3_messages(
status_code=status.HTTP_404_NOT_FOUND, status_code=status.HTTP_404_NOT_FOUND,
detail=str(exc), detail=str(exc),
) from exc ) from exc
except Pop3ImportConflict as exc:
session.rollback()
raise HTTPException(
status_code=status.HTTP_409_CONFLICT, detail=str(exc)
) from exc
except (Pop3ConfigurationError, Pop3ImportError) as exc: except (Pop3ConfigurationError, Pop3ImportError) as exc:
session.rollback() session.rollback()
raise HTTPException( raise HTTPException(
@@ -3289,6 +3306,97 @@ def import_profile_pop3_messages(
raise raise
@router.post(
"/profiles/{profile_id}/pop3/imports/{import_id}/bind-maildrop",
response_model=MailPop3ImportRecordResponse,
)
def reconcile_pop3_import_maildrop(
profile_id: str,
import_id: str,
payload: MailPop3BindMaildropRequest,
principal: ApiPrincipal = Depends(get_api_principal),
session: Session = Depends(get_session),
):
_require_scope(principal, "mail:profile:use")
_require_scope(principal, "mail:pop3:manage")
_require_scope(principal, "mail:pop3:import")
try:
_profile, resolved = _resolve_profile_pop3_transport(
session,
principal=principal,
profile_id=profile_id,
server_id=payload.server_id,
credential_id=payload.credential_id,
)
identity = maildrop_identity(resolved.config)
if (
pop3_preview_revision(resolved.transport_revision, identity)
!= payload.expected_transport_revision
):
raise Pop3ImportConflict(
"The POP3 selection changed; refresh the preview before reconciling"
)
row = session.scalar(
select(MailPop3Import).where(
MailPop3Import.id == import_id,
MailPop3Import.tenant_id == principal.tenant_id,
MailPop3Import.profile_id == profile_id,
MailPop3Import.pop3_server_id == resolved.server.id,
)
)
if row is None:
raise HTTPException(
status_code=404, detail="The legacy POP3 import is unavailable"
)
messages = download_pop3_messages(
pop3_config=resolved.config, uidls=(row.provider_uidl,)
)
if len(messages) != 1:
raise Pop3ImportConflict(
"The source did not return exactly the selected legacy message"
)
bound = bind_legacy_maildrop(
session,
tenant_id=principal.tenant_id,
profile_id=profile_id,
server_id=resolved.server.id,
import_id=import_id,
identity=identity,
message=messages[0],
)
audit_event(
session,
tenant_id=principal.tenant_id,
user_id=principal.user.id,
action="mail.pop3.maildrop_bound",
object_type="mail_pop3_import",
object_id=bound.id,
details={
"profile_id": profile_id,
"server_id": resolved.server.id,
"content_verified": True,
"source_deleted": False,
},
)
session.commit()
return MailPop3ImportRecordResponse.model_validate(pop3_import_payload(bound))
except Pop3ImportConflict as exc:
session.rollback()
raise HTTPException(status_code=409, detail=str(exc)) from exc
except (MailProfileError, MailServerHierarchyError) as exc:
session.rollback()
raise HTTPException(status_code=404, detail=str(exc)) from exc
except (Pop3ConfigurationError, Pop3ImportError) as exc:
session.rollback()
raise HTTPException(status_code=422, detail=str(exc)) from exc
except Pop3ProviderError as exc:
session.rollback()
raise HTTPException(status_code=502, detail=str(exc)) from exc
except Exception:
session.rollback()
raise
@router.get("/pop3/imports", response_model=MailPop3ImportListResponse) @router.get("/pop3/imports", response_model=MailPop3ImportListResponse)
def get_pop3_imports( def get_pop3_imports(
profile_id: str | None = Query(default=None), profile_id: str | None = Query(default=None),
+11
View File
@@ -410,6 +410,7 @@ class MailPop3MessagePreviewResponse(BaseModel):
size_bytes: int = 0 size_bytes: int = 0
body_preview: str | None = None body_preview: str | None = None
already_imported: bool = False already_imported: bool = False
legacy_identity_conflict: bool = False
class MailPop3PreviewResponse(BaseModel): class MailPop3PreviewResponse(BaseModel):
@@ -440,6 +441,7 @@ class MailPop3ImportRecordResponse(BaseModel):
profile_id: str profile_id: str
pop3_server_id: str pop3_server_id: str
transport_revision: str transport_revision: str
maildrop_identity_bound: bool = False
provider_uidl: str provider_uidl: str
message_id: str | None = None message_id: str | None = None
subject: str | None = None subject: str | None = None
@@ -467,6 +469,15 @@ class MailPop3ImportListResponse(BaseModel):
imports: list[MailPop3ImportRecordResponse] = Field(default_factory=list) imports: list[MailPop3ImportRecordResponse] = Field(default_factory=list)
class MailPop3BindMaildropRequest(BaseModel):
model_config = ConfigDict(extra="forbid")
server_id: str = Field(min_length=1, max_length=36)
credential_id: str | None = Field(default=None, max_length=36)
expected_transport_revision: str = Field(min_length=1, max_length=120)
confirm_binding: Literal[True]
class MailImapFolderResponse(BaseModel): class MailImapFolderResponse(BaseModel):
name: str name: str
flags: list[str] = Field(default_factory=list) flags: list[str] = Field(default_factory=list)
+384 -79
View File
@@ -1,16 +1,21 @@
from __future__ import annotations from __future__ import annotations
import base64
import binascii
import imaplib import imaplib
import logging import logging
import os
import re import re
import socket import socket
import ssl import ssl
import time import time
from contextlib import contextmanager
from dataclasses import dataclass from dataclasses import dataclass
from email import policy from email import policy
from email.message import EmailMessage from email.message import EmailMessage
from email.parser import BytesParser from email.parser import BytesParser
from typing import Any from threading import Lock
from typing import Any, Iterator
from govoplan_core.security.outbound_http import ( from govoplan_core.security.outbound_http import (
OutboundHttpError, OutboundHttpError,
@@ -212,6 +217,9 @@ class ImapAppendResult:
folder: str folder: str
bytes_appended: int bytes_appended: int
response: str | None = None response: str | None = None
connection_sequence: int = 1
session_reused: bool = False
reconnect_count: int = 0
def _require_imap_config(config: ImapConfig) -> tuple[str, int]: def _require_imap_config(config: ImapConfig) -> tuple[str, int]:
@@ -276,7 +284,75 @@ def _unquote_imap_token(value: str) -> str:
return value return value
def _extract_mailbox_name(list_response_line: bytes | str) -> tuple[str, set[str]] | None: def _encode_mailbox_name(name: str) -> str:
"""Encode a Unicode mailbox using RFC 3501 section 5.1.3 modified UTF-7."""
result: list[str] = []
pending: list[str] = []
def flush() -> None:
if pending:
encoded = base64.b64encode("".join(pending).encode("utf-16-be"))
result.append("&" + encoded.decode("ascii").rstrip("=").replace("/", ",") + "-")
pending.clear()
for char in name:
if " " <= char <= "~":
flush()
result.append("&-" if char == "&" else char)
else:
pending.append(char)
flush()
return "".join(result)
def _decode_mailbox_name(name: str, *, utf8_enabled: bool = False) -> str:
"""Decode mailbox names only, never message bodies or arbitrary IMAP text.
UTF8=ACCEPT changes mailbox names to UTF-8 (RFC 6855 section 3); an
advertised capability alone does not activate that mode. Invalid provider
names fail explicitly rather than silently selecting a replacement name.
"""
if utf8_enabled:
return name
result: list[str] = []
position = 0
try:
name.encode("ascii")
while position < len(name):
if name[position] != "&":
result.append(name[position])
position += 1
continue
end = name.find("-", position + 1)
if end < 0:
raise ValueError("unterminated modified UTF-7 shift")
encoded = name[position + 1:end]
if not encoded:
result.append("&")
else:
if not re.fullmatch(r"[A-Za-z0-9+,]+", encoded):
raise ValueError("invalid modified UTF-7 alphabet")
raw = base64.b64decode(encoded.replace(",", "/") + "=" * (-len(encoded) % 4), validate=True)
decoded = raw.decode("utf-16-be")
if any(" " <= char <= "~" for char in decoded):
raise ValueError("modified UTF-7 encodes a printable ASCII character")
canonical = base64.b64encode(raw).decode("ascii").rstrip("=").replace("/", ",")
if canonical != encoded:
raise ValueError("non-canonical modified UTF-7 base64")
result.append(decoded)
position = end + 1
except (ValueError, UnicodeError, binascii.Error) as exc:
raise ImapAppendError("IMAP server returned an invalid mailbox name encoding", temporary=False) from exc
return "".join(result)
def _extract_wire_mailbox_name(
list_response_line: bytes | str | tuple[bytes, bytes] | None,
*,
utf8_enabled: bool = False,
) -> tuple[str, set[str]] | None:
r"""Best-effort parser for IMAP LIST response lines. r"""Best-effort parser for IMAP LIST response lines.
RFC 3501 LIST responses contain attributes, hierarchy delimiter, then mailbox RFC 3501 LIST responses contain attributes, hierarchy delimiter, then mailbox
@@ -292,7 +368,18 @@ def _extract_mailbox_name(list_response_line: bytes | str) -> tuple[str, set[str
blindly taking the last quoted value. blindly taking the last quoted value.
""" """
line = _decode_item(list_response_line).strip() if list_response_line is None:
return None
literal = None
if isinstance(list_response_line, tuple):
list_response_line, literal = list_response_line
try:
line = (
list_response_line.decode("utf-8" if utf8_enabled else "ascii")
if isinstance(list_response_line, bytes) else list_response_line
).strip()
except UnicodeError as exc:
raise ImapAppendError("IMAP server returned an invalid mailbox name encoding", temporary=False) from exc
match = re.match( match = re.match(
r'^\((?P<flags>[^)]*)\)\s+' r'^\((?P<flags>[^)]*)\)\s+'
r'(?P<delimiter>"(?:[^"\\]|\\.)*"|NIL|[^\s]+)\s+' r'(?P<delimiter>"(?:[^"\\]|\\.)*"|NIL|[^\s]+)\s+'
@@ -303,6 +390,14 @@ def _extract_mailbox_name(list_response_line: bytes | str) -> tuple[str, set[str
if match: if match:
flags = {part.lower() for part in match.group("flags").split()} flags = {part.lower() for part in match.group("flags").split()}
mailbox = _unquote_imap_token(match.group("mailbox")) mailbox = _unquote_imap_token(match.group("mailbox"))
if literal is not None:
literal_size = re.fullmatch(r"\{(\d+)\+?\}", match.group("mailbox"))
if not literal_size or int(literal_size.group(1)) != len(literal):
raise ImapAppendError("IMAP server returned an invalid mailbox name literal", temporary=False)
try:
mailbox = literal.decode("utf-8" if utf8_enabled else "ascii")
except UnicodeError as exc:
raise ImapAppendError("IMAP server returned an invalid mailbox name encoding", temporary=False) from exc
if mailbox: if mailbox:
return mailbox, flags return mailbox, flags
return None return None
@@ -318,6 +413,38 @@ def _extract_mailbox_name(list_response_line: bytes | str) -> tuple[str, set[str
return None return None
def _extract_mailbox_name(
list_response_line: bytes | str | tuple[bytes, bytes] | None,
*,
utf8_enabled: bool = False,
) -> tuple[str, set[str]] | None:
extracted = _extract_wire_mailbox_name(list_response_line, utf8_enabled=utf8_enabled)
if extracted is None:
return None
name, flags = extracted
return _decode_mailbox_name(name, utf8_enabled=utf8_enabled), flags
def _parsed_mailbox_listing(client: imaplib.IMAP4, data: list[Any]) -> list[tuple[str, set[str]]]:
utf8_enabled = getattr(client, "utf8_enabled", False) is True
wire_names: dict[str, str] = {}
parsed: list[tuple[str, set[str]]] = []
for item in data:
extracted = _extract_wire_mailbox_name(item, utf8_enabled=utf8_enabled)
if extracted is None:
continue
wire_name, flags = extracted
name = _decode_mailbox_name(wire_name, utf8_enabled=utf8_enabled)
if name in wire_names and wire_names[name] != wire_name:
raise ImapAppendError("IMAP server returned ambiguous mailbox name encodings", temporary=False)
wire_names[name] = wire_name
parsed.append((name, flags))
# Connection-local only: never reuse names across users, profiles or modes.
client._govoplan_mailbox_names = wire_names # type: ignore[attr-defined]
client._govoplan_mailbox_names_utf8 = utf8_enabled # type: ignore[attr-defined]
return parsed
_STANDARD_FOLDER_FLAGS: dict[str, tuple[str, ...]] = { _STANDARD_FOLDER_FLAGS: dict[str, tuple[str, ...]] = {
"inbox": ("\\inbox",), "inbox": ("\\inbox",),
"sent": ("\\sent", "\\sentmail"), "sent": ("\\sent", "\\sentmail"),
@@ -366,13 +493,7 @@ def discover_sent_folder(client: imaplib.IMAP4) -> str | None:
if typ != "OK" or not data: if typ != "OK" or not data:
return None return None
parsed: list[tuple[str, set[str]]] = [] return _detect_sent_folder(_parsed_mailbox_listing(client, data))
for item in data:
extracted = _extract_mailbox_name(item)
if extracted:
parsed.append(extracted)
return _detect_sent_folder(parsed)
def _effective_sent_folder(*, config: ImapConfig, requested_folder: str | None, client: imaplib.IMAP4) -> str: def _effective_sent_folder(*, config: ImapConfig, requested_folder: str | None, client: imaplib.IMAP4) -> str:
@@ -452,14 +573,9 @@ def _list_imap_folders_on_client(
if typ != "OK": if typ != "OK":
raise ImapAppendError(f"IMAP folder listing failed: {data!r}", temporary=True) raise ImapAppendError(f"IMAP folder listing failed: {data!r}", temporary=True)
parsed: list[tuple[str, set[str]]] = [] parsed = _parsed_mailbox_listing(client, data or [])
folders: list[ImapMailboxInfo] = [] folders: list[ImapMailboxInfo] = []
for item in data or []: for name, flags in parsed:
extracted = _extract_mailbox_name(item)
if not extracted:
continue
name, flags = extracted
parsed.append((name, flags))
message_count, unseen_count = ( message_count, unseen_count = (
(None, None) (None, None)
if not include_status or _has_folder_flag(flags, "noselect") if not include_status or _has_folder_flag(flags, "noselect")
@@ -622,13 +738,40 @@ def _has_folder_flag(flags: set[str], flag: str) -> bool:
return any(item.casefold().lstrip("\\") == wanted for item in flags) return any(item.casefold().lstrip("\\") == wanted for item in flags)
def _quote_mailbox_name(name: str) -> str: def _quote_mailbox_name(name: str, *, client: imaplib.IMAP4 | None = None) -> str:
return "\"" + name.replace("\\", "\\\\").replace("\"", "\\\"") + "\"" if any(ord(char) < 32 or 127 <= ord(char) <= 159 or char in "\u2028\u2029" for char in name):
raise ImapConfigurationError("IMAP mailbox names must not contain control characters")
utf8_enabled = getattr(client, "utf8_enabled", False) is True
wire_names = getattr(client, "_govoplan_mailbox_names", None)
if getattr(client, "_govoplan_mailbox_names_utf8", None) is not utf8_enabled:
wire_names = None
if (
client is not None
and not utf8_enabled
and wire_names is None
and name.isascii()
and re.search(r"&[A-Za-z0-9+,]*-", name)
):
# Older configurations saved LIST's wire representation. Resolve those
# against this authenticated connection, without guessing or rewriting
# configuration. A genuine literal name always wins an ambiguous alias.
typ, data = client.list()
if typ != "OK":
raise ImapAppendError("IMAP folder listing failed while resolving a saved folder name", temporary=True)
_parsed_mailbox_listing(client, data or [])
wire_names = client._govoplan_mailbox_names # type: ignore[attr-defined]
if isinstance(wire_names, dict) and name in wire_names:
wire_name = wire_names[name]
elif not utf8_enabled and isinstance(wire_names, dict) and name in wire_names.values():
wire_name = name
else:
wire_name = name if utf8_enabled else _encode_mailbox_name(name)
return "\"" + wire_name.replace("\\", "\\\\").replace("\"", "\\\"") + "\""
def _imap_folder_status(client: imaplib.IMAP4, folder: str) -> tuple[int | None, int | None]: def _imap_folder_status(client: imaplib.IMAP4, folder: str) -> tuple[int | None, int | None]:
try: try:
typ, data = client.status(_quote_mailbox_name(folder), "(MESSAGES UNSEEN)") typ, data = client.status(_quote_mailbox_name(folder, client=client), "(MESSAGES UNSEEN)")
except Exception: except Exception:
return None, None return None, None
if typ != "OK": if typ != "OK":
@@ -787,7 +930,7 @@ def _parse_fetch_parts_with_sequence(data: list[Any] | tuple[Any, ...] | None) -
def _select_readonly(client: imaplib.IMAP4, folder: str) -> tuple[int, str | None]: def _select_readonly(client: imaplib.IMAP4, folder: str) -> tuple[int, str | None]:
typ, data = client.select(_quote_mailbox_name(folder), readonly=True) typ, data = client.select(_quote_mailbox_name(folder, client=client), readonly=True)
if typ != "OK": if typ != "OK":
raise ImapAppendError(f"IMAP folder {folder!r} could not be opened read-only: {data!r}", temporary=False) raise ImapAppendError(f"IMAP folder {folder!r} could not be opened read-only: {data!r}", temporary=False)
selected_count = _decode_item(data[0] if data else None).strip() selected_count = _decode_item(data[0] if data else None).strip()
@@ -1253,69 +1396,231 @@ def list_imap_uids_since(
_log_imap_cleanup_failure("listing watcher UIDs", cleanup_exc) _log_imap_cleanup_failure("listing watcher UIDs", cleanup_exc)
def _batch_env_int(name: str, default: int, *, minimum: int, maximum: int) -> int:
try:
value = int(os.environ.get(name, str(default)))
except ValueError:
return default
return min(maximum, max(minimum, value))
@dataclass(frozen=True, slots=True)
class ImapBatchPolicy:
reuse_connections: bool = True
max_messages_per_connection: int = 100
max_connection_age_seconds: int = 300
idle_health_check_seconds: int = 30
reconnect_attempts: int = 1
@classmethod
def from_environment(cls) -> ImapBatchPolicy:
return cls(
reuse_connections=os.environ.get("GOVOPLAN_IMAP_BATCH_REUSE", "true").strip().lower()
not in {"0", "false", "no", "off"},
max_messages_per_connection=_batch_env_int(
"GOVOPLAN_IMAP_BATCH_MAX_MESSAGES", 100, minimum=1, maximum=10000,
),
max_connection_age_seconds=_batch_env_int(
"GOVOPLAN_IMAP_BATCH_MAX_AGE_SECONDS", 300, minimum=1, maximum=3600,
),
idle_health_check_seconds=_batch_env_int(
"GOVOPLAN_IMAP_BATCH_IDLE_HEALTH_CHECK_SECONDS", 30, minimum=0, maximum=3600,
),
reconnect_attempts=_batch_env_int(
"GOVOPLAN_IMAP_BATCH_RECONNECT_ATTEMPTS", 1, minimum=0, maximum=5,
),
)
class ImapBatchSession:
"""A bounded, sequential transport session, never an APPEND retry queue.
Callers must authorize every message before invoking append. A failed APPEND
is never replayed here, even when the next independent message reconnects.
Folder discovery and its original wire names belong to this connection only.
"""
def __init__(self, imap_config: ImapConfig, *, policy: ImapBatchPolicy | None = None):
self._host, self._port = _require_imap_config(imap_config)
self._config = imap_config.model_copy(deep=True)
self.policy = policy or ImapBatchPolicy.from_environment()
self._client: imaplib.IMAP4 | None = None
self._mock_connected = False
self._closed = False
self._in_use = Lock()
self._connection_count = 0
self._connection_attempt_count = 0
self._messages_on_connection = 0
self._opened_at = 0.0
self._last_used_at = 0.0
self._folders: dict[str | None, tuple[str, str | bytes]] = {}
@property
def connection_count(self) -> int:
return self._connection_count
@property
def reconnect_count(self) -> int:
return max(0, self._connection_attempt_count - 1)
def matches_config(self, config: ImapConfig) -> bool:
return config == self._config
def __enter__(self) -> ImapBatchSession:
if self._closed:
raise ImapConfigurationError("The IMAP batch session is closed")
return self
def __exit__(self, *_args: Any) -> None:
self.close()
def _disconnect(self) -> None:
client, self._client = self._client, None
self._mock_connected = False
self._folders.clear()
self._messages_on_connection = 0
if client is not None:
try:
client.logout()
except Exception as exc:
_log_imap_cleanup_failure("closing append batch", exc)
try:
# IMAP close() closes the selected mailbox, not the socket.
client.shutdown()
except Exception as cleanup_exc:
_log_imap_cleanup_failure("shutting down append batch", cleanup_exc)
def close(self) -> None:
self._closed = True
self._disconnect()
@contextmanager
def _exclusive_append(self) -> Iterator[None]:
if not self._in_use.acquire(blocking=False):
raise ImapConfigurationError("An IMAP batch only supports sequential APPENDs")
try:
if self._closed:
raise ImapConfigurationError("The IMAP batch session is closed")
yield
finally:
self._in_use.release()
def _prepare_connection(self) -> None:
now = time.monotonic()
if self._client is not None or self._mock_connected:
if (
not self.policy.reuse_connections
or self._messages_on_connection >= self.policy.max_messages_per_connection
or now - self._opened_at >= self.policy.max_connection_age_seconds
):
self._disconnect()
elif self._client is not None and now - self._last_used_at >= self.policy.idle_health_check_seconds:
try:
typ, _data = self._client.noop()
if typ != "OK":
self._disconnect()
except (OSError, imaplib.IMAP4.error):
self._disconnect()
if self._client is not None or self._mock_connected:
return
for attempt in range(self.policy.reconnect_attempts + 1):
self._connection_attempt_count += 1
try:
if is_mock_imap_host(self._config.host):
self._mock_connected = True
else:
self._client = _open_imap(self._config)
self._connection_count += 1
self._opened_at = self._last_used_at = time.monotonic()
return
except (OSError, imaplib.IMAP4.abort):
# Connecting/authenticating has not issued APPEND. Never retry
# an authentication rejection or any error from APPEND itself.
if attempt >= self.policy.reconnect_attempts:
raise
def append(self, message_bytes: bytes, *, folder: str | None = None) -> ImapAppendResult:
with self._exclusive_append():
return self._append(message_bytes, folder=folder)
def _append(self, message_bytes: bytes, *, folder: str | None) -> ImapAppendResult:
append_started = False
try:
self._prepare_connection()
reused = self._messages_on_connection > 0
if self._mock_connected:
if consume_fail_next_imap():
raise ImapAppendError("Mock IMAP configured to fail the next append", temporary=False)
target_folder = folder or (
self._config.sent_folder if self._config.sent_folder != "auto" else "Sent"
) or "Sent"
record = record_imap_append(message_bytes, folder=target_folder, imap_host=self._config.host)
response = f"mock append stored as {record.id}"
else:
client = self._client
assert client is not None
if folder not in self._folders:
target_folder = _effective_sent_folder(
config=self._config, requested_folder=folder, client=client,
)
self._folders[folder] = (target_folder, _quote_mailbox_name(target_folder, client=client))
target_folder, mailbox_argument = self._folders[folder]
internal_date = imaplib.Time2Internaldate(time.time())
append_started = True
typ, data = client.append(mailbox_argument, "\\Seen", internal_date, message_bytes)
if typ != "OK":
raise ImapAppendError(
f"IMAP APPEND failed for folder {target_folder!r}: {data!r}", temporary=False,
)
response = "; ".join(_decode_item(item) for item in (data or [])) or None
self._messages_on_connection += 1
self._last_used_at = time.monotonic()
return ImapAppendResult(
host=self._host,
port=self._port,
security=self._config.security.value,
folder=target_folder,
bytes_appended=len(message_bytes),
response=response,
connection_sequence=self.connection_count,
session_reused=reused,
reconnect_count=self.reconnect_count,
)
except (ImapAppendError, ImapConfigurationError):
self._disconnect()
raise
except (OSError, socket.timeout, imaplib.IMAP4.abort) as exc:
self._disconnect()
raise ImapAppendError(
f"IMAP append failed: {exc}", temporary=not append_started, outcome_unknown=append_started,
) from exc
except imaplib.IMAP4.error as exc:
self._disconnect()
raise ImapAppendError(
f"IMAP append failed: {exc}", temporary=False, outcome_unknown=append_started,
) from exc
except Exception:
self._disconnect()
raise
def append_message_to_sent( def append_message_to_sent(
message_bytes: bytes, message_bytes: bytes,
*, *,
imap_config: ImapConfig, imap_config: ImapConfig,
folder: str | None = None, folder: str | None = None,
batch_session: ImapBatchSession | None = None,
) -> ImapAppendResult: ) -> ImapAppendResult:
"""Append a sent MIME message to the configured IMAP Sent folder. """APPEND one MIME message; SMTP remains authoritative and independent.
The SMTP send remains authoritative. APPEND is a separate best-effort step An explicitly scoped batch may reuse its authenticated connection. Neither
and should not be used to decide whether an email was sent. mode retries an APPEND after transmission has started.
""" """
if batch_session is not None:
host, port = _require_imap_config(imap_config) if not batch_session.matches_config(imap_config):
if is_mock_imap_host(imap_config.host): raise ImapConfigurationError("The IMAP batch configuration does not match this message")
if consume_fail_next_imap(): return batch_session.append(message_bytes, folder=folder)
raise ImapAppendError("Mock IMAP configured to fail the next append", temporary=False) with ImapBatchSession(
target_folder = folder or (imap_config.sent_folder if imap_config.sent_folder and imap_config.sent_folder != "auto" else "Sent") imap_config, policy=ImapBatchPolicy(reuse_connections=False, reconnect_attempts=0),
record = record_imap_append(message_bytes, folder=target_folder, imap_host=imap_config.host) ) as single:
return ImapAppendResult( return single.append(message_bytes, folder=folder)
host=host,
port=port,
security=imap_config.security.value,
folder=target_folder,
bytes_appended=len(message_bytes),
response=f"mock append stored as {record.id}",
)
client: imaplib.IMAP4 | None = None
append_started = False
try:
client = _open_imap(imap_config)
target_folder = _effective_sent_folder(config=imap_config, requested_folder=folder, client=client)
internal_date = imaplib.Time2Internaldate(time.time())
append_started = True
typ, data = client.append(_quote_mailbox_name(target_folder), "\\Seen", internal_date, message_bytes)
if typ != "OK":
raise ImapAppendError(f"IMAP APPEND failed for folder {target_folder!r}: {data!r}", temporary=False)
response = "; ".join(_decode_item(item) for item in (data or [])) or None
return ImapAppendResult(
host=host,
port=port,
security=imap_config.security.value,
folder=target_folder,
bytes_appended=len(message_bytes),
response=response,
)
except ImapAppendError:
raise
except (OSError, socket.timeout, imaplib.IMAP4.abort) as exc:
raise ImapAppendError(
f"IMAP append failed: {exc}",
temporary=not append_started,
outcome_unknown=append_started,
) from exc
except imaplib.IMAP4.error as exc:
raise ImapAppendError(
f"IMAP append failed: {exc}",
temporary=False,
outcome_unknown=append_started,
) from exc
finally:
if client is not None:
try:
client.logout()
except Exception as cleanup_exc:
_log_imap_cleanup_failure("appending sent message", cleanup_exc)
+233
View File
@@ -0,0 +1,233 @@
"""Batch transport reuse must never become an authorization or evidence cache."""
from __future__ import annotations
import imaplib
from dataclasses import asdict
from types import SimpleNamespace
from unittest.mock import Mock, patch
import pytest
from govoplan_core.security.credential_envelopes import CredentialEnvelope
from govoplan_mail.backend import capabilities, server_hierarchy
from govoplan_mail.backend.db.models import MailProfilePolicy, MailServerEndpoint
from govoplan_mail.backend.mail_profiles import MailProfileError
from govoplan_mail.backend.sending import imap as transport
from govoplan_mail.backend.sending.imap import ImapAppendError, ImapConfigurationError
from test_campaign_protocol_authorization import hierarchy, imap_args # noqa: F401
def client():
return SimpleNamespace(
utf8_enabled=False,
append=Mock(return_value=("OK", [b"provider internal secret response"])),
logout=Mock(return_value=("BYE", [])),
noop=Mock(return_value=("OK", [])),
)
def recovery():
return SimpleNamespace(replayed=False, succeed_imap=Mock(), reject=Mock(), unknown=Mock())
def test_reuses_transport_but_decrypts_and_authorizes_each_message_and_records_each_effect(hierarchy):
connection = client()
effects = [recovery(), recovery()]
with (
patch.object(transport, "_open_imap", return_value=connection) as open_connection,
patch.object(capabilities, "begin_provider_effect_recovery", side_effect=effects) as begin,
patch.object(capabilities, "_authorized_campaign_profile", wraps=capabilities._authorized_campaign_profile) as authorize,
patch.object(capabilities, "assert_mail_policy_allows_send", wraps=capabilities.assert_mail_policy_allows_send) as policy,
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1") as batch,
):
assert batch.connection_count == 0
open_connection.assert_not_called()
results = [capabilities.append_campaign_message_to_sent(
hierarchy.session, **imap_args(message_bytes=f"message-{index}".encode(), recovery_effect_id=f"effect-{index}"),
) for index in range(2)]
assert batch.connection_count == 1
assert batch.reconnect_count == 0
assert authorize.call_count == policy.call_count == 2
assert [call.kwargs["credential_id"] for call in decrypt.call_args_list] == ["imap-credential"] * 2
assert [call.kwargs["effect_id"] for call in begin.call_args_list] == ["effect-0", "effect-1"]
assert [item.session_reused for item in results] == [False, True]
assert [item.connection_sequence for item in results] == [1, 1]
assert "secret" not in repr([asdict(item) for item in results])
assert "imap.example" not in repr(results)
open_connection.assert_called_once()
connection.logout.assert_called_once()
for effect in effects:
effect.succeed_imap.assert_called_once_with(folder="Sent")
effect.reject.assert_not_called()
effect.unknown.assert_not_called()
@pytest.mark.parametrize("change", ["credential_revoked", "smtp_revision_changed", "imap_revision_changed"])
def test_next_message_rechecks_current_authority_and_frozen_revisions_before_decryption(hierarchy, change):
connection = client()
with (
patch.object(transport, "_open_imap", return_value=connection),
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
if change == "credential_revoked":
hierarchy.session.get(CredentialEnvelope, "imap-credential").is_active = False
else:
protocol = change.split("_")[0]
hierarchy.session.get(MailServerEndpoint, f"{protocol}-server").transport_revision = "changed"
hierarchy.session.commit()
with pytest.raises(MailProfileError):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(message_bytes=b"blocked"))
assert decrypt.call_count == 1
connection.append.assert_called_once()
def test_effective_credential_policy_is_not_cached_by_warm_batch(hierarchy):
for scope in ("system", "tenant"):
hierarchy.session.get(MailProfilePolicy, f"{scope}-policy").policy = {
"smtp_credentials": {"inherit": False}, "imap_credentials": {"inherit": True},
}
hierarchy.session.commit()
connection = client()
with (
patch.object(transport, "_open_imap", return_value=connection),
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(imap_credential_id=None))
hierarchy.session.get(MailProfilePolicy, "tenant-policy").policy = {
"imap_credentials": {"inherit": False},
}
hierarchy.session.commit()
with pytest.raises(MailProfileError, match="explicit credential"):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(imap_credential_id=None))
assert decrypt.call_count == 1
connection.append.assert_called_once()
def test_copying_context_to_a_worker_cannot_share_the_batch_connection(hierarchy):
from concurrent.futures import ThreadPoolExecutor
from contextvars import copy_context
with (
patch.object(capabilities, "_authorized_campaign_profile") as authorize,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
ThreadPoolExecutor(max_workers=1) as executor,
):
future = executor.submit(copy_context().run, capabilities.append_campaign_message_to_sent, hierarchy.session, **imap_args())
with pytest.raises(ImapConfigurationError, match="scope"):
future.result(timeout=5)
authorize.assert_not_called()
@pytest.mark.parametrize("scope", [{"tenant_id": "other"}, {"campaign_id": "other"}])
def test_cross_scope_batch_is_rejected_before_authorization_decryption_evidence_or_network(hierarchy, scope):
with (
patch.object(capabilities, "_authorized_campaign_profile") as authorize,
patch.object(capabilities, "begin_provider_effect_recovery") as begin,
patch.object(transport, "_open_imap") as open_connection,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
pytest.raises(ImapConfigurationError, match="scope"),
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(**scope))
authorize.assert_not_called()
begin.assert_not_called()
open_connection.assert_not_called()
def test_changed_resolved_secret_does_not_reuse_previous_authenticated_connection(hierarchy):
from govoplan_core.security.secrets import encrypt_secret
connections = [client(), client()]
with (
patch.object(transport, "_open_imap", side_effect=connections) as open_connection,
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1") as batch,
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
hierarchy.session.get(CredentialEnvelope, "imap-credential").secret_data_encrypted = encrypt_secret('{"password":"new fake password"}')
hierarchy.session.commit()
result = capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(message_bytes=b"new credential"))
assert batch.connection_count == result.connection_sequence == 2
assert not result.session_reused
assert open_connection.call_count == 2
assert open_connection.call_args_list[0].args[0].password != open_connection.call_args_list[1].args[0].password
for connection in connections:
connection.logout.assert_called_once()
connection.append.assert_called_once()
def test_nested_context_restores_outer_connection_and_always_cleans_up(hierarchy):
outer_client, inner_client = client(), client()
with patch.object(transport, "_open_imap", side_effect=[outer_client, inner_client]) as open_connection:
with capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1") as outer:
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
with pytest.raises(ValueError, match="caller"):
with capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
raise ValueError("caller failure")
inner_client.logout.assert_called_once()
assert capabilities._ACTIVE_IMAP_BATCH.get() is outer
result = capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
assert result.session_reused
assert capabilities._ACTIVE_IMAP_BATCH.get() is None
assert open_connection.call_count == 2
assert outer_client.append.call_count == 2
outer_client.logout.assert_called_once()
def test_known_success_evidence_does_not_replay_even_with_warm_connection(hierarchy):
connection = client()
first, replayed = recovery(), recovery()
replayed.replayed = True
with (
patch.object(transport, "_open_imap", return_value=connection),
patch.object(capabilities, "begin_provider_effect_recovery", side_effect=[first, replayed]),
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(recovery_effect_id="same-effect"))
with pytest.raises(ImapAppendError, match="already succeeded") as caught:
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(recovery_effect_id="same-effect"))
assert caught.value.outcome_unknown
connection.append.assert_called_once()
replayed.succeed_imap.assert_not_called()
def test_ambiguous_effect_is_recorded_once_sanitized_and_never_replayed(hierarchy):
connection = client()
connection.append.side_effect = imaplib.IMAP4.abort("provider host and secret")
effect = recovery()
with (
patch.object(transport, "_open_imap", return_value=connection) as open_connection,
patch.object(capabilities, "begin_provider_effect_recovery", return_value=effect),
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
pytest.raises(ImapAppendError) as caught,
):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(recovery_effect_id="effect-1"))
assert caught.value.outcome_unknown
assert "secret" not in str(caught.value)
assert "secret" not in repr(effect.unknown.call_args)
effect.unknown.assert_called_once()
effect.succeed_imap.assert_not_called()
effect.reject.assert_not_called()
open_connection.assert_called_once()
connection.append.assert_called_once()
connection.logout.assert_called_once()
def test_evidence_finalization_failure_closes_batch_and_prevents_further_effects(hierarchy):
connection = client()
effect = recovery()
effect.succeed_imap.side_effect = OSError("evidence store unavailable")
with (
patch.object(transport, "_open_imap", return_value=connection),
patch.object(capabilities, "begin_provider_effect_recovery", return_value=effect),
capabilities.campaign_imap_batch(tenant_id="tenant-1", campaign_id="campaign-1"),
):
with pytest.raises(ImapAppendError) as caught:
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(recovery_effect_id="effect-1"))
assert caught.value.outcome_unknown
with pytest.raises(ImapConfigurationError):
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(message_bytes=b"must not run"))
connection.append.assert_called_once()
connection.logout.assert_called_once()
@@ -0,0 +1,187 @@
"""Real stored hierarchy and policy; provider calls are replaced, never live."""
from __future__ import annotations
import json
from types import SimpleNamespace
from unittest.mock import Mock, patch
import pytest
from sqlalchemy import Column, String, Table, create_engine
from sqlalchemy.orm import Session
from govoplan_core.admin.models import SystemSettings
from govoplan_core.core.campaigns import CampaignMailPolicyContext
from govoplan_core.db.base import Base
from govoplan_core.security.credential_envelopes import CredentialEnvelope
from govoplan_core.security.secrets import encrypt_secret
from govoplan_core.tenancy.scope import Tenant
from govoplan_mail.backend import capabilities, mail_profiles, server_hierarchy
from govoplan_mail.backend.db.models import MailProfilePolicy, MailServerCredentialBinding, MailServerEndpoint, MailServerProfile
from govoplan_mail.backend.sending import smtp as smtp_module
@pytest.fixture
def hierarchy(tmp_path):
engine = create_engine(f"sqlite+pysqlite:///{tmp_path / 'smtp-policy.db'}")
if "access_users" not in Base.metadata.tables:
Table("access_users", Base.metadata, Column("id", String(36), primary_key=True))
for table in (Base.metadata.tables["access_users"], SystemSettings.__table__, Tenant.__table__,
CredentialEnvelope.__table__, MailServerProfile.__table__, MailServerEndpoint.__table__,
MailServerCredentialBinding.__table__, MailProfilePolicy.__table__):
table.create(engine)
with Session(engine) as session:
session.add(SystemSettings(id="global", settings={}))
session.add(Tenant(id="tenant-1", slug="test", name="Test", settings={}))
profile = MailServerProfile(id="profile-1", tenant_id="tenant-1", scope_type="tenant", scope_id="tenant-1", name="Test mail", slug="test",
smtp_config={"host": "smtp.example.test", "port": 587, "security": "starttls"},
imap_config={"host": "imap.example.test", "port": 993, "security": "tls"},
smtp_transport_revision="smtp-current", imap_transport_revision="imap-current", inherit_to_lower_scopes=True)
session.add(profile)
for protocol, port in (("smtp", 587), ("imap", 993)):
server = MailServerEndpoint(id=f"{protocol}-server", profile_id=profile.id, tenant_id="tenant-1", protocol=protocol,
name=protocol, scope_type="tenant", scope_id="tenant-1", inherit_to_lower_scopes=True,
is_default=True, is_active=True, transport_revision=f"{protocol}-current",
config={"host": f"{protocol}.example.test", "port": port, "security": "starttls" if protocol == "smtp" else "tls"})
credential = CredentialEnvelope(id=f"{protocol}-credential", tenant_id="tenant-1", scope_type="tenant", scope_id="tenant-1",
name=protocol, credential_kind="username_password", public_data={"username": f"{protocol}-user"},
secret_data_encrypted=encrypt_secret(json.dumps({"password": f"fake-{protocol}-password"})), secret_keys=["password"],
allowed_modules=["mail"], allowed_server_refs=[f"mail:{protocol}-server"], inherit_to_lower_scopes=True, is_active=True)
session.add_all([server, credential, MailServerCredentialBinding(id=f"{protocol}-binding", server_id=server.id,
credential_id=credential.id, is_default=True)])
for scope in ("system", "tenant"):
session.add(MailProfilePolicy(id=f"{scope}-policy", tenant_id=None if scope == "system" else "tenant-1",
scope_type=scope, scope_id=None if scope == "system" else "tenant-1",
policy={"smtp_credentials": {"inherit": False}, "imap_credentials": {"inherit": False}}))
session.commit()
context = CampaignMailPolicyContext(id="campaign-1", tenant_id="tenant-1")
provider = SimpleNamespace(get_campaign_mail_policy_context=lambda *_args, **_kwargs: context)
# Only the optional Campaign context provider and external I/O are mocked.
# Profiles, policy inheritance, endpoint/credential ACLs and decryption are real.
with patch.object(mail_profiles, "_campaign_policy_provider", return_value=provider), \
patch("socket.create_connection", side_effect=AssertionError("No live network in regression tests")):
yield SimpleNamespace(session=session, profile=profile, context=context)
engine.dispose()
def smtp_args(**overrides):
return {"tenant_id": "tenant-1", "campaign_id": "campaign-1", "profile_id": "profile-1",
"envelope_from": "sender@example.test", "envelope_recipients": ["recipient@example.test"], "from_header": "sender@example.test",
"expected_smtp_transport_revision": "smtp-current", "smtp_server_id": "smtp-server", "smtp_credential_id": "smtp-credential", **overrides}
def selection():
return {"smtp_server_id": "smtp-server", "smtp_credential_id": "smtp-credential", "imap_server_id": "imap-server", "imap_credential_id": "imap-credential"}
def test_smtp_batch_accepts_explicit_smtp_when_other_protocol_requires_explicit_selection(hierarchy):
# The full frozen selection is valid; runtime SMTP deliberately carries only SMTP.
summary = capabilities.campaign_profile_delivery_summary(hierarchy.session, tenant_id="tenant-1", campaign_id="campaign-1", profile_id="profile-1", **selection())
assert summary["smtp_available"] and summary["imap_available"]
fake_connection = Mock()
with patch.object(smtp_module, "_open_smtp", return_value=fake_connection) as opener, \
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt:
with capabilities.campaign_smtp_batch(hierarchy.session, **smtp_args()) as batch:
assert batch.status == "ready"
assert batch.connection_count == 1
assert [call.kwargs["credential_id"] for call in decrypt.call_args_list] == ["smtp-credential"]
assert opener.call_args.args[0].username == "smtp-user"
fake_connection.sendmail.assert_not_called()
fake_connection.send_message.assert_not_called()
def test_smtp_single_uses_same_selected_protocol_authorization(hierarchy):
result = SimpleNamespace(envelope_recipients=["recipient@example.test"], refused_recipients={})
with patch.object(capabilities, "send_email_bytes", return_value=result) as send, \
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt:
sent = capabilities.send_campaign_email_bytes(hierarchy.session, message_bytes=b"frozen test message", **smtp_args())
assert sent.accepted_count == 1
assert [call.kwargs["credential_id"] for call in decrypt.call_args_list] == ["smtp-credential"]
assert send.call_args.kwargs["smtp_config"].username == "smtp-user"
def imap_args(**overrides):
return {"tenant_id": "tenant-1", "campaign_id": "campaign-1", "profile_id": "profile-1",
"message_bytes": b"frozen test message", "folder": "Sent",
"expected_smtp_transport_revision": "smtp-current", "expected_imap_transport_revision": "imap-current",
# An IMAP-only call need not submit an unrelated SMTP credential.
"smtp_server_id": "smtp-server", "imap_server_id": "imap-server", "imap_credential_id": "imap-credential", **overrides}
def test_imap_append_checks_and_decrypts_only_selected_protocol(hierarchy):
with patch.object(capabilities, "append_message_to_sent", return_value=SimpleNamespace(folder="Sent")) as append, \
patch.object(server_hierarchy, "resolve_credential_envelope", wraps=server_hierarchy.resolve_credential_envelope) as decrypt:
result = capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args())
assert result.folder == "Sent"
assert [call.kwargs["credential_id"] for call in decrypt.call_args_list] == ["imap-credential"]
assert append.call_args.kwargs["imap_config"].username == "imap-user"
@pytest.mark.parametrize("operation", ["smtp_batch", "smtp_single", "imap_append", "imap_endpoint_only"])
def test_selected_protocol_still_requires_explicit_credentials_before_decryption_or_provider(hierarchy, operation):
if operation == "imap_endpoint_only":
hierarchy.profile.imap_config = None # Current endpoint exists without the legacy mirror.
hierarchy.session.commit()
with patch.object(server_hierarchy, "resolve_credential_envelope", side_effect=AssertionError("Policy must reject before decryption")) as decrypt, \
patch.object(smtp_module, "_open_smtp", side_effect=AssertionError("No network")) as opener, \
patch.object(capabilities, "send_email_bytes", side_effect=AssertionError("No SMTP")) as send, \
patch.object(capabilities, "append_message_to_sent", side_effect=AssertionError("No IMAP")) as append:
with pytest.raises(mail_profiles.MailProfileError, match=f"effective {'SMTP' if operation.startswith('smtp') else 'IMAP'}"):
if operation == "smtp_batch":
with capabilities.campaign_smtp_batch(hierarchy.session, **smtp_args(smtp_credential_id=None)): pass
elif operation == "smtp_single":
capabilities.send_campaign_email_bytes(hierarchy.session, message_bytes=b"test", **smtp_args(smtp_credential_id=None))
else:
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(imap_credential_id=None))
decrypt.assert_not_called(); opener.assert_not_called(); send.assert_not_called(); append.assert_not_called()
@pytest.mark.parametrize("operation", ["smtp_batch", "smtp_single", "imap_append"])
@pytest.mark.parametrize("mutation", ["stale_revision", "inactive_credential", "wrong_server", "wrong_tenant"])
def test_selected_transport_revision_and_credential_authority_remain_fail_closed(hierarchy, operation, mutation):
protocol = "smtp" if operation.startswith("smtp") else "imap"
overrides = {}
if mutation == "stale_revision":
overrides[f"expected_{protocol}_transport_revision"] = "stale-build-revision"
elif mutation == "wrong_server":
overrides[f"{protocol}_credential_id"] = "imap-credential" if protocol == "smtp" else "smtp-credential"
else:
credential = hierarchy.session.get(CredentialEnvelope, f"{protocol}-credential")
if mutation == "inactive_credential": credential.is_active = False
else: credential.tenant_id = "other-tenant"
hierarchy.session.commit()
with patch.object(server_hierarchy, "resolve_credential_envelope", side_effect=AssertionError("Reject stale/unauthorized before decrypt")) as decrypt, \
patch.object(smtp_module, "_open_smtp", side_effect=AssertionError("No network")) as opener, \
patch.object(capabilities, "send_email_bytes", side_effect=AssertionError("No SMTP")) as send, \
patch.object(capabilities, "append_message_to_sent", side_effect=AssertionError("No IMAP")) as append:
with pytest.raises(mail_profiles.MailProfileError):
if operation == "smtp_batch":
with capabilities.campaign_smtp_batch(hierarchy.session, **smtp_args(**overrides)): pass
elif operation == "smtp_single":
capabilities.send_campaign_email_bytes(hierarchy.session, message_bytes=b"test", **smtp_args(**overrides))
else:
capabilities.append_campaign_message_to_sent(hierarchy.session, **imap_args(**overrides))
decrypt.assert_not_called(); opener.assert_not_called(); send.assert_not_called(); append.assert_not_called()
@pytest.mark.parametrize("missing", ["smtp_credential_id", "imap_credential_id"])
def test_full_authoring_and_summary_still_check_both_protocols_without_decryption(hierarchy, missing):
complete = selection()
raw = {"server": {"mail_profile_id": "profile-1", **complete}}
mail_profiles.assert_campaign_mail_policy_allows_json(hierarchy.session, tenant_id="tenant-1", campaign_id="campaign-1", raw_json=raw)
incomplete = {**complete, missing: None}
with patch.object(server_hierarchy, "resolve_credential_envelope", side_effect=AssertionError("Summary must not decrypt")) as decrypt:
with pytest.raises(mail_profiles.MailProfileError, match="explicit credential selection"):
capabilities.campaign_profile_delivery_summary(hierarchy.session, tenant_id="tenant-1", campaign_id="campaign-1", profile_id="profile-1", **incomplete)
with pytest.raises(mail_profiles.MailProfileError, match="explicit credential selection"):
mail_profiles.assert_campaign_mail_policy_allows_json(hierarchy.session, tenant_id="tenant-1", campaign_id="campaign-1", raw_json={"server": {"mail_profile_id": "profile-1", **incomplete}})
decrypt.assert_not_called()
def test_batch_still_enforces_all_recipient_domains_before_connection(hierarchy):
row = hierarchy.session.get(MailProfilePolicy, "system-policy")
row.policy = {**row.policy, "blacklist": {"recipient_domains": ["blocked.example"]}}
hierarchy.session.commit()
with patch.object(smtp_module, "_open_smtp", side_effect=AssertionError("Forbidden recipient must never connect")) as opener:
with pytest.raises(mail_profiles.MailProfileError, match="effective Mail policy"):
with capabilities.campaign_smtp_batch(hierarchy.session, **smtp_args(envelope_recipients=["ok@example.test", "no@blocked.example"])): pass
opener.assert_not_called()
+22
View File
@@ -22,6 +22,7 @@ from govoplan_core.db.session import configure_database, reset_database
from govoplan_core.security.credential_envelopes import CredentialEnvelope from govoplan_core.security.credential_envelopes import CredentialEnvelope
from govoplan_mail.backend.configuration_provider import ( from govoplan_mail.backend.configuration_provider import (
MAIL_CONFIGURATION_CAPABILITY, MAIL_CONFIGURATION_CAPABILITY,
MAIL_INFRASTRUCTURE_DEPENDENCY_CAPABILITY,
SqlMailConfigurationProvider, SqlMailConfigurationProvider,
) )
from govoplan_mail.backend.db.models import ( from govoplan_mail.backend.db.models import (
@@ -168,9 +169,30 @@ class MailConfigurationProviderTests(unittest.TestCase):
def test_provider_is_registered_and_describes_receipt_bound_fragment(self) -> None: def test_provider_is_registered_and_describes_receipt_bound_fragment(self) -> None:
self.assertIn(MAIL_CONFIGURATION_CAPABILITY, manifest.capability_factories) self.assertIn(MAIL_CONFIGURATION_CAPABILITY, manifest.capability_factories)
self.assertIn(
MAIL_INFRASTRUCTURE_DEPENDENCY_CAPABILITY,
manifest.capability_factories,
)
description = self.provider.describe() description = self.provider.describe()
self.assertEqual(("smtp_profile",), description.fragment_types) self.assertEqual(("smtp_profile",), description.fragment_types)
def test_inventory_reports_actual_smtp_endpoint_and_credential_binding(self) -> None:
fragment = ConfigurationPackageFragment(
module_id="mail",
fragment_type="smtp_profile",
fragment_id="inventory-smtp",
payload={"credential_envelope_id": "credential-1"},
)
self.provider.apply(fragment, {}, self.context)
dependencies = self.provider.infrastructure_dependencies()
self.assertEqual(1, len(dependencies))
self.assertEqual("mail.smtp", dependencies[0].capability_id)
self.assertEqual("smtp_endpoint", dependencies[0].dependency_type)
self.assertEqual(1, dependencies[0].metrics["credential_binding_count"])
self.assertNotIn("test-mail", str(dependencies[0].to_dict()))
def test_apply_is_idempotent_and_binds_existing_credential_envelope(self) -> None: def test_apply_is_idempotent_and_binds_existing_credential_envelope(self) -> None:
fragment = ConfigurationPackageFragment( fragment = ConfigurationPackageFragment(
module_id="mail", module_id="mail",
+42 -1
View File
@@ -8,6 +8,7 @@ from sqlalchemy.orm import Session
from govoplan_core.core.modules import DocumentationContext from govoplan_core.core.modules import DocumentationContext
from govoplan_mail.backend.documentation import ( from govoplan_mail.backend.documentation import (
_credential_line,
documentation_configuration_states, documentation_configuration_states,
documentation_topics, documentation_topics,
) )
@@ -26,6 +27,46 @@ class _Principal:
class MailRuntimeDocumentationTests(unittest.TestCase): class MailRuntimeDocumentationTests(unittest.TestCase):
def test_mailbox_toolbar_contract_documents_context_refresh_and_read_only_bounds_in_both_languages(self) -> None:
from govoplan_mail.backend.manifest import manifest
topic = next(item for item in manifest.documentation if item.id == "mail.workflow.read-mailbox")
self.assertEqual(set(topic.documentation_types), {"user", "admin"})
self.assertTrue({"mail.mailbox.reload", "mail.mailbox.tools"}.issubset(topic.metadata["help_contexts"]))
for phrase in ("one right-aligned Reload", "Mailbox tools", "IMAP retains the current page", "JMAP starts a fresh cursor chain", "Failed refreshes preserve usable loaded data", "ignore late reads", "do not grant profile administration rights"):
self.assertIn(phrase, topic.body)
for phrase in ("genau einmal Neuladen rechts", "Postfachwerkzeuge", "IMAP behält die Seite", "JMAP beginnt", "Verspätete Antworten", "Fehlgeschlagene Aktualisierungen", "keine Profilverwaltungsrechte"):
self.assertIn(phrase, topic.translations["de"]["body"])
def test_imap_batch_contract_documents_bounds_and_per_message_safety_in_both_languages(self) -> None:
from govoplan_mail.backend.manifest import manifest
topic = next(item for item in manifest.documentation if item.id == "mail.reference.campaign-delivery-contract")
for body in (topic.body, topic.translations["de"]["body"]):
self.assertIn("campaign_imap_batch", body)
self.assertIn("GOVOPLAN_IMAP_BATCH_REUSE", body)
self.assertIn("MULTIAPPEND", body)
self.assertIn("100", body)
self.assertIn("300", body)
self.assertIn("permissions and recovery evidence are never cached", topic.body)
self.assertIn("no automatic APPEND replay", topic.body)
self.assertIn("Berechtigungen und Nachweise werden nicht zwischengespeichert", topic.translations["de"]["body"])
def test_campaign_contract_documents_protocol_scoped_runtime_and_complete_validation(self) -> None:
from govoplan_mail.backend.manifest import manifest
topic = next(item for item in manifest.documentation if item.id == "mail.reference.campaign-delivery-contract")
self.assertIn("Runtime credential-selection checks are protocol-scoped", topic.body)
self.assertIn("still check both configured protocols", topic.body)
self.assertIn("before credential decryption or provider contact", topic.body)
self.assertIn("protokollbezogen", topic.translations["de"]["body"])
self.assertIn("weiterhin beide konfigurierten Protokolle", topic.translations["de"]["body"])
def test_credential_policy_guidance_describes_explicit_mail_references_not_local_secrets(self) -> None:
text = _credential_line({"smtp_credentials": {"inherit": False}, "imap_credentials": {"inherit": True}})
self.assertIn("SMTP requires an explicit Mail credential", text)
self.assertIn("IMAP allows a profile default or explicit Mail credential", text)
self.assertIn("Secrets remain in Mail", text)
self.assertNotIn("local credentials", text)
self.assertNotIn("only for protocols that inherit", text)
def setUp(self) -> None: def setUp(self) -> None:
self.session = Session() self.session = Session()
@@ -182,7 +223,7 @@ class MailRuntimeDocumentationTests(unittest.TestCase):
topics = {topic.id: topic for topic in get_manifest().documentation} topics = {topic.id: topic for topic in get_manifest().documentation}
self.assertEqual(topics["mail.workflow.choose-and-test-profile"].metadata["help_contexts"], ["mail.profiles", "app.settings"]) self.assertEqual(topics["mail.workflow.choose-and-test-profile"].metadata["help_contexts"], ["mail.profiles", "app.settings"])
self.assertEqual(topics["mail.workflow.read-mailbox"].metadata["help_contexts"], ["mail.list", "mail.mailbox"]) self.assertEqual(topics["mail.workflow.read-mailbox"].metadata["help_contexts"], ["mail.list", "mail.mailbox", "mail.mailbox.reload", "mail.mailbox.tools"])
self.assertIn("mail.admin.profiles", topics["mail.profiles-and-policy"].metadata["help_contexts"]) self.assertIn("mail.admin.profiles", topics["mail.profiles-and-policy"].metadata["help_contexts"])
self.assertIn("mail.bounce-processing", topics["mail.bounce-processing"].metadata["help_contexts"]) self.assertIn("mail.bounce-processing", topics["mail.bounce-processing"].metadata["help_contexts"])
+231
View File
@@ -0,0 +1,231 @@
from __future__ import annotations
import imaplib
import unittest
from dataclasses import replace
from unittest.mock import Mock, patch
from govoplan_mail.backend.config import ImapConfig
from govoplan_mail.backend.sending.imap import (
ImapAppendError,
ImapBatchPolicy,
ImapBatchSession,
ImapConfigurationError,
append_message_to_sent,
)
class BatchClient:
utf8_enabled = False
def __init__(self, *, wire_folder=b"Gesendete &APw-bermittlung"):
self.login = Mock(return_value=("OK", []))
self.list = Mock(return_value=("OK", [b'(\\Sent) "/" "' + wire_folder + b'"']))
self.noop = Mock(return_value=("OK", []))
self.append = Mock(return_value=("OK", [b"APPEND complete"]))
self.logout = Mock(return_value=("BYE", []))
self.shutdown = Mock()
def config(**changes):
return ImapConfig(
host="imap.example.test", port=993, security="tls",
username="service", password="secret", sent_folder="auto",
).model_copy(update=changes)
class ImapBatchTests(unittest.TestCase):
def test_one_login_discovery_and_logout_for_many_sequential_appends(self):
client = BatchClient()
with (
patch("govoplan_mail.backend.sending.imap.validate_outbound_host"),
patch("govoplan_mail.backend.sending.imap._OutboundPolicyIMAP4SSL", return_value=client) as connect,
ImapBatchSession(config()) as batch,
):
results = [append_message_to_sent(bytes([i]), imap_config=config(), batch_session=batch) for i in range(50)]
self.assertEqual(batch.connection_count, 1)
self.assertEqual(batch.reconnect_count, 0)
client.logout.assert_not_called()
connect.assert_called_once()
client.login.assert_called_once_with("service", "secret")
client.list.assert_called_once()
client.noop.assert_not_called()
client.logout.assert_called_once()
self.assertEqual(client.append.call_count, 50)
self.assertEqual([call.args[3] for call in client.append.call_args_list], [bytes([i]) for i in range(50)])
self.assertEqual({call.args[0] for call in client.append.call_args_list}, {'"Gesendete &APw-bermittlung"'})
self.assertEqual({item.folder for item in results}, {"Gesendete übermittlung"})
self.assertEqual([item.session_reused for item in results], [False] + [True] * 49)
self.assertEqual({item.connection_sequence for item in results}, {1})
def test_count_rotation_rediscovers_original_wire_names_on_new_connection(self):
first = BatchClient(wire_folder=b"&U,BTFw-&ZeVnLIqe-")
second = BatchClient(wire_folder=b"&U,BTF2XlZyyKng-")
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=[first, second]) as connect,
ImapBatchSession(config(), policy=replace(ImapBatchPolicy(), max_messages_per_connection=2)) as batch,
):
results = [batch.append(b"message") for _ in range(3)]
self.assertEqual(connect.call_count, 2)
first.list.assert_called_once()
second.list.assert_called_once()
first.logout.assert_called_once()
second.logout.assert_called_once()
self.assertEqual([item.connection_sequence for item in results], [1, 1, 2])
self.assertEqual([item.session_reused for item in results], [False, True, False])
self.assertEqual(results[-1].reconnect_count, 1)
self.assertEqual(first.append.call_args.args[0], '"&U,BTFw-&ZeVnLIqe-"')
self.assertEqual(second.append.call_args.args[0], '"&U,BTF2XlZyyKng-"')
def test_age_rotation_is_checked_before_next_append(self):
clock = [0.0]
first, second = BatchClient(), BatchClient()
with (
patch("govoplan_mail.backend.sending.imap.time.monotonic", side_effect=lambda: clock[0]),
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=[first, second]),
ImapBatchSession(config(), policy=replace(ImapBatchPolicy(), max_connection_age_seconds=20)) as batch,
):
batch.append(b"one")
clock[0] = 20.0
self.assertFalse(batch.append(b"two").session_reused)
first.noop.assert_not_called()
self.assertEqual(first.append.call_count + second.append.call_count, 2)
def test_idle_probe_can_reconnect_before_append_without_replaying_prior_message(self):
clock = [0.0]
first, second = BatchClient(), BatchClient()
first.noop.side_effect = imaplib.IMAP4.abort("gone")
with (
patch("govoplan_mail.backend.sending.imap.time.monotonic", side_effect=lambda: clock[0]),
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=[first, second]),
ImapBatchSession(config()) as batch,
):
batch.append(b"one")
clock[0] = 31.0
result = batch.append(b"two")
first.noop.assert_called_once()
self.assertEqual(first.append.call_args.args[3], b"one")
self.assertEqual(second.append.call_args.args[3], b"two")
self.assertEqual(result.reconnect_count, 1)
def test_healthy_idle_probe_reuses_connection(self):
client = BatchClient()
with (
patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client),
ImapBatchSession(config(), policy=replace(ImapBatchPolicy(), idle_health_check_seconds=0)) as batch,
):
batch.append(b"one")
self.assertTrue(batch.append(b"two").session_reused)
client.noop.assert_called_once()
def test_only_pre_effect_connection_failures_are_retried(self):
client = BatchClient()
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=[OSError("offline"), client]) as connect,
ImapBatchSession(config()) as batch,
):
result = batch.append(b"one")
self.assertEqual(connect.call_count, 2)
client.append.assert_called_once()
self.assertEqual(result.reconnect_count, 1)
def test_pre_effect_reconnects_are_bounded_and_not_unknown(self):
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=OSError("offline")) as connect,
ImapBatchSession(config()) as batch,
self.assertRaises(ImapAppendError) as caught,
):
batch.append(b"one")
self.assertEqual(connect.call_count, 2)
self.assertTrue(caught.exception.temporary)
self.assertFalse(caught.exception.outcome_unknown)
def test_authentication_rejection_is_not_retried(self):
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=imaplib.IMAP4.error("bad login")) as connect,
ImapBatchSession(config()) as batch,
self.assertRaises(ImapAppendError) as caught,
):
batch.append(b"one")
connect.assert_called_once()
self.assertFalse(caught.exception.temporary)
self.assertFalse(caught.exception.outcome_unknown)
def test_ambiguous_append_is_never_replayed_and_connection_is_discarded(self):
first, second = BatchClient(), BatchClient()
first.append.side_effect = imaplib.IMAP4.abort("accepted but reply lost")
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=[first, second]) as connect,
ImapBatchSession(config()) as batch,
):
with self.assertRaises(ImapAppendError) as caught:
batch.append(b"uncertain")
self.assertTrue(caught.exception.outcome_unknown)
self.assertFalse(caught.exception.temporary)
self.assertEqual(connect.call_count, 1)
first.logout.assert_called_once()
batch.append(b"different independently claimed message")
first.append.assert_called_once()
second.append.assert_called_once()
self.assertNotEqual(first.append.call_args.args[3], second.append.call_args.args[3])
def test_definitive_append_rejection_is_not_retried_or_unknown(self):
client = BatchClient()
client.append.return_value = ("NO", [b"quota"])
with (
patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client) as connect,
ImapBatchSession(config()) as batch,
self.assertRaises(ImapAppendError) as caught,
):
batch.append(b"one")
self.assertFalse(caught.exception.outcome_unknown)
connect.assert_called_once()
client.append.assert_called_once()
def test_logout_failure_does_not_reverse_accepted_message(self):
client = BatchClient()
client.logout.side_effect = OSError("gone")
with patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client):
result = append_message_to_sent(b"one", imap_config=config())
self.assertEqual(result.bytes_appended, 3)
client.shutdown.assert_called_once()
def test_disabling_reuse_keeps_individual_appends_and_closes_every_connection(self):
clients = [BatchClient() for _ in range(3)]
with (
patch("govoplan_mail.backend.sending.imap._open_imap", side_effect=clients),
ImapBatchSession(config(), policy=replace(ImapBatchPolicy(), reuse_connections=False)) as batch,
):
results = [batch.append(b"one") for _ in clients]
self.assertEqual([item.connection_sequence for item in results], [1, 2, 3])
self.assertFalse(any(item.session_reused for item in results))
for client in clients:
client.append.assert_called_once()
client.logout.assert_called_once()
def test_config_mismatch_closed_and_overlapping_calls_fail_before_provider(self):
with patch("govoplan_mail.backend.sending.imap._open_imap") as connect:
batch = ImapBatchSession(config())
with self.assertRaises(ImapConfigurationError):
append_message_to_sent(b"one", imap_config=config(password="different"), batch_session=batch)
with batch._exclusive_append(), self.assertRaises(ImapConfigurationError):
batch.append(b"overlap")
batch.close()
with self.assertRaises(ImapConfigurationError):
batch.append(b"closed")
connect.assert_not_called()
def test_environment_values_are_bounded(self):
with patch.dict("os.environ", {
"GOVOPLAN_IMAP_BATCH_REUSE": "false",
"GOVOPLAN_IMAP_BATCH_MAX_MESSAGES": "0",
"GOVOPLAN_IMAP_BATCH_MAX_AGE_SECONDS": "invalid",
"GOVOPLAN_IMAP_BATCH_IDLE_HEALTH_CHECK_SECONDS": "999999",
"GOVOPLAN_IMAP_BATCH_RECONNECT_ATTEMPTS": "999999",
}):
policy = ImapBatchPolicy.from_environment()
self.assertFalse(policy.reuse_connections)
self.assertEqual(policy.max_messages_per_connection, 1)
self.assertEqual(policy.max_connection_age_seconds, 300)
self.assertEqual(policy.idle_health_check_seconds, 3600)
self.assertEqual(policy.reconnect_attempts, 5)
+225
View File
@@ -0,0 +1,225 @@
from __future__ import annotations
import unittest
from unittest.mock import patch
from govoplan_mail.backend.config import ImapConfig
from govoplan_mail.backend.sending.imap import (
ImapAppendError,
ImapConfigurationError,
_decode_mailbox_name,
_encode_mailbox_name,
_extract_mailbox_name,
_list_imap_folders_on_client,
_quote_mailbox_name,
_select_readonly,
append_message_to_sent,
)
class MailboxClient:
utf8_enabled = False
capabilities = ("IMAP4REV1", "UTF8=ACCEPT")
untagged_responses = {"EXISTS": [b"2"], "UIDVALIDITY": [b"1"]}
def __init__(self, listing=None):
self.listing = listing or []
self.list_calls = 0
self.status_calls = []
self.select_calls = []
self.append_calls = []
self.logged_out = False
def list(self):
self.list_calls += 1
return "OK", self.listing
def status(self, mailbox, items):
self.status_calls.append((mailbox, items))
return "OK", [b'"mailbox" (MESSAGES 2 UNSEEN 1)']
def select(self, mailbox, readonly=False):
self.select_calls.append((mailbox, readonly))
return "OK", [b"2"]
def response(self, code):
return "OK", [b"1"] if code == "UIDVALIDITY" else []
def append(self, mailbox, flags, date_time, message):
self.append_calls.append((mailbox, flags, message))
return "OK", [b"APPEND complete"]
def logout(self):
self.logged_out = True
return "BYE", []
class ImapMailboxEncodingTests(unittest.TestCase):
def test_rfc_and_real_provider_vectors_round_trip(self):
# RFC 3501 section 5.1.3 plus the reported German folder and UTF-16
# surrogate pairs. A plain '+' is not a shift in modified UTF-7.
for display, wire in (
("INBOX", "INBOX"),
("Entwürfe", "Entw&APw-rfe"),
("R&D", "R&-D"),
("+Plus & Sons", "+Plus &- Sons"),
("~peter/mail/台北/日本語", "~peter/mail/&U,BTFw-/&ZeVnLIqe-"),
("📨", "&2D3c6A-"),
('A \\ "B"', 'A \\ "B"'),
):
with self.subTest(display=display):
self.assertEqual(_encode_mailbox_name(display), wire)
self.assertEqual(_decode_mailbox_name(wire), display)
def test_list_decodes_names_before_standard_folder_detection_and_status(self):
client = MailboxClient([
b'(\\HasNoChildren) "/" "Entw&APw-rfe"',
b'(\\HasNoChildren) "/" "Gel&APY-scht"',
b'(\\HasNoChildren) "/" "R&-D"',
])
result = _list_imap_folders_on_client(
client, host="imap.example.org", port=993, security="tls", include_status=True,
)
self.assertEqual([folder.name for folder in result.folders], ["Entwürfe", "Gelöscht", "R&D"])
self.assertEqual(result.detected_folder_mappings, {"drafts": "Entwürfe", "trash": "Gelöscht"})
self.assertTrue(all(folder.message_count == 2 and folder.unseen_count == 1 for folder in result.folders))
self.assertEqual([call[0] for call in client.status_calls], [
'"Entw&APw-rfe"', '"Gel&APY-scht"', '"R&-D"',
])
self.assertEqual(client.list_calls, 1)
def test_literal_names_are_decoded_without_stripping_or_unquoting_content(self):
for wire, expected in (
(b"Entw&APw-rfe", "Entwürfe"),
(b'"R&-D" ', '"R&D" '),
):
with self.subTest(wire=wire):
line = b'(\\Drafts) "/" {' + str(len(wire)).encode("ascii") + b"}"
self.assertEqual(_extract_mailbox_name((line, wire)), (expected, {"\\drafts"}))
self.assertIsNone(_extract_mailbox_name(b""))
self.assertIsNone(_extract_mailbox_name(None))
def test_list_rejects_wrong_literal_lengths_and_invalid_provider_encoding(self):
with self.assertRaisesRegex(ImapAppendError, "literal"):
_extract_mailbox_name((b'() "/" {99}', b"INBOX"))
for wire in (b"&APw", b"&!bad-", b"&AGE-", b"&AA-", b"&APx-", b"&2AA-", b"Entw\xffrfe"):
with self.subTest(wire=wire), self.assertRaisesRegex(ImapAppendError, "encoding"):
_extract_mailbox_name(b'() "/" "' + wire + b'"')
def test_select_encodes_unicode_and_quotes_protocol_metacharacters(self):
client = MailboxClient()
folder = 'Entwürfe / R&D / "Q" \\'
self.assertEqual(_select_readonly(client, folder), (2, "1"))
self.assertEqual(client.select_calls, [('"Entw&APw-rfe / R&-D / \\"Q\\" \\\\"', True)])
self.assertEqual(client.list_calls, 0)
def test_quoted_name_escaping_round_trips_independently_of_charset_encoding(self):
for folder in ('Entwürfe "R&D"', ' \\"quoted"\\ ', 'R&D', '📨/日本語', 'back\\slash'):
with self.subTest(folder=folder):
quoted = _quote_mailbox_name(folder)
self.assertEqual(_extract_mailbox_name('() "/" ' + quoted), (folder, set()))
def test_saved_wire_names_resolve_without_double_encoding(self):
client = MailboxClient([b'() "/" "Entw&APw-rfe"'])
_select_readonly(client, "Entw&APw-rfe")
_select_readonly(client, "Entwürfe")
self.assertEqual(client.select_calls, [('"Entw&APw-rfe"', True)] * 2)
self.assertEqual(client.list_calls, 1)
def test_literal_name_wins_when_legacy_alias_is_ambiguous(self):
client = MailboxClient([
b'() "/" "Entw&APw-rfe"',
b'() "/" "Entw&-APw-rfe"',
])
_select_readonly(client, "Entw&APw-rfe")
self.assertEqual(client.select_calls, [('"Entw&-APw-rfe"', True)])
def test_saved_ampersand_and_literal_ampersand_remain_distinct(self):
client = MailboxClient([b'() "/" "R&-D"'])
_select_readonly(client, "R&-D")
_select_readonly(client, "R&D")
self.assertEqual(client.select_calls, [('"R&-D"', True)] * 2)
def test_provider_wire_form_is_preserved_on_the_listed_connection(self):
client = MailboxClient([b'() "/" "&U,BTFw-&ZeVnLIqe-"'])
result = _list_imap_folders_on_client(
client, host="imap.example.org", port=993, security="tls", include_status=True,
)
self.assertEqual(result.folders[0].name, "台北日本語")
self.assertEqual(client.status_calls[0][0], '"&U,BTFw-&ZeVnLIqe-"')
def test_utf8_mode_preserves_literal_ampersands_and_does_not_decode_again(self):
client = MailboxClient(['() "/" "Entwürfe &APw-"'.encode("utf-8")])
client.utf8_enabled = True
result = _list_imap_folders_on_client(
client, host="imap.example.org", port=993, security="tls", include_status=True,
)
self.assertEqual(result.folders[0].name, "Entwürfe &APw-")
_select_readonly(client, result.folders[0].name)
self.assertEqual(client.select_calls, [('"Entwürfe &APw-"', True)])
self.assertEqual(client.status_calls[0][0], '"Entwürfe &APw-"')
def test_utf8_capability_alone_does_not_change_the_encoding(self):
client = MailboxClient()
self.assertEqual(_quote_mailbox_name("Entwürfe", client=client), '"Entw&APw-rfe"')
with self.assertRaisesRegex(ImapAppendError, "encoding"):
_extract_mailbox_name('() "/" "Entwürfe"'.encode("utf-8"))
def test_changing_utf8_mode_invalidates_cached_wire_names(self):
client = MailboxClient([b'() "/" "Entw&APw-rfe"'])
_list_imap_folders_on_client(
client, host="imap.example.org", port=993, security="tls", include_status=False,
)
client.utf8_enabled = True
self.assertEqual(_quote_mailbox_name("Entwürfe", client=client), '"Entwürfe"')
def test_select_rejects_control_characters_before_sending_any_command(self):
for folder in ("INBOX\r\nLOGOUT", "bad\x00folder", "bad\x7ffolder", "bad\u2028folder"):
client = MailboxClient()
with self.subTest(folder=folder), self.assertRaisesRegex(ImapConfigurationError, "control"):
_select_readonly(client, folder)
self.assertEqual(client.select_calls, [])
def test_append_auto_detects_unicode_sent_folder_and_uses_original_wire_name(self):
client = MailboxClient([b'(\\Sent) "/" "Gesendet &APw-"'])
config = ImapConfig(host="imap.example.org", sent_folder="auto")
with patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client):
result = append_message_to_sent(b"Subject: test\r\n\r\nBody", imap_config=config)
self.assertEqual(result.folder, "Gesendet ü")
self.assertEqual(client.append_calls[0][0], '"Gesendet &APw-"')
self.assertTrue(client.logged_out)
def test_append_explicit_unicode_and_saved_wire_names_target_the_same_mailbox(self):
for folder in ("Entwürfe", "Entw&APw-rfe"):
with self.subTest(folder=folder):
client = MailboxClient([b'() "/" "Entw&APw-rfe"'])
config = ImapConfig(host="imap.example.org", sent_folder=folder)
with patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client):
append_message_to_sent(b"Subject: test\r\n\r\nBody", imap_config=config)
self.assertEqual(client.append_calls[0][0], '"Entw&APw-rfe"')
def test_failed_legacy_lookup_never_selects_or_appends_to_a_guessed_mailbox(self):
client = MailboxClient()
with patch.object(client, "list", return_value=("NO", [b"Denied"])), self.assertRaisesRegex(
ImapAppendError, "resolving a saved folder name",
):
_select_readonly(client, "Entw&APw-rfe")
self.assertEqual(client.select_calls, [])
def test_append_saved_wire_name_failure_is_not_an_unknown_append_outcome(self):
client = MailboxClient()
config = ImapConfig(host="imap.example.org", sent_folder="Entw&APw-rfe")
with (
patch("govoplan_mail.backend.sending.imap._open_imap", return_value=client),
patch.object(client, "list", side_effect=OSError("connection lost")),
self.assertRaises(ImapAppendError) as caught,
):
append_message_to_sent(b"Subject: test\r\n\r\nBody", imap_config=config)
self.assertTrue(caught.exception.temporary)
self.assertFalse(caught.exception.outcome_unknown)
self.assertEqual(client.append_calls, [])
self.assertTrue(client.logged_out)
if __name__ == "__main__":
unittest.main()
+39 -1
View File
@@ -563,7 +563,7 @@ class MailProfilePolicyHelperTests(unittest.TestCase):
"credential-1", "credential-1",
) )
def test_campaign_delivery_fails_when_policy_requires_local_credentials(self): def test_campaign_delivery_fails_when_policy_requires_missing_explicit_credentials(self):
profile = SimpleNamespace(imap_config=None) profile = SimpleNamespace(imap_config=None)
policy = EffectiveMailProfilePolicy( policy = EffectiveMailProfilePolicy(
smtp_credentials=EffectiveCredentialPolicy(inherit=False), smtp_credentials=EffectiveCredentialPolicy(inherit=False),
@@ -572,6 +572,44 @@ class MailProfilePolicyHelperTests(unittest.TestCase):
with self.assertRaisesRegex(MailProfileError, "explicit credential selection"): with self.assertRaisesRegex(MailProfileError, "explicit credential selection"):
_assert_campaign_inherits_profile_credentials(profile, policy) _assert_campaign_inherits_profile_credentials(profile, policy)
def test_explicit_mail_credentials_satisfy_independent_protocol_selection_policy(self):
profile = SimpleNamespace(imap_config={"host": "imap.example.test"})
policy = EffectiveMailProfilePolicy(
smtp_credentials=EffectiveCredentialPolicy(inherit=False),
imap_credentials=EffectiveCredentialPolicy(inherit=False),
)
with self.assertRaisesRegex(MailProfileError, "effective IMAP"):
_assert_campaign_inherits_profile_credentials(profile, policy, {"smtp_credential_id": "smtp-credential"})
_assert_campaign_inherits_profile_credentials(profile, policy, {
"smtp_credential_id": "smtp-credential", "imap_credential_id": "imap-credential",
})
# Allowing a default never forbids an explicitly selected Mail credential.
_assert_campaign_inherits_profile_credentials(profile, EffectiveMailProfilePolicy(), {
"smtp_credential_id": "smtp-credential", "imap_credential_id": "imap-credential",
})
def test_credential_selection_false_is_overridable_only_without_an_ancestor_lock(self):
for locked in (False, True):
with self.subTest(locked=locked):
policy = EffectiveMailProfilePolicy()
_merge_policy(policy, {
"smtp_credentials": {"inherit": False},
"allow_lower_level_limits": {"smtp_credentials.inherit": not locked},
}, source="system")
_merge_policy(policy, {
"smtp_credentials": {"inherit": True},
"allow_lower_level_limits": {"smtp_credentials.inherit": True},
}, source="tenant", source_id="tenant-1")
self.assertEqual(policy.smtp_credentials.inherit, not locked)
self.assertEqual(policy.allow_lower_level_limits["smtp_credentials.inherit"], not locked)
def test_null_credential_selection_inherits_the_parent_choice(self):
policy = EffectiveMailProfilePolicy()
_merge_policy(policy, {"smtp_credentials": {"inherit": False}}, source="system")
_merge_policy(policy, {"smtp_credentials": {"inherit": None}}, source="tenant", source_id="tenant-1")
self.assertFalse(policy.smtp_credentials.inherit)
self.assertEqual(policy.smtp_credentials.inherit_source, "system")
def test_merge_policy_respects_locked_lower_level_limits(self): def test_merge_policy_respects_locked_lower_level_limits(self):
policy = EffectiveMailProfilePolicy() policy = EffectiveMailProfilePolicy()
_merge_policy( _merge_policy(
+444 -15
View File
@@ -1,6 +1,8 @@
from __future__ import annotations from __future__ import annotations
import base64 import base64
import dataclasses
import importlib
from datetime import UTC, datetime from datetime import UTC, datetime
import poplib import poplib
import ssl import ssl
@@ -8,7 +10,12 @@ from types import SimpleNamespace
import unittest import unittest
from unittest.mock import patch from unittest.mock import patch
from sqlalchemy import create_engine from alembic.migration import MigrationContext
from alembic.operations import Operations
from fastapi import HTTPException
from pydantic import ValidationError
from sqlalchemy import MetaData, Table, create_engine, inspect, select
from sqlalchemy.orm import sessionmaker from sqlalchemy.orm import sessionmaker
from govoplan_access.backend.db.models import Account, User from govoplan_access.backend.db.models import Account, User
@@ -23,12 +30,24 @@ from govoplan_mail.backend.db.models import (
MailServerProfile, MailServerProfile,
) )
from govoplan_mail.backend.pop3_imports import ( from govoplan_mail.backend.pop3_imports import (
Pop3ImportConflict,
bind_legacy_maildrop,
maildrop_identity,
pop3_preview_revision,
Pop3ImportResult, Pop3ImportResult,
create_pop3_imports, create_pop3_imports,
list_pop3_imports, list_pop3_imports,
) )
from govoplan_mail.backend.router import import_profile_pop3_messages from govoplan_mail.backend.router import (
from govoplan_mail.backend.schemas import MailPop3ImportRequest import_profile_pop3_messages,
preview_profile_pop3_import,
reconcile_pop3_import_maildrop,
)
from govoplan_mail.backend.schemas import (
MailPop3BindMaildropRequest,
MailPop3ImportRequest,
MailPop3PreviewRequest,
)
from govoplan_mail.backend.sending.pop3 import ( from govoplan_mail.backend.sending.pop3 import (
Pop3ConfigurationError, Pop3ConfigurationError,
Pop3DownloadedMessage, Pop3DownloadedMessage,
@@ -152,9 +171,7 @@ class Pop3TransportTests(unittest.TestCase):
"govoplan_mail.backend.sending.pop3._open_pop3", "govoplan_mail.backend.sending.pop3._open_pop3",
return_value=download_client, return_value=download_client,
): ):
downloaded = download_pop3_messages( downloaded = download_pop3_messages(pop3_config=_config(), uidls=("uid-1",))
pop3_config=_config(), uidls=("uid-1",)
)
self.assertEqual(_RAW, downloaded[0].raw) self.assertEqual(_RAW, downloaded[0].raw)
self.assertEqual([], download_client.deletions) self.assertEqual([], download_client.deletions)
@@ -196,9 +213,7 @@ class Pop3TransportTests(unittest.TestCase):
def test_tls_and_authentication_failures_are_sanitized(self) -> None: def test_tls_and_authentication_failures_are_sanitized(self) -> None:
with ( with (
patch( patch("govoplan_mail.backend.sending.pop3.validate_outbound_host"),
"govoplan_mail.backend.sending.pop3.validate_outbound_host"
),
patch( patch(
"govoplan_mail.backend.sending.pop3._OutboundPolicyPOP3SSL", "govoplan_mail.backend.sending.pop3._OutboundPolicyPOP3SSL",
side_effect=ssl.SSLError("private TLS detail"), side_effect=ssl.SSLError("private TLS detail"),
@@ -213,9 +228,7 @@ class Pop3TransportTests(unittest.TestCase):
poplib.error_proto("private auth detail") poplib.error_proto("private auth detail")
) )
with ( with (
patch( patch("govoplan_mail.backend.sending.pop3.validate_outbound_host"),
"govoplan_mail.backend.sending.pop3.validate_outbound_host"
),
patch( patch(
"govoplan_mail.backend.sending.pop3._OutboundPolicyPOP3", "govoplan_mail.backend.sending.pop3._OutboundPolicyPOP3",
return_value=auth_client, return_value=auth_client,
@@ -274,6 +287,7 @@ class Pop3PersistenceTests(unittest.TestCase):
pop3_server_id=self.server.id, pop3_server_id=self.server.id,
pop3_credential_id=None, pop3_credential_id=None,
transport_revision="revision-1", transport_revision="revision-1",
maildrop_key=maildrop_identity(_config()),
messages=(_download(),), messages=(_download(),),
user_id=None, user_id=None,
deletion_requested=False, deletion_requested=False,
@@ -296,13 +310,16 @@ class Pop3PersistenceTests(unittest.TestCase):
pop3_server_id=self.server.id, pop3_server_id=self.server.id,
pop3_credential_id=None, pop3_credential_id=None,
transport_revision="revision-1", transport_revision="revision-1",
maildrop_key=maildrop_identity(_config()),
messages=(_download(),), messages=(_download(),),
user_id=None, user_id=None,
deletion_requested=False, deletion_requested=False,
) )
self.assertEqual((), repeated.imported) self.assertEqual((), repeated.imported)
self.assertEqual((first.imported[0].id,), tuple(row.id for row in repeated.duplicates)) self.assertEqual(
(first.imported[0].id,), tuple(row.id for row in repeated.duplicates)
)
self.assertEqual( self.assertEqual(
(first.imported[0].id,), (first.imported[0].id,),
tuple( tuple(
@@ -323,6 +340,414 @@ class Pop3PersistenceTests(unittest.TestCase):
), ),
) )
def _import(
self,
*,
config=None,
messages=None,
credential="credential-1",
tenant="tenant-1",
):
return create_pop3_imports(
self.session,
tenant_id=tenant,
profile_id=self.profile.id,
pop3_server_id=self.server.id,
pop3_credential_id=credential,
transport_revision="revision-1",
maildrop_key=maildrop_identity(config or _config()),
messages=messages or (_download(),),
user_id=None,
deletion_requested=False,
)
def test_mailbox_identity_survives_secret_rotation_but_not_username_or_host(self):
original = maildrop_identity(_config())
self.assertEqual(original, maildrop_identity(_config(password="rotated")))
self.assertEqual(original, maildrop_identity(_config(host="POP3.EXAMPLE.TEST")))
for change in (
{"username": "Legacy-user"},
{"host": "other.example.test"},
{"port": 1995},
):
self.assertNotEqual(original, maildrop_identity(_config(**change)))
first = self._import().imported[0]
self.session.commit()
self.assertEqual(
first.id,
self._import(config=_config(password="rotated"), credential="credential-2")
.duplicates[0]
.id,
)
second = self._import(config=_config(username="mailbox-B")).imported[0]
self.assertNotEqual(first.id, second.id)
self.assertNotEqual(first.fingerprint, second.fingerprint)
def test_tenant_boundary_remains_in_identity_lookup_and_constraint(self):
self.server.tenant_id = None
self.profile.tenant_id = None
first = self._import().imported[0]
self.session.commit()
second = self._import(tenant="tenant-2").imported[0]
self.assertNotEqual(first.id, second.id)
def test_changed_uidl_content_rejects_the_whole_batch_before_insert(self):
self._import()
self.session.commit()
import hashlib
message = dataclasses.replace(
_download(),
raw=b"different",
raw_sha256=hashlib.sha256(b"different").hexdigest(),
)
with self.assertRaisesRegex(Pop3ImportConflict, "different content"):
self._import(messages=(_download("new-uidl"), message))
self.assertEqual(1, self.session.query(MailPop3Import).count())
self.assertFalse(self.session.new)
def test_legacy_conflict_is_explicit_and_binding_is_non_destructive_and_repeatable(
self,
):
row = self._import().imported[0]
row.maildrop_identity = None
self.session.commit()
retained = (
row.id,
row.raw_message_encrypted,
row.fingerprint,
row.transport_revision,
)
with self.assertRaisesRegex(Pop3ImportConflict, "unbound legacy"):
self._import()
for _ in range(2):
bound = bind_legacy_maildrop(
self.session,
tenant_id="tenant-1",
profile_id=self.profile.id,
server_id=self.server.id,
import_id=row.id,
identity=maildrop_identity(_config()),
message=_download(),
)
self.session.commit()
self.assertEqual(
retained,
(
bound.id,
bound.raw_message_encrypted,
bound.fingerprint,
bound.transport_revision,
),
)
self.assertEqual(row.id, self._import().duplicates[0].id)
def test_legacy_binding_rejects_different_content_and_collision(self):
row = self._import().imported[0]
self._import(config=_config(username="mailbox-B"))
row.maildrop_identity = None
self.session.commit()
with self.assertRaisesRegex(Pop3ImportConflict, "does not match"):
bind_legacy_maildrop(
self.session,
tenant_id="tenant-1",
profile_id=self.profile.id,
server_id=self.server.id,
import_id=row.id,
identity=maildrop_identity(_config()),
message=dataclasses.replace(_download(), raw=b"different"),
)
with self.assertRaisesRegex(Pop3ImportConflict, "already owns"):
bind_legacy_maildrop(
self.session,
tenant_id="tenant-1",
profile_id=self.profile.id,
server_id=self.server.id,
import_id=row.id,
identity=maildrop_identity(_config(username="mailbox-B")),
message=_download(),
)
self.assertIsNone(row.maildrop_identity)
def _principal(self, *, tenant="tenant-1", omitted=None):
scopes = {"mail:profile:use", "mail:pop3:manage", "mail:pop3:import"} - {
omitted
}
return ApiPrincipal(
principal=PrincipalRef(
account_id="account",
membership_id="user",
tenant_id=tenant,
scopes=frozenset(scopes),
),
account=SimpleNamespace(id="account"),
user=SimpleNamespace(id="user"),
)
def test_legacy_binding_rejects_unverifiable_retained_ciphertext(self):
row = self._import().imported[0]
row.maildrop_identity = None
row.raw_message_encrypted = "invalid retained ciphertext"
self.session.commit()
with self.assertRaisesRegex(Pop3ImportConflict, "could not be verified"):
bind_legacy_maildrop(
self.session,
tenant_id="tenant-1",
profile_id=self.profile.id,
server_id=self.server.id,
import_id=row.id,
identity=maildrop_identity(_config()),
message=_download(),
)
self.assertIsNone(row.maildrop_identity)
self.assertEqual("invalid retained ciphertext", row.raw_message_encrypted)
def _resolved(self, config=None):
return (
self.profile,
SimpleNamespace(
config=config or _config(),
server=self.server,
credential=None,
transport_revision="revision-1",
),
)
def _binding_request(self):
return MailPop3BindMaildropRequest(
server_id=self.server.id,
expected_transport_revision=pop3_preview_revision(
"revision-1", maildrop_identity(_config())
),
confirm_binding=True,
)
def test_preview_distinguishes_mailboxes_and_reports_unbound_legacy(self):
row = self._import().imported[0]
self.session.commit()
preview = SimpleNamespace(
messages=(_download().summary,),
host="pop3.example.test",
port=995,
security="tls",
message_count=1,
mailbox_size_bytes=len(_RAW),
)
for config, imported, conflict in (
(_config(), True, False),
(_config(username="other"), False, False),
(_config(), False, True),
):
if conflict:
row.maildrop_identity = None
self.session.commit()
with (
patch(
"govoplan_mail.backend.router._resolve_profile_pop3_transport",
return_value=self._resolved(config),
),
patch(
"govoplan_mail.backend.router.preview_pop3_messages",
return_value=preview,
),
):
result = preview_profile_pop3_import(
self.profile.id,
MailPop3PreviewRequest(server_id=self.server.id),
principal=self._principal(),
session=self.session,
)
self.assertEqual(imported, result.messages[0].already_imported)
self.assertEqual(conflict, result.messages[0].legacy_identity_conflict)
self.assertEqual(
pop3_preview_revision("revision-1", maildrop_identity(config)),
result.transport_revision,
)
def test_reconciliation_route_checks_each_scope_before_resolving_or_downloading(
self,
):
for scope in ("mail:profile:use", "mail:pop3:manage", "mail:pop3:import"):
with (
patch(
"govoplan_mail.backend.router._resolve_profile_pop3_transport"
) as resolve,
self.assertRaises(HTTPException) as caught,
):
reconcile_pop3_import_maildrop(
self.profile.id,
"unused",
self._binding_request(),
principal=self._principal(omitted=scope),
session=self.session,
)
self.assertEqual(403, caught.exception.status_code)
resolve.assert_not_called()
with self.assertRaises(ValidationError):
MailPop3BindMaildropRequest(
server_id=self.server.id,
expected_transport_revision="revision",
confirm_binding=False,
)
def test_reconciliation_route_checks_tenant_and_preview_before_download(self):
row = self._import().imported[0]
row.maildrop_identity = None
self.session.commit()
with (
patch(
"govoplan_mail.backend.router._resolve_profile_pop3_transport",
return_value=self._resolved(),
),
patch("govoplan_mail.backend.router.download_pop3_messages") as download,
):
with self.assertRaises(HTTPException) as caught:
reconcile_pop3_import_maildrop(
self.profile.id,
row.id,
self._binding_request(),
principal=self._principal(tenant="another"),
session=self.session,
)
self.assertEqual(404, caught.exception.status_code)
stale = self._binding_request().model_copy(
update={"expected_transport_revision": "old-preview"}
)
with self.assertRaises(HTTPException) as caught:
reconcile_pop3_import_maildrop(
self.profile.id,
row.id,
stale,
principal=self._principal(),
session=self.session,
)
self.assertEqual(409, caught.exception.status_code)
download.assert_not_called()
def test_reconciliation_route_audit_failure_rolls_back_and_success_never_deletes(
self,
):
row = self._import().imported[0]
row.maildrop_identity = None
self.session.commit()
with (
patch(
"govoplan_mail.backend.router._resolve_profile_pop3_transport",
return_value=self._resolved(),
),
patch(
"govoplan_mail.backend.router.download_pop3_messages",
return_value=(_download(),),
),
patch("govoplan_mail.backend.router.delete_pop3_messages") as delete,
patch(
"govoplan_mail.backend.router.audit_event",
side_effect=RuntimeError("audit unavailable"),
),
):
with self.assertRaisesRegex(RuntimeError, "audit unavailable"):
reconcile_pop3_import_maildrop(
self.profile.id,
row.id,
self._binding_request(),
principal=self._principal(),
session=self.session,
)
self.assertIsNone(
self.session.get(MailPop3Import, row.id).maildrop_identity
)
delete.assert_not_called()
with (
patch(
"govoplan_mail.backend.router._resolve_profile_pop3_transport",
return_value=self._resolved(),
),
patch(
"govoplan_mail.backend.router.download_pop3_messages",
return_value=(_download(),),
),
patch("govoplan_mail.backend.router.delete_pop3_messages") as delete,
patch("govoplan_mail.backend.router.audit_event") as audit,
):
result = reconcile_pop3_import_maildrop(
self.profile.id,
row.id,
self._binding_request(),
principal=self._principal(),
session=self.session,
)
self.assertTrue(result.maildrop_identity_bound)
self.assertEqual(row.id, result.id)
self.assertEqual(
"mail.pop3.maildrop_bound", audit.call_args.kwargs["action"]
)
delete.assert_not_called()
def test_migration_retains_unbound_records_and_refuses_lossy_downgrade(self):
self.session.close()
MailPop3Import.__table__.drop(self.engine)
old = importlib.import_module(
"govoplan_mail.backend.migrations.versions.a4c5d6e7f809_mail_pop3_imports"
)
new = importlib.import_module(
"govoplan_mail.backend.migrations.versions.b5d6e7f8091a_mail_pop3_maildrop_identity"
)
with self.engine.begin() as connection:
with Operations.context(MigrationContext.configure(connection)):
old.upgrade()
table = Table("mail_pop3_imports", MetaData(), autoload_with=connection)
now = datetime.now(UTC)
values = dict(
id="legacy",
tenant_id="tenant-1",
profile_id=self.profile.id,
pop3_server_id=self.server.id,
transport_revision="historical",
provider_uidl="uidl",
fingerprint="original",
raw_sha256="retained",
raw_message_encrypted="retained ciphertext",
size_bytes=7,
status="pending_review",
imported_at=now,
deletion_requested=False,
deletion_status="not_requested",
created_at=now,
updated_at=now,
)
connection.execute(table.insert().values(**values))
with Operations.context(MigrationContext.configure(connection)):
new.upgrade()
current = Table("mail_pop3_imports", MetaData(), autoload_with=connection)
retained = connection.execute(select(current)).mappings().one()
self.assertIsNone(retained["maildrop_identity"])
for key in (
"id",
"fingerprint",
"raw_message_encrypted",
"raw_sha256",
"transport_revision",
):
self.assertEqual(values[key], retained[key])
connection.execute(
current.insert().values(
**{**values, "id": "new-maildrop", "maildrop_identity": "a" * 64}
)
)
with (
Operations.context(MigrationContext.configure(connection)),
self.assertRaisesRegex(RuntimeError, "collapse different maildrops"),
):
new.downgrade()
self.assertIn(
"maildrop_identity",
{
column["name"]
for column in inspect(connection).get_columns("mail_pop3_imports")
},
)
self.assertEqual(2, len(connection.execute(select(current.c.id)).all()))
class _RouteSession: class _RouteSession:
def __init__(self, events: list[str]) -> None: def __init__(self, events: list[str]) -> None:
@@ -384,7 +809,9 @@ class Pop3ImportRouteTests(unittest.TestCase):
) )
payload = MailPop3ImportRequest( payload = MailPop3ImportRequest(
server_id="server-1", server_id="server-1",
expected_transport_revision="revision-1", expected_transport_revision=pop3_preview_revision(
"revision-1", maildrop_identity(_config())
),
uidls=["uid-1"], uidls=["uid-1"],
delete_after_import=True, delete_after_import=True,
) )
@@ -416,7 +843,9 @@ class Pop3ImportRouteTests(unittest.TestCase):
return_value=Pop3ImportResult(imported=(row,), duplicates=()), return_value=Pop3ImportResult(imported=(row,), duplicates=()),
), ),
patch("govoplan_mail.backend.router.audit_event", side_effect=audit), patch("govoplan_mail.backend.router.audit_event", side_effect=audit),
patch("govoplan_mail.backend.router.delete_pop3_messages", side_effect=delete), patch(
"govoplan_mail.backend.router.delete_pop3_messages", side_effect=delete
),
patch( patch(
"govoplan_mail.backend.router.mark_pop3_deletion_result", "govoplan_mail.backend.router.mark_pop3_deletion_result",
side_effect=mark, side_effect=mark,
+3 -3
View File
@@ -1,17 +1,17 @@
{ {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"devDependencies": { "devDependencies": {
"typescript": "^5.7.2" "typescript": "^5.7.2"
}, },
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.18", "@govoplan/core-webui": "^0.1.45",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
+2 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/mail-webui", "name": "@govoplan/mail-webui",
"version": "0.1.24", "version": "0.1.28",
"private": true, "private": true,
"type": "module", "type": "module",
"main": "src/index.ts", "main": "src/index.ts",
@@ -14,7 +14,7 @@
"./styles/mail-profiles.css": "./src/styles/mail-profiles.css" "./styles/mail-profiles.css": "./src/styles/mail-profiles.css"
}, },
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.18", "@govoplan/core-webui": "^0.1.45",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
@@ -6,8 +6,9 @@ function read(relativePath) {
return readFileSync(fileURLToPath(new URL(relativePath, import.meta.url)), "utf8"); return readFileSync(fileURLToPath(new URL(relativePath, import.meta.url)), "utf8");
} }
const profiles = read("../src/features/mail/MailProfileManagement.tsx"); const profiles = `${read("../src/features/mail/MailProfileManagement.tsx")}\n${read("../src/features/mail/MailProfilePolicyEditor.tsx")}`;
const mailbox = read("../src/features/mail/MailboxPage.tsx"); const mailbox = read("../src/features/mail/MailboxPage.tsx");
const mailApi = read("../src/api/mail.ts");
const bounces = read("../src/features/mail/MailBouncePage.tsx"); const bounces = read("../src/features/mail/MailBouncePage.tsx");
const legacyImport = read("../src/features/mail/MailLegacyImportPage.tsx"); const legacyImport = read("../src/features/mail/MailLegacyImportPage.tsx");
const moduleSource = read("../src/module.ts"); const moduleSource = read("../src/module.ts");
@@ -34,6 +35,32 @@ assert.match(mailbox, /topicId: "mail\.workflow\.read-mailbox"/);
assert.match(mailbox, /disabledReason=\{folderReloadBlocker\}/); assert.match(mailbox, /disabledReason=\{folderReloadBlocker\}/);
assert.match(mailbox, /folder_mappings\?\.inbox/); assert.match(mailbox, /folder_mappings\?\.inbox/);
assert.match(mailbox, /detected_folder_mappings\?\.inbox/); assert.match(mailbox, /detected_folder_mappings\?\.inbox/);
const openFolderNode = mailbox.slice(mailbox.indexOf(" function openFolderNode("), mailbox.indexOf(" function toggleFolderNode("));
assert.doesNotMatch(openFolderNode, /toggleFolderNode\(/, "Folder labels select; only the folder button expands or collapses.");
assert.match(openFolderNode, /setSelectedFolderGroup\(\{ id: node\.id, label: node\.label \}\)/);
assert.match(openFolderNode, /messageDetailRequestRef\.current \+= 1/, "Selecting a grouping invalidates pending message detail.");
assert.match(mailbox, /selectedFolderGroup\?\.id \?\? findFolderNodeId/);
assert.match(mailbox, /<WorkspaceFrame[^>]*height="viewport"/);
assert.match(mailbox, /<WorkspaceActionBar\s+title="i18n:govoplan-mail\.mailbox_workspace"\s+titleHelp=\{<DocumentationHelpLink reference=\{MAILBOX_DOCUMENTATION\} \/>\}\s+variant="workspace"\s+scope="workspace"[\s\S]*refreshable[\s\S]*onReload: \(\) => void reloadMailbox\(\)/);
assert.ok(mailbox.indexOf("<WorkspaceActionBar") < mailbox.indexOf('<aside className="file-tree-panel"'), "Mailbox actions remain outside all selectable panes.");
assert.equal((mailbox.match(/<WorkspaceActionBar/g) ?? []).length, 1, "One persistent page-wide action bar.");
assert.doesNotMatch(mailbox, /mailbox-toolbar|<ToolbarGroup/);
assert.match(mailbox, /const MAILBOX_READ_OPTIONS = \{ cache: "no-store" \}/);
assert.match(mailbox, /listMailServerProfiles\(settings, false, undefined, MAILBOX_READ_OPTIONS\)/);
for (const helper of ["listMailServerProfiles", "listMailboxFolders", "bootstrapMailbox", "listMailboxMessages", "getMailboxMessage"]) {
const start = mailApi.indexOf(`export async function ${helper}(`);
const end = mailApi.indexOf("\nexport async function ", start + 1);
const source = mailApi.slice(start, end < 0 ? undefined : end);
assert.match(source, /options\?: MailboxReadOptions/, `${helper} supports a scoped fresh read.`);
assert.match(source, /\}\), options\)/, `${helper} passes the read options to Core without global invalidation.`);
}
assert.match(mailbox, /<Dialog open=\{mailToolsOpen\}[\s\S]*mailbox_refresh_tools[\s\S]*refresh_mailbox_profiles[\s\S]*refresh_mailbox_folder_catalogue[\s\S]*refresh_mailbox_message_index[\s\S]*mailbox_related_tools/);
const refreshMailbox = mailbox.slice(mailbox.indexOf(" async function reloadMailbox("), mailbox.indexOf(" function selectProfile("));
assert.match(refreshMailbox, /await loadProfiles\(\)[\s\S]*if \(selectedFolderGroup\) await refreshFolderCatalogue\(result.selected\)/);
assert.match(refreshMailbox, /requestAuthority !== authorityRef.current/);
assert.match(refreshMailbox, /profileId === selectedProfileIdRef.current/);
assert.match(refreshMailbox, /if \(!preservePreview\) setSelectedMessage\(null\)/, "Failed preview refresh keeps the previously loaded message.");
assert.doesNotMatch(refreshMailbox, /sendMail|appendMail|moveMail|deleteMail|setFlags|createMail/, "Mailbox reload must remain provider-read-only.");
assert.match(mailbox, /onKeyDown=\{\(event\) => \{[\s\S]*event\.key === "Enter" \|\| event\.key === " "/); assert.match(mailbox, /onKeyDown=\{\(event\) => \{[\s\S]*event\.key === "Enter" \|\| event\.key === " "/);
assert.match(bounces, /DocumentationHelpLink/); assert.match(bounces, /DocumentationHelpLink/);
@@ -75,7 +102,8 @@ assert.doesNotMatch(`${profiles}\n${mailbox}\n${bounces}\n${legacyImport}\n${mod
assert.match(moduleSource, /"mail\.profiles"/); assert.match(moduleSource, /"mail\.profiles"/);
assert.match(styles, /@media \(max-width: 900px\)[\s\S]*\.mail-profile-transport-summary[\s\S]*grid-template-columns: 1fr/); assert.match(styles, /@media \(max-width: 900px\)[\s\S]*\.mail-profile-transport-summary[\s\S]*grid-template-columns: 1fr/);
assert.match(styles, /@media \(max-width: 1280px\)[\s\S]*\.mailbox-shell\.file-manager-shell[\s\S]*grid-template-columns:/); assert.match(styles, /@media \(max-width: 1280px\)[\s\S]*\.mailbox-shell\.file-manager-shell[\s\S]*grid-template-columns:/);
assert.match(styles, /@media \(max-width: 760px\)[\s\S]*\.mailbox-toolbar\.file-manager-toolbar[\s\S]*grid-template-columns: 1fr/); assert.doesNotMatch(styles, /\.mailbox-toolbar/, "Core owns workspace toolbar wrapping and action ordering.");
assert.match(styles, /@media \(max-width: 760px\)[\s\S]*\.mailbox-message-row[\s\S]*grid-template-columns: 1fr/);
for (const archetype of ["Directory/explorer", "Administration/configuration", "Effective-policy editor", "Evidence/reporting"]) { for (const archetype of ["Directory/explorer", "Administration/configuration", "Effective-policy editor", "Evidence/reporting"]) {
assert.match(migration, new RegExp(archetype.replace("/", "\\/"))); assert.match(migration, new RegExp(archetype.replace("/", "\\/")));
+18 -11
View File
@@ -272,11 +272,14 @@ export async function createMailAddressContact(
}); });
} }
export async function listMailServerProfiles(settings: ApiSettings, includeInactive = false, campaignId?: string): Promise<MailServerProfile[]> { type MailboxReadOptions = Pick<RequestInit, "cache" | "signal">;
return apiGetList<MailServerProfile, "profiles">(settings, "/api/v1/mail/profiles", "profiles", {
export async function listMailServerProfiles(settings: ApiSettings, includeInactive = false, campaignId?: string, options?: MailboxReadOptions): Promise<MailServerProfile[]> {
const response = await apiFetch<{ profiles?: MailServerProfile[] | null }>(settings, apiPath("/api/v1/mail/profiles", {
include_inactive: includeInactive ? true : undefined, include_inactive: includeInactive ? true : undefined,
campaign_id: campaignId campaign_id: campaignId
}); }), options);
return response.profiles ?? [];
} }
export async function fetchMailSettingsDelta( export async function fetchMailSettingsDelta(
@@ -346,6 +349,7 @@ export type MailPop3MessagePreview = {
size_bytes: number; size_bytes: number;
body_preview?: string | null; body_preview?: string | null;
already_imported: boolean; already_imported: boolean;
legacy_identity_conflict?: boolean;
}; };
export type MailPop3PreviewResponse = { export type MailPop3PreviewResponse = {
@@ -679,12 +683,12 @@ export async function listMailProfileImapFolders(
); );
} }
export async function listMailboxFolders(settings: ApiSettings, profileId: string, includeStatus = false, refresh = false, protocol: MailMailboxProtocol = "imap"): Promise<MailImapFolderListResponse> { export async function listMailboxFolders(settings: ApiSettings, profileId: string, includeStatus = false, refresh = false, protocol: MailMailboxProtocol = "imap", options?: MailboxReadOptions): Promise<MailImapFolderListResponse> {
return apiFetch<MailImapFolderListResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/folders`, { return apiFetch<MailImapFolderListResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/folders`, {
include_status: includeStatus ? true : undefined, include_status: includeStatus ? true : undefined,
refresh: refresh ? true : undefined, refresh: refresh ? true : undefined,
protocol protocol
})); }), options);
} }
export async function bootstrapMailbox( export async function bootstrapMailbox(
@@ -694,7 +698,8 @@ export async function bootstrapMailbox(
limit = 50, limit = 50,
offset = 0, offset = 0,
refresh = false, refresh = false,
protocol: MailMailboxProtocol = "imap" protocol: MailMailboxProtocol = "imap",
options?: MailboxReadOptions
): Promise<MailMailboxBootstrapResponse> { ): Promise<MailMailboxBootstrapResponse> {
return apiFetch<MailMailboxBootstrapResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/bootstrap`, { return apiFetch<MailMailboxBootstrapResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/bootstrap`, {
folder, folder,
@@ -702,7 +707,7 @@ export async function bootstrapMailbox(
offset, offset,
refresh: refresh ? true : undefined, refresh: refresh ? true : undefined,
protocol protocol
})); }), options);
} }
export async function listMailboxMessages( export async function listMailboxMessages(
@@ -714,7 +719,8 @@ export async function listMailboxMessages(
cursor?: string | null, cursor?: string | null,
refresh = false, refresh = false,
protocol: MailMailboxProtocol = "imap", protocol: MailMailboxProtocol = "imap",
query?: string | null query?: string | null,
options?: MailboxReadOptions
): Promise<MailMailboxMessageListResponse> { ): Promise<MailMailboxMessageListResponse> {
return apiFetch<MailMailboxMessageListResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/messages`, { return apiFetch<MailMailboxMessageListResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/messages`, {
folder, folder,
@@ -724,7 +730,7 @@ export async function listMailboxMessages(
refresh: refresh ? true : undefined, refresh: refresh ? true : undefined,
protocol, protocol,
q: query || undefined q: query || undefined
})); }), options);
} }
export async function getMailboxMessage( export async function getMailboxMessage(
@@ -732,9 +738,10 @@ export async function getMailboxMessage(
profileId: string, profileId: string,
folder: string, folder: string,
uid: string, uid: string,
protocol: MailMailboxProtocol = "imap" protocol: MailMailboxProtocol = "imap",
options?: MailboxReadOptions
): Promise<MailMailboxMessageResponse> { ): Promise<MailMailboxMessageResponse> {
return apiFetch<MailMailboxMessageResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/messages/${encodeURIComponent(uid)}`, { folder, protocol })); return apiFetch<MailMailboxMessageResponse>(settings, apiPath(`/api/v1/mail/profiles/${encodeURIComponent(profileId)}/mailbox/messages/${encodeURIComponent(uid)}`, { folder, protocol }), options);
} }
export async function getMailboxChanges( export async function getMailboxChanges(
+1 -1
View File
@@ -196,13 +196,13 @@ export default function MailBouncePage({ settings }: { settings: ApiSettings })
<PageLayout <PageLayout
archetype="collection" archetype="collection"
title="Bounce processing" title="Bounce processing"
titleHelp={<DocumentationHelpLink reference={MAIL_BOUNCE_DOCUMENTATION} />}
description="Watch IMAP delivery-status folders and correlate recipient failures with Mail delivery commands." description="Watch IMAP delivery-status folders and correlate recipient failures with Mail delivery commands."
actions={<PageActionBar actions={<PageActionBar
variant="collection" variant="collection"
refreshable refreshable
reloadAction={{ onReload: () => void load(), disabled: Boolean(pageMutationBlocker), disabledReason: pageMutationBlocker }} reloadAction={{ onReload: () => void load(), disabled: Boolean(pageMutationBlocker), disabledReason: pageMutationBlocker }}
contextActions={<Button onClick={() => navigate("/mail")}><ArrowLeft size={16} aria-hidden="true" /> Mailbox</Button>} contextActions={<Button onClick={() => navigate("/mail")}><ArrowLeft size={16} aria-hidden="true" /> Mailbox</Button>}
helpAction={<DocumentationHelpLink reference={MAIL_BOUNCE_DOCUMENTATION} />}
createAction={<Button variant="primary" onClick={() => setAddOpen(true)} disabled={Boolean(addWatcherBlocker)} disabledReason={addWatcherBlocker}><Plus size={16} aria-hidden="true" /> Add watcher</Button>} createAction={<Button variant="primary" onClick={() => setAddOpen(true)} disabled={Boolean(addWatcherBlocker)} disabledReason={addWatcherBlocker}><Plus size={16} aria-hidden="true" /> Add watcher</Button>}
/>} />}
loading={loading} loading={loading}
@@ -189,7 +189,7 @@ export default function MailLegacyImportPage({
}); });
setPreview(next); setPreview(next);
setSelectedUidls((current) => setSelectedUidls((current) =>
current.filter((uidl) => next.messages.some((item) => item.uidl === uidl && !item.already_imported)) current.filter((uidl) => next.messages.some((item) => item.uidl === uidl && !item.already_imported && !item.legacy_identity_conflict))
); );
} catch (reason) { } catch (reason) {
setError(adminErrorMessage(reason)); setError(adminErrorMessage(reason));
@@ -341,7 +341,7 @@ export default function MailLegacyImportPage({
data-help-context-id="mail.pop3.field.message-selection" data-help-context-id="mail.pop3.field.message-selection"
data-help-module-id="mail" data-help-module-id="mail"
checked={selectedUidls.includes(item.uidl)} checked={selectedUidls.includes(item.uidl)}
disabled={Boolean(busy) || item.already_imported} disabled={Boolean(busy) || item.already_imported || item.legacy_identity_conflict}
onChange={() => setSelectedUidls((current) => onChange={() => setSelectedUidls((current) =>
current.includes(item.uidl) current.includes(item.uidl)
? current.filter((uidl) => uidl !== item.uidl) ? current.filter((uidl) => uidl !== item.uidl)
@@ -362,8 +362,8 @@ export default function MailLegacyImportPage({
id: "state", id: "state",
header: "State", header: "State",
width: 130, width: 130,
value: (item) => item.already_imported ? "imported" : "available", value: (item) => item.legacy_identity_conflict ? "legacy identity conflict" : item.already_imported ? "imported" : "available",
render: (item) => <StatusBadge status={item.already_imported ? "inactive" : "success"} label={item.already_imported ? "imported" : "available"} /> render: (item) => <StatusBadge status={item.legacy_identity_conflict ? "warning" : item.already_imported ? "inactive" : "success"} label={item.legacy_identity_conflict ? "review legacy identity" : item.already_imported ? "imported" : "available"} />
} }
]; ];
@@ -379,6 +379,7 @@ export default function MailLegacyImportPage({
<PageLayout <PageLayout
archetype="collection" archetype="collection"
title="Legacy POP3 import" title="Legacy POP3 import"
titleHelp={<DocumentationHelpLink reference={DOCUMENTATION} />}
description="Migrate bounded messages into encrypted local review records. POP3 is disabled by default and is not recommended for ongoing mailbox access." description="Migrate bounded messages into encrypted local review records. POP3 is disabled by default and is not recommended for ongoing mailbox access."
helpContextId="mail.pop3" helpContextId="mail.pop3"
helpModuleId="mail" helpModuleId="mail"
@@ -388,7 +389,6 @@ export default function MailLegacyImportPage({
refreshable refreshable
reloadAction={{ onReload: () => void load(), helpContextId: "mail.pop3.action.reload", helpModuleId: "mail", helpTopicId: "mail.workflow.legacy-pop3-import", disabled: Boolean(busy), disabledReason: busy ? "Wait for the current POP3 action to finish." : undefined }} reloadAction={{ onReload: () => void load(), helpContextId: "mail.pop3.action.reload", helpModuleId: "mail", helpTopicId: "mail.workflow.legacy-pop3-import", disabled: Boolean(busy), disabledReason: busy ? "Wait for the current POP3 action to finish." : undefined }}
contextActions={<Button onClick={() => navigate("/mail")}><ArrowLeft size={16} aria-hidden="true" /> Mailbox</Button>} contextActions={<Button onClick={() => navigate("/mail")}><ArrowLeft size={16} aria-hidden="true" /> Mailbox</Button>}
helpAction={<DocumentationHelpLink reference={DOCUMENTATION} />}
createAction={canManage ? <Button helpContextId="mail.pop3.action.create-source" helpModuleId="mail" helpTopicId="mail.workflow.legacy-pop3-import" variant="primary" onClick={() => openSourceDialog(null)} disabled={Boolean(busy) || configurableProfiles.length === 0} disabledReason={configurableProfiles.length === 0 ? "Create or gain write access to a Mail profile first." : undefined}><Plus size={16} aria-hidden="true" /> Add legacy source</Button> : undefined} createAction={canManage ? <Button helpContextId="mail.pop3.action.create-source" helpModuleId="mail" helpTopicId="mail.workflow.legacy-pop3-import" variant="primary" onClick={() => openSourceDialog(null)} disabled={Boolean(busy) || configurableProfiles.length === 0} disabledReason={configurableProfiles.length === 0 ? "Create or gain write access to a Mail profile first." : undefined}><Plus size={16} aria-hidden="true" /> Add legacy source</Button> : undefined}
/>} />}
loading={loading} loading={loading}
@@ -1,46 +1,8 @@
import { useEffect, useMemo, useState, type ReactNode } from "react"; import { useEffect, useMemo, useState, type ReactNode } from "react";
import { ActionToolbar, FormGrid, ActionBlockerHint, AdminSelectionList, ConnectionTree, DocumentationHelpLink, FieldLabel, LoadingFrame, MailServerSettingsPanel, PolicyLockedHint, PolicyPathHelp, PolicyRow, PolicySourcePath, PolicyTable, StageRail, StatusBadge, TableActionGroup, ToggleSwitch, hasMailImapSettings, mailImapSettingsPayload, mailServerSecurityOptions, mailSmtpSettingsPayload, mailTextOrNull, mailTransportCredentialsPayload, mergeDeltaRows, normalizeMailImapFolderMappings, normalizeMailServerSecurity, normalizePolicySourcePathItems, useDeltaWatermarks, type ConnectionTreeColumn, type MailImapFolderMappings, type MailImapFolderListResponse, type MailJmapTransportSettings, type MailServerConnectionTestResult, type MailServerCredentialSettings, type MailServerImapSettings, type MailServerSmtpSettings, type NormalizedPolicySourcePathItem, type PolicySourcePathItem } from "@govoplan/core-webui"; import { FormGrid, ActionBlockerHint, ConnectionTree, DocumentationHelpLink, LoadingFrame, MailServerSettingsPanel, StageRail, StatusBadge, TableActionGroup, ToggleSwitch, hasMailImapSettings, mailImapSettingsPayload, mailServerSecurityOptions, mailSmtpSettingsPayload, mailTextOrNull, mailTransportCredentialsPayload, mergeDeltaRows, normalizeMailImapFolderMappings, normalizeMailServerSecurity, useDeltaWatermarks, type ConnectionTreeColumn, type MailImapFolderMappings, type MailImapFolderListResponse, type MailJmapTransportSettings, type MailServerConnectionTestResult, type MailServerCredentialSettings, type MailServerImapSettings, type MailServerSmtpSettings } from "@govoplan/core-webui";
import { ArrowLeft, ArrowRight, Inbox, KeyRound, Link2, Pencil, Plus, Send, Settings2, Trash2, Unlink } from "lucide-react"; import { ArrowLeft, ArrowRight, Inbox, KeyRound, Link2, Pencil, Plus, Send, Settings2, Trash2, Unlink } from "lucide-react";
import type { ApiSettings } from "../../types"; import type { ApiSettings } from "../../types";
import { import { bindMailServerCredential, createMailServerCredential, createMailServerEndpoint, createMailServerProfile, deactivateMailServerEndpoint, deactivateMailServerProfile, fetchMailSettingsDelta, listImapFolders, listMailProfileImapFolders, listAvailableMailCredentials, testImapSettings, testMailProfileImap, testMailProfileJmap, testMailProfileSmtp, testSmtpSettings, unlinkMailServerCredential, updateMailServerCredential, updateMailServerEndpoint, updateMailServerProfile, type MailCredentialEnvelope, type MailImapTestPayload, type MailProfilePolicy, type MailProfileScope, type MailSecurity, type MailServerEndpoint, type MailServerProfile, type MailServerProfilePayload, type MailServerProfileUpdatePayload, type MailSmtpTestPayload } from "../../api/mail";
bindMailServerCredential,
createMailServerCredential,
createMailServerEndpoint,
createMailServerProfile,
deactivateMailServerEndpoint,
deactivateMailServerProfile,
fetchMailSettingsDelta,
getMailProfilePolicy,
listImapFolders,
listMailProfileImapFolders,
mailProfilePatternKeys,
mailProfilePolicyLimitKeys,
listAvailableMailCredentials,
updateMailProfilePolicy,
testImapSettings,
testMailProfileImap,
testMailProfileJmap,
testMailProfileSmtp,
testSmtpSettings,
unlinkMailServerCredential,
updateMailServerCredential,
updateMailServerEndpoint,
updateMailServerProfile,
type MailCredentialEnvelope,
type MailCredentialPolicy,
type MailImapTestPayload,
type MailProfilePatternKey,
type MailProfilePatternRules,
type MailProfilePolicy,
type MailProfilePolicyLimitKey,
type MailProfileScope,
type MailSecurity,
type MailServerEndpoint,
type MailServerProfile,
type MailServerProfilePayload,
type MailServerProfileUpdatePayload,
type MailSmtpTestPayload } from
"../../api/mail";
import { validateMailPolicy } from "./mailPolicyValidation"; import { validateMailPolicy } from "./mailPolicyValidation";
import { Button } from "@govoplan/core-webui"; import { Button } from "@govoplan/core-webui";
import { Card } from "@govoplan/core-webui"; import { Card } from "@govoplan/core-webui";
@@ -48,29 +10,10 @@ import { ConfirmDialog } from "@govoplan/core-webui";
import { Dialog } from "@govoplan/core-webui"; import { Dialog } from "@govoplan/core-webui";
import { DismissibleAlert } from "@govoplan/core-webui"; import { DismissibleAlert } from "@govoplan/core-webui";
import { FormField, i18nMessage, useUnsavedDraftGuard } from "@govoplan/core-webui"; import { FormField, i18nMessage, useUnsavedDraftGuard } from "@govoplan/core-webui";
import { import { ReferenceMultiSelect, customReferenceOption, platformModuleReferenceProvider, staticReferenceOptionProvider, usePlatformLanguage, usePlatformModules, type ReferenceOption } from "@govoplan/core-webui";
ReferenceMultiSelect, import { mailProfileEditTargetInitialSection, mailProfileEditTargetPanelMode, mailProfileEditTargetShowsProfileFields, mailProfileEditTargetShowsSettingsPanel, mailProfileEditTargetVisibleSections, mailProfileCreateStageCanContinue, mailProfileCreateStagePanel, mailProfileCreateStages, mailProfileCreateCredentialsPayload, type MailProfileCreateStage, type MailProfileEditTarget, type MailProfileProtocol } from "./mailProfileEditorModel";
customReferenceOption, import { MailProfilePolicyEditor, errorMessage, MAIL_PROFILE_DOCUMENTATION, scopeLabel, transportLabel, scopeOrder } from "./MailProfilePolicyEditor";
platformModuleReferenceProvider, export { MailProfilePolicyEditor } from "./MailProfilePolicyEditor";
staticReferenceOptionProvider,
usePlatformLanguage,
usePlatformModules,
type ReferenceOption
} from "@govoplan/core-webui";
import {
mailProfileEditTargetInitialSection,
mailProfileEditTargetPanelMode,
mailProfileEditTargetShowsProfileFields,
mailProfileEditTargetShowsSettingsPanel,
mailProfileEditTargetVisibleSections,
mailProfileCreateStageCanContinue,
mailProfileCreateStagePanel,
mailProfileCreateStages,
mailProfileCreateCredentialsPayload,
type MailProfileCreateStage,
type MailProfileEditTarget,
type MailProfileProtocol
} from "./mailProfileEditorModel";
export type MailProfileTargetOption = { export type MailProfileTargetOption = {
id: string; id: string;
label: string; label: string;
@@ -131,23 +74,8 @@ type MailProfileScopeManagerProps = {
canWritePolicy: boolean; canWritePolicy: boolean;
}; };
type MailProfilePolicyEditorProps = {
settings: ApiSettings;
scopeType: MailProfileScope;
scopeId?: string | null;
campaignId?: string | null;
profiles: MailServerProfile[];
ownerUserId?: string | null;
ownerGroupId?: string | null;
canWrite: boolean;
locked?: boolean;
title?: string;
description?: string;
onSaved?: () => void | Promise<void>;
};
type EditingProfile = MailServerProfile | "new" | null; type EditingProfile = MailServerProfile | "new" | null;
type PolicyFlagValue = "inherit" | "allow" | "deny";
type MailProfileTreeRow = type MailProfileTreeRow =
{kind: "profile";id: string;profile: MailServerProfile;} | {kind: "profile";id: string;profile: MailServerProfile;} |
{kind: "server";id: string;profile: MailServerProfile;protocol: MailProfileProtocol;server: MailServerEndpoint;} | {kind: "server";id: string;profile: MailServerProfile;protocol: MailProfileProtocol;server: MailServerEndpoint;} |
@@ -160,36 +88,13 @@ type PendingHierarchyRemoval =
const securityOptions = mailServerSecurityOptions as readonly MailSecurity[]; const securityOptions = mailServerSecurityOptions as readonly MailSecurity[];
const MAIL_PROFILE_DOCUMENTATION = {
topicId: "mail.profiles-and-policy",
documentationType: "admin"
} as const;
const MAIL_PROFILE_WORKFLOW_DOCUMENTATION = { const MAIL_PROFILE_WORKFLOW_DOCUMENTATION = {
topicId: "mail.workflow.choose-and-test-profile", topicId: "mail.workflow.choose-and-test-profile",
documentationType: "user" documentationType: "user"
} as const; } as const;
const patternLabels: Record<MailProfilePatternKey, string> = {
smtp_hosts: "i18n:govoplan-mail.smtp_hostnames.36eb51d8",
imap_hosts: "i18n:govoplan-mail.imap_hostnames.ac9c1d78",
jmap_hosts: "JMAP hostnames",
envelope_senders: "i18n:govoplan-mail.envelope_senders.269065cd",
from_headers: "i18n:govoplan-mail.from_headers.b3ea473b",
recipient_domains: "i18n:govoplan-mail.recipient_domains.cb9b7b44"
};
const blankPolicy: MailProfilePolicy = {
allowed_profile_ids: [],
allow_user_profiles: null,
allow_group_profiles: null,
allow_campaign_profiles: null,
smtp_credentials: {},
imap_credentials: {},
whitelist: {},
blacklist: {},
allow_lower_level_limits: {}
};
export function MailProfileScopeManager({ export function MailProfileScopeManager({
settings, settings,
@@ -725,9 +630,9 @@ export function MailProfileScopeManager({
<> <>
<Card <Card
title={profileTitle} title={profileTitle}
titleHelp={<DocumentationHelpLink reference={MAIL_PROFILE_DOCUMENTATION} />}
actions={ actions={
<div className="button-row compact-actions"> <div className="button-row compact-actions">
<DocumentationHelpLink reference={MAIL_PROFILE_DOCUMENTATION} />
<Button onClick={() => void loadProfiles()} disabled={Boolean(profileReloadBlocker)} disabledReason={profileReloadBlocker}>{loading ? "i18n:govoplan-mail.loading.33ce4174" : "i18n:govoplan-mail.reload.cce71553"}</Button> <Button onClick={() => void loadProfiles()} disabled={Boolean(profileReloadBlocker)} disabledReason={profileReloadBlocker}>{loading ? "i18n:govoplan-mail.loading.33ce4174" : "i18n:govoplan-mail.reload.cce71553"}</Button>
<Button variant="primary" onClick={openCreate} disabled={Boolean(profileMutationBlocker)} disabledReason={profileMutationBlocker}><Plus size={16} />i18n:govoplan-mail.new_profile.ca36da25</Button> <Button variant="primary" onClick={openCreate} disabled={Boolean(profileMutationBlocker)} disabledReason={profileMutationBlocker}><Plus size={16} />i18n:govoplan-mail.new_profile.ca36da25</Button>
</div> </div>
@@ -856,296 +761,6 @@ export function MailProfileScopeManager({
} }
export function MailProfilePolicyEditor({
settings,
scopeType,
scopeId = null,
campaignId = null,
profiles,
ownerUserId = null,
ownerGroupId = null,
canWrite,
locked = false,
title = "i18n:govoplan-mail.mail_profile_policy.f2ac4b92",
description = "i18n:govoplan-mail.allowed_profiles_and_wildcard_rules_for_this_sco.0f82b3e4",
onSaved
}: MailProfilePolicyEditorProps) {
const [policy, setPolicy] = useState<MailProfilePolicy>(blankPolicy);
const [effectivePolicy, setEffectivePolicy] = useState<MailProfilePolicy | null>(null);
const [parentPolicy, setParentPolicy] = useState<MailProfilePolicy | null>(null);
const [effectivePolicySources, setEffectivePolicySources] = useState<PolicySourcePathItem[]>([]);
const [savedPolicyKey, setSavedPolicyKey] = useState(policyDraftKey(blankPolicy));
const [loading, setLoading] = useState(false);
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
const [success, setSuccess] = useState("");
const [profileEffectivePolicy, setProfileEffectivePolicy] = useState<MailProfilePolicy | null>(null);
const requiresTarget = scopeType === "user" || scopeType === "group" || scopeType === "campaign";
const scopeReady = !requiresTarget || Boolean(scopeId);
const policyDirty = scopeReady && policyDraftKey(policy) !== savedPolicyKey;
useUnsavedDraftGuard({
dirty: policyDirty,
onSave: savePolicy,
onDiscard: () => setPolicy(JSON.parse(savedPolicyKey) as MailProfilePolicy)
});
useEffect(() => {void loadPolicy();}, [settings.accessToken, settings.apiBaseUrl, settings.apiKey, scopeType, scopeId, campaignId]);
async function loadPolicy() {
setError("");
setSuccess("");
if (!scopeReady) {
setPolicy(blankPolicy);
setSavedPolicyKey(policyDraftKey(blankPolicy));
setEffectivePolicy(null);
setParentPolicy(null);
setEffectivePolicySources([]);
return;
}
setLoading(true);
try {
const response = await getMailProfilePolicy(settings, scopeType, scopeId, campaignId);
const loadedPolicy = normalizePolicy(response.policy);
setPolicy(loadedPolicy);
setSavedPolicyKey(policyDraftKey(loadedPolicy));
setEffectivePolicy(response.effective_policy ? normalizePolicy(response.effective_policy) : null);
setParentPolicy(response.parent_policy ? normalizePolicy(response.parent_policy) : null);
setEffectivePolicySources(response.effective_policy_sources ?? []);
} catch (err) {
setPolicy(blankPolicy);
setSavedPolicyKey(policyDraftKey(blankPolicy));
setEffectivePolicy(null);
setParentPolicy(null);
setEffectivePolicySources([]);
setError(errorMessage(err));
} finally {
setLoading(false);
}
}
async function savePolicy(): Promise<boolean> {
if (!scopeReady) return false;
setBusy(true);
setError("");
setSuccess("");
try {
const response = await updateMailProfilePolicy(settings, scopeType, normalizePolicyForSave(policy, parentPolicy, scopeType), scopeId);
const savedPolicy = normalizePolicy(response.policy);
setPolicy(savedPolicy);
setSavedPolicyKey(policyDraftKey(savedPolicy));
setEffectivePolicy(response.effective_policy ? normalizePolicy(response.effective_policy) : null);
setParentPolicy(response.parent_policy ? normalizePolicy(response.parent_policy) : null);
setEffectivePolicySources(response.effective_policy_sources ?? []);
setSuccess("i18n:govoplan-mail.mail_profile_policy_saved.666847bf");
await onSaved?.();
return true;
} catch (err) {
setError(errorMessage(err));
return false;
} finally {
setBusy(false);
}
}
const candidateProfiles = useMemo(
() => profileCandidatesForPolicy(profiles, scopeType, scopeId, ownerUserId, ownerGroupId),
[ownerGroupId, ownerUserId, profiles, scopeId, scopeType]
);
const isSystem = scopeType === "system";
const displayPolicy = useMemo(() => isSystem ? concreteSystemPolicy(policy) : policy, [isSystem, policy]);
const selectedProfileIds = new Set(policy.allowed_profile_ids ?? []);
const disabled = locked || busy || loading || !canWrite || !scopeReady;
const policySaveBlocker = mailPolicyDisabledReason(locked, canWrite, scopeReady, loading, busy, policyDirty);
const parentAllowedProfileIds = parentPolicy?.allowed_profile_ids?.length ? new Set(parentPolicy.allowed_profile_ids) : null;
const parentBlocksUserProfiles = parentPolicy?.allow_user_profiles === false;
const parentBlocksGroupProfiles = parentPolicy?.allow_group_profiles === false;
const parentBlocksCampaignProfiles = parentPolicy?.allow_campaign_profiles === false;
const showAllowColumn = scopeType !== "campaign";
const showEffectiveColumn = !isSystem;
const profileAllowListLocked = !parentAllowsMailLimit("allowed_profile_ids");
const blockedProfileDefinitions = [
parentBlocksUserProfiles ? "user" : "",
parentBlocksGroupProfiles ? "group" : "",
parentBlocksCampaignProfiles ? "i18n:govoplan-mail.campaign_local_settings.920ecb62" : ""].
filter(Boolean).join(", ");
const effectivePolicyPath = effectivePolicySources.length > 0 ? effectivePolicySources : mailPolicySourcePath(scopeType);
function patchPolicy(patch: Partial<MailProfilePolicy>) {
setPolicy((current) => normalizePolicy({ ...current, ...patch }));
}
function setFlag(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", value: PolicyFlagValue) {
patchPolicy({ [key]: flagToBoolean(value) });
}
function setPattern(kind: "whitelist" | "blacklist", key: MailProfilePatternKey, text: string) {
const nextRules = { ...(policy[kind] ?? {}) };
const parsed = parsePatternList(text);
if (parsed.length > 0) nextRules[key] = parsed;else
delete nextRules[key];
patchPolicy({ [kind]: nextRules });
}
function parentAllowsMailLimit(key: MailProfilePolicyLimitKey): boolean {
return !parentPolicy || parentPolicy.allow_lower_level_limits?.[key] !== false;
}
function localAllowsMailLimit(key: MailProfilePolicyLimitKey): boolean {
const localValue = policy.allow_lower_level_limits?.[key];
if (localValue !== undefined) return localValue && parentAllowsMailLimit(key);
return parentAllowsMailLimit(key);
}
function setAllowLowerLevelLimit(key: MailProfilePolicyLimitKey, allowed: boolean) {
patchPolicy({ allow_lower_level_limits: { ...(policy.allow_lower_level_limits ?? {}), [key]: allowed } });
}
function lowerLevelLimitToggle(key: MailProfilePolicyLimitKey, label: ReactNode = "i18n:govoplan-mail.allow_override.ffa6e9a0"): ReactNode | undefined {
if (!showAllowColumn) return undefined;
const parentLocked = !parentAllowsMailLimit(key);
return (
<ToggleSwitch
checked={localAllowsMailLimit(key)}
disabled={disabled || parentLocked}
onChange={(checked) => setAllowLowerLevelLimit(key, checked)}
label={label} />);
}
return (
<Card
title={title}
actions={
<div className="button-row compact-actions">
<DocumentationHelpLink reference={MAIL_PROFILE_DOCUMENTATION} />
<Button onClick={() => void loadPolicy()} disabled={loading || busy || !scopeReady} disabledReason={loading ? "Mail policy is already loading." : busy ? "Wait for the current policy change to finish." : !scopeReady ? "Select a policy target before reloading." : undefined}>{loading ? "i18n:govoplan-mail.loading.33ce4174" : "i18n:govoplan-mail.reload.cce71553"}</Button>
<Button variant="primary" onClick={() => void savePolicy()} disabled={Boolean(policySaveBlocker)} disabledReason={policySaveBlocker}>{busy ? "i18n:govoplan-mail.saving.56a2285c" : "i18n:govoplan-mail.save_policy.77d67ce3"}</Button>
</div>
}>
<LoadingFrame loading={loading} label="i18n:govoplan-mail.loading_mail_profile_policy.b746a2e8">
<div className="mail-policy-editor">
{(locked || !canWrite || !scopeReady) &&
<ActionBlockerHint
tone={locked ? "warning" : "info"}
reason={mailPolicyBlockerReason(locked, canWrite, scopeReady)}
documentation={MAIL_PROFILE_DOCUMENTATION} />
}
{description && <p className="muted small-note mail-policy-description">{description}</p>}
{error && <DismissibleAlert tone="danger" resetKey={error} floating>{error}</DismissibleAlert>}
{success && <DismissibleAlert tone="success" resetKey={success} floating>{success}</DismissibleAlert>}
<section className="mail-policy-section policy-section">
<ActionToolbar surface="section-header" className="subsection-heading split">
<h3>i18n:govoplan-mail.profile_allow_list.507dfe6c</h3>
<div className="button-row compact-actions">
{lowerLevelLimitToggle("allowed_profile_ids")}
<Button onClick={() => patchPolicy({ allowed_profile_ids: [] })} disabled={disabled || profileAllowListLocked || selectedProfileIds.size === 0}>i18n:govoplan-mail.clear_allow_list.f69c8c67</Button>
</div>
</ActionToolbar>
<p className="muted small-note">{selectedProfileIds.size === 0 ? "i18n:govoplan-mail.no_local_profile_allow_list_is_set.31072e39" : i18nMessage("i18n:govoplan-mail.value_profile_s_allowed_by_this_scope.6fe9ba44", { value0: selectedProfileIds.size })}</p>
<AdminSelectionList
options={candidateProfiles.map((profile) => ({
id: profile.id,
label: profile.name,
description: `${scopeLabel(profile)} · ${transportLabel(profile.smtp)}`,
disabled: disabled || profileAllowListLocked || Boolean(parentAllowedProfileIds && !parentAllowedProfileIds.has(profile.id) && !selectedProfileIds.has(profile.id))
}))}
selected={[...selectedProfileIds]}
onChange={(allowedProfileIds) => patchPolicy({ allowed_profile_ids: [...allowedProfileIds].sort() })}
emptyText="i18n:govoplan-mail.no_profiles_are_visible_for_this_policy_scope.1ec7bd85"
/>
{parentAllowedProfileIds && <p className="muted small-note">i18n:govoplan-mail.an_ancestor_allow_list_limits_selectable_profile.499ec179 {parentAllowedProfileIds.size} i18n:govoplan-mail.profile_s.742e9200</p>}
</section>
<section className="mail-policy-section policy-section">
<h3>i18n:govoplan-mail.lower_level_mail_definitions.d39a0a1d</h3>
<PolicyTable className="mail-policy-table" rowClassName="mail-policy-row" headerClassName="mail-policy-row-header" fieldLabel="i18n:govoplan-mail.policy.bb9cf141" settingLabel={isSystem ? "i18n:govoplan-mail.value.8dce170d" : "i18n:govoplan-mail.local_setting.967607a9"} effectiveLabel="i18n:govoplan-mail.effective_policy.feedb950" lowerLevelLabel="i18n:govoplan-mail.lower_levels.940821ee" showAllowColumn={showAllowColumn} showEffectiveColumn={showEffectiveColumn}>
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.user_profiles.57730285"
help={policyHelp("i18n:govoplan-mail.controls_whether_user_scoped_mail_profiles_may_b.00c0e0e7")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_user_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_user_profiles")} allowDisabled={parentBlocksUserProfiles} onChange={(value) => setFlag("allow_user_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_user_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_user_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_user_profiles", effectivePolicyPath) : undefined} />
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.group_profiles.74568838"
help={policyHelp("i18n:govoplan-mail.controls_whether_group_scoped_mail_profiles_may_.0b832ea4")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_group_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_group_profiles")} allowDisabled={parentBlocksGroupProfiles} onChange={(value) => setFlag("allow_group_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_group_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_group_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_group_profiles", effectivePolicyPath) : undefined} />
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.campaign_local_settings.eb0f1061"
help={policyHelp("i18n:govoplan-mail.controls_whether_campaigns_may_use_inline_smtp_i.fa45cbbc")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_campaign_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_campaign_profiles")} allowDisabled={parentBlocksCampaignProfiles} onChange={(value) => setFlag("allow_campaign_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_campaign_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_campaign_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_campaign_profiles", effectivePolicyPath) : undefined} />
</PolicyTable>
{blockedProfileDefinitions && <PolicyLockedHint>i18n:govoplan-mail.explicit_allow_is_unavailable_for.8d05fd4a {blockedProfileDefinitions} i18n:govoplan-mail.because_an_ancestor_policy_blocks_those_definiti.5de3e30d</PolicyLockedHint>}
</section>
<section className="mail-policy-section policy-section">
<h3>i18n:govoplan-mail.wildcard_rules.54fb3fc0</h3>
<div className={`mail-policy-pattern-table policy-table${showAllowColumn ? " with-allow-column" : ""}`}>
<div className="mail-policy-pattern-row policy-row mail-policy-row-header policy-row-header">
<span>i18n:govoplan-mail.policy_target.a19dcee9</span>
<span>i18n:govoplan-mail.whitelist.53c2ad30</span>
<span>i18n:govoplan-mail.blacklist.7b2dd04c</span>
{showAllowColumn && <span>i18n:govoplan-mail.lower_levels.940821ee</span>}
</div>
{mailProfilePatternKeys.map((key) =>
<div className="mail-policy-pattern-row policy-row" key={key}>
<div className="mail-policy-field-label policy-field-label">
<FieldLabel className="mail-policy-field-title policy-field-title" help={policyHelp(patternPolicyNote(key))}>{patternLabels[key]}</FieldLabel>
</div>
<PatternTextareaControl value={patternsToText(policy.whitelist?.[key])} disabled={disabled || !parentAllowsMailLimit(`whitelist.${key}` as MailProfilePolicyLimitKey)} onChange={(text) => setPattern("whitelist", key, text)} />
<PatternTextareaControl value={patternsToText(policy.blacklist?.[key])} disabled={disabled || !parentAllowsMailLimit(`blacklist.${key}` as MailProfilePolicyLimitKey)} onChange={(text) => setPattern("blacklist", key, text)} />
{showAllowColumn &&
<div className="mail-policy-pattern-limits">
{lowerLevelLimitToggle(i18nMessage("i18n:govoplan-mail.whitelist_value.d4cc3755", { value0: key }) as MailProfilePolicyLimitKey, "i18n:govoplan-mail.whitelist.53c2ad30")}
{lowerLevelLimitToggle(i18nMessage("i18n:govoplan-mail.blacklist_value.556334d0", { value0: key }) as MailProfilePolicyLimitKey, "i18n:govoplan-mail.blacklist.7b2dd04c")}
</div>
}
</div>
)}
</div>
</section>
{showEffectiveColumn && effectivePolicy &&
<section className="mail-policy-section policy-section mail-policy-effective">
<h3>i18n:govoplan-mail.policy_path.1ba91ee5</h3>
<PolicySourcePath items={effectivePolicyPath} />
<p className="muted small-note">i18n:govoplan-mail.effective_values_are_shown_in_the_table_rows_abo.b27b900d</p>
</section>
}
</div>
</LoadingFrame>
</Card>);
}
function ProfileForm({ function ProfileForm({
settings, settings,
@@ -1632,20 +1247,7 @@ function ProfileForm({
} }
function PolicyFlagControl({ value, disabled, includeInherit = true, inheritOnly = false, allowDisabled = false, onChange }: {value: PolicyFlagValue;disabled: boolean;includeInherit?: boolean;inheritOnly?: boolean;allowDisabled?: boolean;onChange: (value: PolicyFlagValue) => void;}) {
const selectedValue = inheritOnly ? "inherit" : value;
return (
<select value={selectedValue} disabled={disabled} onChange={(event) => onChange(event.target.value as PolicyFlagValue)}>
{(includeInherit || inheritOnly) && <option value="inherit">i18n:govoplan-mail.inherit.18f99833</option>}
{!inheritOnly && <option value="allow" disabled={allowDisabled}>i18n:govoplan-mail.explicit_allow.6a7946f8</option>}
{!inheritOnly && <option value="deny">i18n:govoplan-mail.deny.53577bb5</option>}
</select>);
}
function PatternTextareaControl({ value, disabled, onChange }: {value: string;disabled: boolean;onChange: (value: string) => void;}) {
return <textarea rows={3} value={value} disabled={disabled} onChange={(event) => onChange(event.target.value)} placeholder="*.example.org" />;
}
function targetPluralLabel(scopeType: MailProfileScope, fallback: string): string { function targetPluralLabel(scopeType: MailProfileScope, fallback: string): string {
if (scopeType === "user") return "i18n:govoplan-mail.users"; if (scopeType === "user") return "i18n:govoplan-mail.users";
@@ -1982,50 +1584,7 @@ function mailProfileEditorDisabledReason(
return ""; return "";
} }
function mailPolicyDisabledReason(
locked: boolean,
canWrite: boolean,
scopeReady: boolean,
loading: boolean,
busy: boolean,
dirty: boolean
): string {
if (locked) return "This policy is locked by the owning workflow or a higher-scope decision.";
if (!canWrite) return "Mail policy administration permission is required to save changes.";
if (!scopeReady) return "Select a policy target before saving.";
if (loading) return "Wait until the effective Mail policy has loaded.";
if (busy) return "Wait for the current policy change to finish.";
if (!dirty) return "There are no unsaved Mail policy changes.";
return "";
}
function mailPolicyBlockerReason(locked: boolean, canWrite: boolean, scopeReady: boolean) {
if (locked) {
return {
summary: "This Mail policy is locked in the current context.",
details: "The effective values remain visible, but this workflow or a higher-scope decision owns the editable policy.",
requiredAction: "Change the owning policy or leave the governed workflow before editing.",
actor: "The administrator or workflow owner responsible for the source policy",
target: "The source shown in the effective policy path"
};
}
if (!scopeReady) {
return {
summary: "Select a target before editing Mail policy.",
details: "User, group, and campaign policy must be resolved against one concrete target.",
requiredAction: "Choose the target in the scope selector.",
actor: "Mail policy administrator",
target: "The target selector above"
};
}
return {
summary: "You can review effective Mail policy here, but cannot change it.",
details: "Policy changes require Mail policy administration authority at this scope.",
requiredAction: "Ask an authorized administrator to apply the change.",
actor: "System or tenant policy administrator",
target: "Administration > Mail profiles and policy"
};
}
function smtpServerPayload(draft: ProfileDraft): MailSmtpTestPayload { function smtpServerPayload(draft: ProfileDraft): MailSmtpTestPayload {
return mailSmtpSettingsPayload<MailSecurity>( return mailSmtpSettingsPayload<MailSecurity>(
@@ -2079,123 +1638,14 @@ function hasDraftImapSettings(draft: ProfileDraft): boolean {
return hasMailImapSettings([draft.imapHost]); return hasMailImapSettings([draft.imapHost]);
} }
function normalizePolicy(value: MailProfilePolicy | null | undefined): MailProfilePolicy {
return {
allowed_profile_ids: [...(value?.allowed_profile_ids ?? [])].filter(Boolean),
allow_user_profiles: value?.allow_user_profiles ?? null,
allow_group_profiles: value?.allow_group_profiles ?? null,
allow_campaign_profiles: value?.allow_campaign_profiles ?? null,
smtp_credentials: normalizeCredentialPolicy(value?.smtp_credentials),
imap_credentials: normalizeCredentialPolicy(value?.imap_credentials),
whitelist: normalizeRules(value?.whitelist),
blacklist: normalizeRules(value?.blacklist),
allow_lower_level_limits: normalizeMailLowerLevelLimits(value?.allow_lower_level_limits)
};
}
function policyDraftKey(policy: MailProfilePolicy): string {
return JSON.stringify(normalizePolicy(policy));
}
function normalizePolicyForSave(policy: MailProfilePolicy, parentPolicy: MailProfilePolicy | null, scopeType: MailProfileScope): MailProfilePolicy {
const normalized = normalizePolicy(policy);
if (scopeType === "system") return concreteSystemPolicy(normalized);
const localLimits = { ...(normalized.allow_lower_level_limits ?? {}) };
const parentLimits = parentPolicy?.allow_lower_level_limits ?? null;
function parentAllows(key: MailProfilePolicyLimitKey): boolean {
return !parentLimits || parentLimits[key] !== false;
}
function clearLimit(key: MailProfilePolicyLimitKey) {
delete localLimits[key];
}
if (!parentAllows("allowed_profile_ids")) {
normalized.allowed_profile_ids = [];
clearLimit("allowed_profile_ids");
}
for (const key of ["allow_user_profiles", "allow_group_profiles", "allow_campaign_profiles"] as const) {
if (!parentAllows(key)) {
normalized[key] = null;
clearLimit(key);
}
}
for (const protocol of ["smtp_credentials", "imap_credentials"] as const) {
const credential = normalizeCredentialPolicy(normalized[protocol]);
const inheritKey = `${protocol}.inherit` as MailProfilePolicyLimitKey;
if (!parentAllows(inheritKey)) {
credential.inherit = null;
clearLimit(inheritKey);
}
normalized[protocol] = credential;
}
for (const key of mailProfilePatternKeys) {
const whitelistKey = `whitelist.${key}` as MailProfilePolicyLimitKey;
const blacklistKey = `blacklist.${key}` as MailProfilePolicyLimitKey;
if (!parentAllows(whitelistKey)) {
delete normalized.whitelist?.[key];
clearLimit(whitelistKey);
}
if (!parentAllows(blacklistKey)) {
delete normalized.blacklist?.[key];
clearLimit(blacklistKey);
}
}
if (scopeType === "campaign") {
normalized.allow_lower_level_limits = {};
} else {
normalized.allow_lower_level_limits = localLimits;
}
return normalized;
}
function normalizeMailLowerLevelLimits(value: MailProfilePolicy["allow_lower_level_limits"]): Partial<Record<MailProfilePolicyLimitKey, boolean>> {
const result: Partial<Record<MailProfilePolicyLimitKey, boolean>> = {};
for (const key of mailProfilePolicyLimitKeys) {
if (typeof value?.[key] === "boolean") result[key] = value[key];
}
return result;
}
function fullMailLowerLevelLimits(value: MailProfilePolicy["allow_lower_level_limits"]): Record<MailProfilePolicyLimitKey, boolean> {
const result = {} as Record<MailProfilePolicyLimitKey, boolean>;
for (const key of mailProfilePolicyLimitKeys) {
result[key] = value?.[key] !== false;
}
return result;
}
function concreteSystemPolicy(policy: MailProfilePolicy): MailProfilePolicy {
const normalized = normalizePolicy(policy);
return {
...normalized,
allow_user_profiles: normalized.allow_user_profiles ?? true,
allow_group_profiles: normalized.allow_group_profiles ?? true,
allow_campaign_profiles: normalized.allow_campaign_profiles ?? true,
smtp_credentials: concreteSystemCredentialPolicy(normalized.smtp_credentials),
imap_credentials: concreteSystemCredentialPolicy(normalized.imap_credentials),
allow_lower_level_limits: fullMailLowerLevelLimits(normalized.allow_lower_level_limits)
};
}
function concreteSystemCredentialPolicy(value: MailCredentialPolicy | null | undefined): MailCredentialPolicy {
const normalized = normalizeCredentialPolicy(value);
return { inherit: normalized.inherit ?? true };
}
function normalizeCredentialPolicy(value: MailCredentialPolicy | null | undefined): MailCredentialPolicy {
return { inherit: typeof value?.inherit === "boolean" ? value.inherit : null };
}
function normalizeRules(value: MailProfilePatternRules | null | undefined): MailProfilePatternRules {
const result: MailProfilePatternRules = {};
for (const key of mailProfilePatternKeys) {
const patterns = (value?.[key] ?? []).map((pattern) => pattern.trim()).filter(Boolean);
if (patterns.length > 0) result[key] = patterns;
}
return result;
}
function profileBelongsToEditableScope(profile: MailServerProfile, scopeType: MailProfileScope, scopeId: string | null): boolean { function profileBelongsToEditableScope(profile: MailServerProfile, scopeType: MailProfileScope, scopeId: string | null): boolean {
if (profile.scope_type !== scopeType) return false; if (profile.scope_type !== scopeType) return false;
@@ -2204,135 +1654,29 @@ function profileBelongsToEditableScope(profile: MailServerProfile, scopeType: Ma
return Boolean(scopeId) && profile.scope_id === scopeId; return Boolean(scopeId) && profile.scope_id === scopeId;
} }
function profileCandidatesForPolicy(profiles: MailServerProfile[], scopeType: MailProfileScope, scopeId: string | null, ownerUserId: string | null, ownerGroupId: string | null): MailServerProfile[] {
return profiles.
filter((profile) => {
if (scopeType === "system") return profile.scope_type === "system";
if (profile.scope_type === "system" || profile.scope_type === "tenant") return true;
if (scopeType === "user") return profile.scope_type === "user" && profile.scope_id === scopeId;
if (scopeType === "group") return profile.scope_type === "group" && profile.scope_id === scopeId;
if (scopeType === "campaign") {
if (profile.scope_type === "campaign") return profile.scope_id === scopeId;
if (profile.scope_type === "user") return Boolean(ownerUserId) && profile.scope_id === ownerUserId;
if (profile.scope_type === "group") return Boolean(ownerGroupId) && profile.scope_id === ownerGroupId;
}
return false;
}).
sort((a, b) => `${scopeOrder(a.scope_type)}:${a.name}`.localeCompare(`${scopeOrder(b.scope_type)}:${b.name}`));
}
function scopeOrder(scopeType: MailProfileScope): number {
if (scopeType === "system") return 0;
if (scopeType === "tenant") return 1;
if (scopeType === "user" || scopeType === "group") return 2;
return 3;
}
function policyHelp(description: string): ReactNode {
return <span>{description}</span>;
}
function mailBooleanPolicyPathHelp(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", sources: PolicySourcePathItem[]): ReactNode {
return <PolicyPathHelp lines={mailBooleanPolicyPathLines(key, normalizePolicySourcePathItems(sources))} />;
}
function mailBooleanPolicyPathLines(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", items: NormalizedPolicySourcePathItem[]): string[] {
if (items.length === 0) return ["i18n:govoplan-mail.system_allow.ed6744b1"];
const lines: string[] = [];
for (const [index, item] of items.entries()) {
const policy = policySourceRecord(item);
const rawValue = policy[key];
const value = rawValue === true ? "i18n:govoplan-mail.allow.3ad0e369" : rawValue === false ? "i18n:govoplan-mail.deny.53577bb5" : "i18n:govoplan-mail.inherit.18f99833";
const lowerLocked = asRecord(policy.allow_lower_level_limits)[key] === false;
const stops = rawValue === false || lowerLocked;
lines.push(`${policyPathPrefix(index)}${item.label}: ${stops ? `${value} without override` : value}`);
if (stops) break;
}
return lines;
}
function policySourceRecord(item: NormalizedPolicySourcePathItem): Record<string, unknown> {
return asRecord(item.policy);
}
function asRecord(value: unknown): Record<string, unknown> {
return value && typeof value === "object" && !Array.isArray(value) ? value as Record<string, unknown> : {};
}
function policyPathPrefix(index: number): string {
return index === 0 ? "" : `${" ".repeat(index - 1)}> `;
}
function effectiveBooleanLabel(value: boolean | null | undefined, policy: MailProfilePolicy | null): string {
if (!policy) return "i18n:govoplan-mail.loading.b04ba49f";
return value ? "i18n:govoplan-mail.allowed.77c7b490" : "i18n:govoplan-mail.blocked.99613c74";
}
function patternPolicyNote(key: MailProfilePatternKey): string {
if (key === "smtp_hosts") return "i18n:govoplan-mail.smtp_server_host_patterns.cf6120c3";
if (key === "imap_hosts") return "i18n:govoplan-mail.imap_server_host_patterns.52b20b83";
if (key === "envelope_senders") return "i18n:govoplan-mail.smtp_envelope_sender_patterns.8c1fd95e";
if (key === "from_headers") return "i18n:govoplan-mail.visible_from_header_patterns.ea77d99d";
return "i18n:govoplan-mail.recipient_domain_patterns.68466f5b";
}
function booleanToFlag(value: boolean | null | undefined): PolicyFlagValue {
if (value === true) return "allow";
if (value === false) return "deny";
return "inherit";
}
function flagToBoolean(value: PolicyFlagValue): boolean | null {
if (value === "allow") return true;
if (value === "deny") return false;
return null;
}
function parsePatternList(value: string): string[] {
const seen = new Set<string>();
const result: string[] = [];
for (const item of value.split(/[\n,]+/)) {
const pattern = item.trim();
if (pattern && !seen.has(pattern)) {
seen.add(pattern);
result.push(pattern);
}
}
return result;
}
function patternsToText(value: string[] | undefined): string {
return (value ?? []).join("\n");
}
function effectiveProfileLabel(value: string[] | null | undefined): string { function effectiveProfileLabel(value: string[] | null | undefined): string {
if (!value || value.length === 0) return "i18n:govoplan-mail.no_explicit_intersection.f2d62c71"; if (!value || value.length === 0) return "i18n:govoplan-mail.no_explicit_intersection.f2d62c71";
return i18nMessage("i18n:govoplan-mail.value_profile_s.d6b9d0af", { value0: value.length }); return i18nMessage("i18n:govoplan-mail.value_profile_s.d6b9d0af", { value0: value.length });
} }
function mailPolicySourcePath(scopeType: MailProfileScope): string[] {
if (scopeType === "system") return ["i18n:govoplan-mail.system.bc0792d8"];
if (scopeType === "tenant") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78"];
if (scopeType === "user") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.user.9f8a2389"];
if (scopeType === "group") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.group.171a0606"];
return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.owner_policy.1e8df143", "i18n:govoplan-mail.campaign.69390e16"];
}
function transportLabel(transport: MailSmtpTestPayload | MailImapTestPayload | MailJmapTransportSettings | null | undefined): string {
if (!transport) return "i18n:govoplan-mail.not_configured.811931bb";
if ("session_url" in transport) return transport.session_url || "No Session URL";
const host = transport.host || "i18n:govoplan-mail.no_host.4c710d7d";
const port = transport.port ? `:${transport.port}` : "";
return `${host}${port}`;
}
function scopeLabel(profile: MailServerProfile): string {
if (profile.scope_type === "system") return "i18n:govoplan-mail.system.bc0792d8";
if (profile.scope_type === "tenant") return "i18n:govoplan-mail.tenant.3ca93c78";
if (profile.scope_type === "user") return "i18n:govoplan-mail.user.9f8a2389";
if (profile.scope_type === "group") return "i18n:govoplan-mail.group.171a0606";
return "i18n:govoplan-mail.campaign.69390e16";
}
function readSecurity(value: string, fallback: MailSecurity): MailSecurity { function readSecurity(value: string, fallback: MailSecurity): MailSecurity {
return normalizeMailServerSecurity<MailSecurity>(value, { fallback, allowedSecurity: securityOptions }); return normalizeMailServerSecurity<MailSecurity>(value, { fallback, allowedSecurity: securityOptions });
@@ -2365,7 +1709,3 @@ function jmapHostname(value: string): string {
return ""; return "";
} }
} }
function errorMessage(err: unknown): string {
return err instanceof Error ? err.message : String(err);
}
@@ -0,0 +1,712 @@
import { useEffect, useMemo, useState, type ReactNode } from "react";
import { ActionToolbar, ActionBlockerHint, AdminSelectionList, DocumentationHelpLink, FieldLabel, LoadingFrame, PolicyLockedHint, PolicyPathHelp, PolicyRow, PolicySourcePath, PolicyTable, ToggleSwitch, normalizePolicySourcePathItems, type MailJmapTransportSettings, type NormalizedPolicySourcePathItem, type PolicySourcePathItem } from "@govoplan/core-webui";
import type { ApiSettings } from "../../types";
import { getMailProfilePolicy, mailProfilePatternKeys, mailProfilePolicyLimitKeys, updateMailProfilePolicy, type MailCredentialPolicy, type MailImapTestPayload, type MailProfilePatternKey, type MailProfilePatternRules, type MailProfilePolicy, type MailProfilePolicyLimitKey, type MailProfileScope, type MailServerProfile, type MailSmtpTestPayload } from "../../api/mail";
import { Button } from "@govoplan/core-webui";
import { Card } from "@govoplan/core-webui";
import { DismissibleAlert } from "@govoplan/core-webui";
import { i18nMessage, usePlatformLanguage, useUnsavedDraftGuard } from "@govoplan/core-webui";
type MailProfilePolicyEditorProps = {
settings: ApiSettings;
scopeType: MailProfileScope;
scopeId?: string | null;
campaignId?: string | null;
profiles: MailServerProfile[];
ownerUserId?: string | null;
ownerGroupId?: string | null;
canWrite: boolean;
locked?: boolean;
title?: string;
description?: string;
onSaved?: () => void | Promise<void>;
};
type PolicyFlagValue = "inherit" | "allow" | "deny";
export const MAIL_PROFILE_DOCUMENTATION = {
topicId: "mail.profiles-and-policy",
documentationType: "admin"
} as const;
const patternLabels: Record<MailProfilePatternKey, string> = {
smtp_hosts: "i18n:govoplan-mail.smtp_hostnames.36eb51d8",
imap_hosts: "i18n:govoplan-mail.imap_hostnames.ac9c1d78",
jmap_hosts: "JMAP hostnames",
envelope_senders: "i18n:govoplan-mail.envelope_senders.269065cd",
from_headers: "i18n:govoplan-mail.from_headers.b3ea473b",
recipient_domains: "i18n:govoplan-mail.recipient_domains.cb9b7b44"
};
const blankPolicy: MailProfilePolicy = {
allowed_profile_ids: [],
allow_user_profiles: null,
allow_group_profiles: null,
allow_campaign_profiles: null,
smtp_credentials: {},
imap_credentials: {},
whitelist: {},
blacklist: {},
allow_lower_level_limits: {}
};
export function MailProfilePolicyEditor({
settings,
scopeType,
scopeId = null,
campaignId = null,
profiles,
ownerUserId = null,
ownerGroupId = null,
canWrite,
locked = false,
title = "i18n:govoplan-mail.mail_profile_policy.f2ac4b92",
description = "i18n:govoplan-mail.allowed_profiles_and_wildcard_rules_for_this_sco.0f82b3e4",
onSaved
}: MailProfilePolicyEditorProps) {
const { translateText } = usePlatformLanguage();
const [policy, setPolicy] = useState<MailProfilePolicy>(blankPolicy);
const [effectivePolicy, setEffectivePolicy] = useState<MailProfilePolicy | null>(null);
const [parentPolicy, setParentPolicy] = useState<MailProfilePolicy | null>(null);
const [effectivePolicySources, setEffectivePolicySources] = useState<PolicySourcePathItem[]>([]);
const [savedPolicyKey, setSavedPolicyKey] = useState(policyDraftKey(blankPolicy));
const [loading, setLoading] = useState(false);
const [policyLoaded, setPolicyLoaded] = useState(false);
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
const [success, setSuccess] = useState("");
const [refreshWarning, setRefreshWarning] = useState("");
const requiresTarget = scopeType === "user" || scopeType === "group" || scopeType === "campaign";
const scopeReady = !requiresTarget || Boolean(scopeId);
const policyDirty = scopeReady && policyDraftKey(policy) !== savedPolicyKey;
useUnsavedDraftGuard({
dirty: policyDirty,
onSave: savePolicy,
onDiscard: () => setPolicy(JSON.parse(savedPolicyKey) as MailProfilePolicy)
});
useEffect(() => {void loadPolicy();}, [settings.accessToken, settings.apiBaseUrl, settings.apiKey, scopeType, scopeId, campaignId]);
async function loadPolicy() {
setPolicyLoaded(false);
setError("");
setSuccess("");
setRefreshWarning("");
if (!scopeReady) {
setPolicy(blankPolicy);
setSavedPolicyKey(policyDraftKey(blankPolicy));
setEffectivePolicy(null);
setParentPolicy(null);
setEffectivePolicySources([]);
return;
}
setLoading(true);
try {
const response = await getMailProfilePolicy(settings, scopeType, scopeId, campaignId);
const loadedPolicy = normalizePolicy(response.policy);
setPolicy(loadedPolicy);
setSavedPolicyKey(policyDraftKey(loadedPolicy));
setEffectivePolicy(response.effective_policy ? normalizePolicy(response.effective_policy) : null);
setParentPolicy(response.parent_policy ? normalizePolicy(response.parent_policy) : null);
setEffectivePolicySources(response.effective_policy_sources ?? []);
setPolicyLoaded(true);
} catch (err) {
setPolicy(blankPolicy);
setSavedPolicyKey(policyDraftKey(blankPolicy));
setEffectivePolicy(null);
setParentPolicy(null);
setEffectivePolicySources([]);
setError(errorMessage(err));
} finally {
setLoading(false);
}
}
async function savePolicy(): Promise<boolean> {
if (!scopeReady || !canWrite || locked || loading || !policyLoaded || busy) return false;
setBusy(true);
setError("");
setSuccess("");
setRefreshWarning("");
try {
const response = await updateMailProfilePolicy(settings, scopeType, normalizePolicyForSave(policy, parentPolicy, scopeType), scopeId);
const savedPolicy = normalizePolicy(response.policy);
setPolicy(savedPolicy);
setSavedPolicyKey(policyDraftKey(savedPolicy));
setEffectivePolicy(response.effective_policy ? normalizePolicy(response.effective_policy) : null);
setParentPolicy(response.parent_policy ? normalizePolicy(response.parent_policy) : null);
setEffectivePolicySources(response.effective_policy_sources ?? []);
setSuccess("i18n:govoplan-mail.mail_profile_policy_saved.666847bf");
try {
await onSaved?.();
} catch (refreshError) {
// The policy write has committed. A dependent refresh must never turn
// this into a failed save or encourage replaying the accepted write.
setRefreshWarning(i18nMessage("i18n:govoplan-mail.policy_saved_refresh_failed", { value0: errorMessage(refreshError) }));
}
return true;
} catch (err) {
setError(errorMessage(err));
return false;
} finally {
setBusy(false);
}
}
const candidateProfiles = useMemo(
() => profileCandidatesForPolicy(profiles, scopeType, scopeId, ownerUserId, ownerGroupId),
[ownerGroupId, ownerUserId, profiles, scopeId, scopeType]
);
const isSystem = scopeType === "system";
const displayPolicy = useMemo(() => isSystem ? concreteSystemPolicy(policy) : policy, [isSystem, policy]);
const selectedProfileIds = new Set(policy.allowed_profile_ids ?? []);
const disabled = locked || busy || loading || !policyLoaded || !canWrite || !scopeReady;
const policySaveBlocker = mailPolicyDisabledReason(locked, canWrite, scopeReady, loading || !policyLoaded, busy, policyDirty);
const parentAllowedProfileIds = parentPolicy?.allowed_profile_ids?.length ? new Set(parentPolicy.allowed_profile_ids) : null;
const parentBlocksUserProfiles = parentPolicy?.allow_user_profiles === false;
const parentBlocksGroupProfiles = parentPolicy?.allow_group_profiles === false;
const parentBlocksCampaignProfiles = parentPolicy?.allow_campaign_profiles === false;
const showAllowColumn = scopeType !== "campaign";
const showEffectiveColumn = !isSystem;
const profileAllowListLocked = !parentAllowsMailLimit("allowed_profile_ids");
const blockedProfileDefinitions = [
parentBlocksUserProfiles ? "user" : "",
parentBlocksGroupProfiles ? "group" : "",
parentBlocksCampaignProfiles ? "i18n:govoplan-mail.campaign_local_settings.920ecb62" : ""].
filter(Boolean).join(", ");
const effectivePolicyPath = effectivePolicySources.length > 0 ? effectivePolicySources : mailPolicySourcePath(scopeType);
function patchPolicy(patch: Partial<MailProfilePolicy>) {
setPolicy((current) => normalizePolicy({ ...current, ...patch }));
}
function setFlag(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", value: PolicyFlagValue) {
patchPolicy({ [key]: flagToBoolean(value) });
}
function setPattern(kind: "whitelist" | "blacklist", key: MailProfilePatternKey, text: string) {
const nextRules = { ...(policy[kind] ?? {}) };
const parsed = parsePatternList(text);
if (parsed.length > 0) nextRules[key] = parsed;else
delete nextRules[key];
patchPolicy({ [kind]: nextRules });
}
function parentAllowsMailLimit(key: MailProfilePolicyLimitKey): boolean {
return !parentPolicy || parentPolicy.allow_lower_level_limits?.[key] !== false;
}
function localAllowsMailLimit(key: MailProfilePolicyLimitKey): boolean {
const localValue = policy.allow_lower_level_limits?.[key];
if (localValue !== undefined) return localValue && parentAllowsMailLimit(key);
return parentAllowsMailLimit(key);
}
function setAllowLowerLevelLimit(key: MailProfilePolicyLimitKey, allowed: boolean) {
patchPolicy({ allow_lower_level_limits: { ...(policy.allow_lower_level_limits ?? {}), [key]: allowed } });
}
function lowerLevelLimitToggle(key: MailProfilePolicyLimitKey, label: ReactNode = "i18n:govoplan-mail.allow_override.ffa6e9a0"): ReactNode | undefined {
if (!showAllowColumn) return undefined;
const parentLocked = !parentAllowsMailLimit(key);
return (
<ToggleSwitch
checked={localAllowsMailLimit(key)}
disabled={disabled || parentLocked}
onChange={(checked) => setAllowLowerLevelLimit(key, checked)}
label={label} />);
}
return (
<Card
title={title}
titleHelp={<DocumentationHelpLink reference={MAIL_PROFILE_DOCUMENTATION} />}
actions={
<div className="button-row compact-actions">
<Button onClick={() => void loadPolicy()} disabled={loading || busy || !scopeReady} disabledReason={loading ? "Mail policy is already loading." : busy ? "Wait for the current policy change to finish." : !scopeReady ? "Select a policy target before reloading." : undefined}>{loading ? "i18n:govoplan-mail.loading.33ce4174" : "i18n:govoplan-mail.reload.cce71553"}</Button>
<Button variant="primary" onClick={() => void savePolicy()} disabled={Boolean(policySaveBlocker)} disabledReason={policySaveBlocker}>{busy ? "i18n:govoplan-mail.saving.56a2285c" : "i18n:govoplan-mail.save_policy.77d67ce3"}</Button>
</div>
}>
<LoadingFrame loading={loading} label="i18n:govoplan-mail.loading_mail_profile_policy.b746a2e8">
<div className="mail-policy-editor">
{(locked || !canWrite || !scopeReady) &&
<ActionBlockerHint
tone={locked ? "warning" : "info"}
reason={mailPolicyBlockerReason(locked, canWrite, scopeReady)}
documentation={MAIL_PROFILE_DOCUMENTATION} />
}
{description && <p className="muted small-note mail-policy-description">{description}</p>}
{error && <DismissibleAlert tone="danger" resetKey={error} floating>{error}</DismissibleAlert>}
{success && <DismissibleAlert tone="success" resetKey={success} floating>{success}</DismissibleAlert>}
{refreshWarning && <DismissibleAlert tone="warning" resetKey={refreshWarning}>{refreshWarning}</DismissibleAlert>}
<section className="mail-policy-section policy-section">
<ActionToolbar surface="section-header" className="subsection-heading split">
<h3>i18n:govoplan-mail.profile_allow_list.507dfe6c</h3>
<div className="button-row compact-actions">
{lowerLevelLimitToggle("allowed_profile_ids")}
<Button onClick={() => patchPolicy({ allowed_profile_ids: [] })} disabled={disabled || profileAllowListLocked || selectedProfileIds.size === 0}>i18n:govoplan-mail.clear_allow_list.f69c8c67</Button>
</div>
</ActionToolbar>
<p className="muted small-note">{selectedProfileIds.size === 0 ? "i18n:govoplan-mail.no_local_profile_allow_list_is_set.31072e39" : i18nMessage("i18n:govoplan-mail.value_profile_s_allowed_by_this_scope.6fe9ba44", { value0: selectedProfileIds.size })}</p>
<AdminSelectionList
options={candidateProfiles.map((profile) => ({
id: profile.id,
label: profile.name,
description: `${scopeLabel(profile)} · ${transportLabel(profile.smtp)}`,
disabled: disabled || profileAllowListLocked || Boolean(parentAllowedProfileIds && !parentAllowedProfileIds.has(profile.id) && !selectedProfileIds.has(profile.id))
}))}
selected={[...selectedProfileIds]}
onChange={(allowedProfileIds) => patchPolicy({ allowed_profile_ids: [...allowedProfileIds].sort() })}
emptyText="i18n:govoplan-mail.no_profiles_are_visible_for_this_policy_scope.1ec7bd85"
/>
{parentAllowedProfileIds && <p className="muted small-note">i18n:govoplan-mail.an_ancestor_allow_list_limits_selectable_profile.499ec179 {parentAllowedProfileIds.size} i18n:govoplan-mail.profile_s.742e9200</p>}
</section>
<section className="mail-policy-section policy-section">
<h3>i18n:govoplan-mail.lower_level_mail_definitions.d39a0a1d</h3>
<PolicyTable className="mail-policy-table" rowClassName="mail-policy-row" headerClassName="mail-policy-row-header" fieldLabel="i18n:govoplan-mail.policy.bb9cf141" settingLabel={isSystem ? "i18n:govoplan-mail.value.8dce170d" : "i18n:govoplan-mail.local_setting.967607a9"} effectiveLabel="i18n:govoplan-mail.effective_policy.feedb950" lowerLevelLabel="i18n:govoplan-mail.lower_levels.940821ee" showAllowColumn={showAllowColumn} showEffectiveColumn={showEffectiveColumn}>
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.user_profiles.57730285"
help={policyHelp("i18n:govoplan-mail.controls_whether_user_scoped_mail_profiles_may_b.00c0e0e7")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_user_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_user_profiles")} allowDisabled={parentBlocksUserProfiles} onChange={(value) => setFlag("allow_user_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_user_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_user_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_user_profiles", effectivePolicyPath) : undefined} />
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.group_profiles.74568838"
help={policyHelp("i18n:govoplan-mail.controls_whether_group_scoped_mail_profiles_may_.0b832ea4")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_group_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_group_profiles")} allowDisabled={parentBlocksGroupProfiles} onChange={(value) => setFlag("allow_group_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_group_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_group_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_group_profiles", effectivePolicyPath) : undefined} />
<PolicyRow
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label="i18n:govoplan-mail.campaign_local_settings.eb0f1061"
help={policyHelp("i18n:govoplan-mail.controls_whether_campaigns_may_use_inline_smtp_i.fa45cbbc")}
control={<PolicyFlagControl value={booleanToFlag(displayPolicy.allow_campaign_profiles)} disabled={disabled} includeInherit={!isSystem} inheritOnly={!isSystem && !parentAllowsMailLimit("allow_campaign_profiles")} allowDisabled={parentBlocksCampaignProfiles} onChange={(value) => setFlag("allow_campaign_profiles", value)} />}
effective={showEffectiveColumn ? effectiveBooleanLabel(effectivePolicy?.allow_campaign_profiles, effectivePolicy) : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle("allow_campaign_profiles")}</div> : undefined}
effectiveHelp={showEffectiveColumn ? mailBooleanPolicyPathHelp("allow_campaign_profiles", effectivePolicyPath) : undefined} />
</PolicyTable>
{blockedProfileDefinitions && <PolicyLockedHint>i18n:govoplan-mail.explicit_allow_is_unavailable_for.8d05fd4a {blockedProfileDefinitions} i18n:govoplan-mail.because_an_ancestor_policy_blocks_those_definiti.5de3e30d</PolicyLockedHint>}
</section>
<section className="mail-policy-section policy-section" data-testid="mail-credential-policy">
<h3>i18n:govoplan-mail.credential_selection_policy</h3>
<p className="muted small-note">i18n:govoplan-mail.credential_selection_policy_help</p>
<PolicyTable className="mail-policy-table" rowClassName="mail-policy-row" headerClassName="mail-policy-row-header" fieldLabel="i18n:govoplan-mail.policy.bb9cf141" settingLabel={isSystem ? "i18n:govoplan-mail.value.8dce170d" : "i18n:govoplan-mail.local_setting.967607a9"} effectiveLabel="i18n:govoplan-mail.effective_policy.feedb950" lowerLevelLabel="i18n:govoplan-mail.lower_levels.940821ee" showAllowColumn={showAllowColumn} showEffectiveColumn={showEffectiveColumn}>
{(["smtp", "imap"] as const).map((protocol) => {
const key = `${protocol}_credentials` as const;
const limitKey = `${key}.inherit` as MailProfilePolicyLimitKey;
const parentLocked = !parentAllowsMailLimit(limitKey);
const local = displayPolicy[key]?.inherit;
return <PolicyRow key={key}
className="mail-policy-row"
labelClassName="mail-policy-field-label"
controlClassName="mail-policy-control"
effectiveCellClassName="mail-policy-effective-cell"
effectiveClassName="mail-policy-effective-value"
label={`i18n:govoplan-mail.${protocol}_credential_selection`}
help={policyHelp("i18n:govoplan-mail.credential_selection_policy_help")}
control={<select aria-label={translateText(`i18n:govoplan-mail.${protocol}_credential_selection`)}
value={parentLocked || local == null ? "inherit" : local ? "profile" : "explicit"}
disabled={disabled || parentLocked}
onChange={(event) => patchPolicy({ [key]: { inherit: event.target.value === "inherit" ? null : event.target.value === "profile" } })}>
{(!isSystem || parentLocked) && <option value="inherit">i18n:govoplan-mail.credential_policy_parent</option>}
<option value="profile">i18n:govoplan-mail.credential_policy_profile</option>
<option value="explicit">i18n:govoplan-mail.credential_policy_explicit</option>
</select>}
effective={showEffectiveColumn ? effectivePolicy ? credentialSelectionLabel(effectivePolicy[key]?.inherit) : "i18n:govoplan-mail.loading.b04ba49f" : undefined}
effectiveHelp={showEffectiveColumn ? <PolicyPathHelp lines={mailCredentialPolicyPathLines(key, normalizePolicySourcePathItems(effectivePolicyPath))} /> : undefined}
allowControl={showAllowColumn ? <div className="mail-policy-lower-cell policy-lower-cell">{lowerLevelLimitToggle(limitKey)}</div> : undefined} />;
})}
</PolicyTable>
{(["smtp_credentials.inherit", "imap_credentials.inherit"] as const).some((key) => !parentAllowsMailLimit(key)) && <PolicyLockedHint>i18n:govoplan-mail.credential_policy_parent_locked</PolicyLockedHint>}
</section>
<section className="mail-policy-section policy-section">
<h3>i18n:govoplan-mail.wildcard_rules.54fb3fc0</h3>
<div className={`mail-policy-pattern-table policy-table${showAllowColumn ? " with-allow-column" : ""}`}>
<div className="mail-policy-pattern-row policy-row mail-policy-row-header policy-row-header">
<span>i18n:govoplan-mail.policy_target.a19dcee9</span>
<span>i18n:govoplan-mail.whitelist.53c2ad30</span>
<span>i18n:govoplan-mail.blacklist.7b2dd04c</span>
{showAllowColumn && <span>i18n:govoplan-mail.lower_levels.940821ee</span>}
</div>
{mailProfilePatternKeys.map((key) =>
<div className="mail-policy-pattern-row policy-row" key={key}>
<div className="mail-policy-field-label policy-field-label">
<FieldLabel className="mail-policy-field-title policy-field-title" help={policyHelp(patternPolicyNote(key))}>{patternLabels[key]}</FieldLabel>
</div>
<PatternTextareaControl value={patternsToText(policy.whitelist?.[key])} disabled={disabled || !parentAllowsMailLimit(`whitelist.${key}` as MailProfilePolicyLimitKey)} onChange={(text) => setPattern("whitelist", key, text)} />
<PatternTextareaControl value={patternsToText(policy.blacklist?.[key])} disabled={disabled || !parentAllowsMailLimit(`blacklist.${key}` as MailProfilePolicyLimitKey)} onChange={(text) => setPattern("blacklist", key, text)} />
{showAllowColumn &&
<div className="mail-policy-pattern-limits">
{lowerLevelLimitToggle(`whitelist.${key}` as MailProfilePolicyLimitKey, "i18n:govoplan-mail.whitelist.53c2ad30")}
{lowerLevelLimitToggle(`blacklist.${key}` as MailProfilePolicyLimitKey, "i18n:govoplan-mail.blacklist.7b2dd04c")}
</div>
}
</div>
)}
</div>
</section>
{showEffectiveColumn && effectivePolicy &&
<section className="mail-policy-section policy-section mail-policy-effective">
<h3>i18n:govoplan-mail.policy_path.1ba91ee5</h3>
<PolicySourcePath items={effectivePolicyPath} />
<p className="muted small-note">i18n:govoplan-mail.effective_values_are_shown_in_the_table_rows_abo.b27b900d</p>
</section>
}
</div>
</LoadingFrame>
</Card>);
}
function PolicyFlagControl({ value, disabled, includeInherit = true, inheritOnly = false, allowDisabled = false, onChange }: {value: PolicyFlagValue;disabled: boolean;includeInherit?: boolean;inheritOnly?: boolean;allowDisabled?: boolean;onChange: (value: PolicyFlagValue) => void;}) {
const selectedValue = inheritOnly ? "inherit" : value;
return (
<select value={selectedValue} disabled={disabled} onChange={(event) => onChange(event.target.value as PolicyFlagValue)}>
{(includeInherit || inheritOnly) && <option value="inherit">i18n:govoplan-mail.inherit.18f99833</option>}
{!inheritOnly && <option value="allow" disabled={allowDisabled}>i18n:govoplan-mail.explicit_allow.6a7946f8</option>}
{!inheritOnly && <option value="deny">i18n:govoplan-mail.deny.53577bb5</option>}
</select>);
}
function PatternTextareaControl({ value, disabled, onChange }: {value: string;disabled: boolean;onChange: (value: string) => void;}) {
return <textarea rows={3} value={value} disabled={disabled} onChange={(event) => onChange(event.target.value)} placeholder="*.example.org" />;
}
function mailPolicyDisabledReason(
locked: boolean,
canWrite: boolean,
scopeReady: boolean,
loading: boolean,
busy: boolean,
dirty: boolean
): string {
if (locked) return "This policy is locked by the owning workflow or a higher-scope decision.";
if (!canWrite) return "Mail policy administration permission is required to save changes.";
if (!scopeReady) return "Select a policy target before saving.";
if (loading) return "Wait until the effective Mail policy has loaded.";
if (busy) return "Wait for the current policy change to finish.";
if (!dirty) return "There are no unsaved Mail policy changes.";
return "";
}
function mailPolicyBlockerReason(locked: boolean, _canWrite: boolean, scopeReady: boolean) {
if (locked) {
return {
summary: "This Mail policy is locked in the current context.",
details: "The effective values remain visible, but this workflow or a higher-scope decision owns the editable policy.",
requiredAction: "Change the owning policy or leave the governed workflow before editing.",
actor: "The administrator or workflow owner responsible for the source policy",
target: "The source shown in the effective policy path"
};
}
if (!scopeReady) {
return {
summary: "Select a target before editing Mail policy.",
details: "User, group, and campaign policy must be resolved against one concrete target.",
requiredAction: "Choose the target in the scope selector.",
actor: "Mail policy administrator",
target: "The target selector above"
};
}
return {
summary: "You can review effective Mail policy here, but cannot change it.",
details: "Policy changes require Mail policy administration authority at this scope.",
requiredAction: "Ask an authorized administrator to apply the change.",
actor: "System or tenant policy administrator",
target: "Administration > Mail profiles and policy"
};
}
function normalizePolicy(value: MailProfilePolicy | null | undefined): MailProfilePolicy {
return {
allowed_profile_ids: [...(value?.allowed_profile_ids ?? [])].filter(Boolean),
allow_user_profiles: value?.allow_user_profiles ?? null,
allow_group_profiles: value?.allow_group_profiles ?? null,
allow_campaign_profiles: value?.allow_campaign_profiles ?? null,
smtp_credentials: normalizeCredentialPolicy(value?.smtp_credentials),
imap_credentials: normalizeCredentialPolicy(value?.imap_credentials),
whitelist: normalizeRules(value?.whitelist),
blacklist: normalizeRules(value?.blacklist),
allow_lower_level_limits: normalizeMailLowerLevelLimits(value?.allow_lower_level_limits)
};
}
function policyDraftKey(policy: MailProfilePolicy): string {
return JSON.stringify(normalizePolicy(policy));
}
function normalizePolicyForSave(policy: MailProfilePolicy, parentPolicy: MailProfilePolicy | null, scopeType: MailProfileScope): MailProfilePolicy {
const normalized = normalizePolicy(policy);
if (scopeType === "system") return concreteSystemPolicy(normalized);
const localLimits = { ...(normalized.allow_lower_level_limits ?? {}) };
const parentLimits = parentPolicy?.allow_lower_level_limits ?? null;
function parentAllows(key: MailProfilePolicyLimitKey): boolean {
return !parentLimits || parentLimits[key] !== false;
}
function clearLimit(key: MailProfilePolicyLimitKey) {
delete localLimits[key];
}
if (!parentAllows("allowed_profile_ids")) {
normalized.allowed_profile_ids = [];
clearLimit("allowed_profile_ids");
}
for (const key of ["allow_user_profiles", "allow_group_profiles", "allow_campaign_profiles"] as const) {
if (!parentAllows(key)) {
normalized[key] = null;
clearLimit(key);
}
}
for (const protocol of ["smtp_credentials", "imap_credentials"] as const) {
const credential = normalizeCredentialPolicy(normalized[protocol]);
const inheritKey = `${protocol}.inherit` as MailProfilePolicyLimitKey;
if (!parentAllows(inheritKey)) {
credential.inherit = null;
clearLimit(inheritKey);
}
normalized[protocol] = credential;
}
for (const key of mailProfilePatternKeys) {
const whitelistKey = `whitelist.${key}` as MailProfilePolicyLimitKey;
const blacklistKey = `blacklist.${key}` as MailProfilePolicyLimitKey;
if (!parentAllows(whitelistKey)) {
delete normalized.whitelist?.[key];
clearLimit(whitelistKey);
}
if (!parentAllows(blacklistKey)) {
delete normalized.blacklist?.[key];
clearLimit(blacklistKey);
}
}
if (scopeType === "campaign") {
normalized.allow_lower_level_limits = {};
} else {
normalized.allow_lower_level_limits = localLimits;
}
return normalized;
}
function normalizeMailLowerLevelLimits(value: MailProfilePolicy["allow_lower_level_limits"]): Partial<Record<MailProfilePolicyLimitKey, boolean>> {
const result: Partial<Record<MailProfilePolicyLimitKey, boolean>> = {};
for (const key of mailProfilePolicyLimitKeys) {
if (typeof value?.[key] === "boolean") result[key] = value[key];
}
return result;
}
function fullMailLowerLevelLimits(value: MailProfilePolicy["allow_lower_level_limits"]): Record<MailProfilePolicyLimitKey, boolean> {
const result = {} as Record<MailProfilePolicyLimitKey, boolean>;
for (const key of mailProfilePolicyLimitKeys) {
result[key] = value?.[key] !== false;
}
return result;
}
function concreteSystemPolicy(policy: MailProfilePolicy): MailProfilePolicy {
const normalized = normalizePolicy(policy);
return {
...normalized,
allow_user_profiles: normalized.allow_user_profiles ?? true,
allow_group_profiles: normalized.allow_group_profiles ?? true,
allow_campaign_profiles: normalized.allow_campaign_profiles ?? true,
smtp_credentials: concreteSystemCredentialPolicy(normalized.smtp_credentials),
imap_credentials: concreteSystemCredentialPolicy(normalized.imap_credentials),
allow_lower_level_limits: fullMailLowerLevelLimits(normalized.allow_lower_level_limits)
};
}
function concreteSystemCredentialPolicy(value: MailCredentialPolicy | null | undefined): MailCredentialPolicy {
const normalized = normalizeCredentialPolicy(value);
return { inherit: normalized.inherit ?? true };
}
function normalizeCredentialPolicy(value: MailCredentialPolicy | null | undefined): MailCredentialPolicy {
return { inherit: typeof value?.inherit === "boolean" ? value.inherit : null };
}
function normalizeRules(value: MailProfilePatternRules | null | undefined): MailProfilePatternRules {
const result: MailProfilePatternRules = {};
for (const key of mailProfilePatternKeys) {
const patterns = (value?.[key] ?? []).map((pattern) => pattern.trim()).filter(Boolean);
if (patterns.length > 0) result[key] = patterns;
}
return result;
}
function profileCandidatesForPolicy(profiles: MailServerProfile[], scopeType: MailProfileScope, scopeId: string | null, ownerUserId: string | null, ownerGroupId: string | null): MailServerProfile[] {
return profiles.
filter((profile) => {
if (scopeType === "system") return profile.scope_type === "system";
if (profile.scope_type === "system" || profile.scope_type === "tenant") return true;
if (scopeType === "user") return profile.scope_type === "user" && profile.scope_id === scopeId;
if (scopeType === "group") return profile.scope_type === "group" && profile.scope_id === scopeId;
if (scopeType === "campaign") {
if (profile.scope_type === "campaign") return profile.scope_id === scopeId;
if (profile.scope_type === "user") return Boolean(ownerUserId) && profile.scope_id === ownerUserId;
if (profile.scope_type === "group") return Boolean(ownerGroupId) && profile.scope_id === ownerGroupId;
}
return false;
}).
sort((a, b) => `${scopeOrder(a.scope_type)}:${a.name}`.localeCompare(`${scopeOrder(b.scope_type)}:${b.name}`));
}
export function scopeOrder(scopeType: MailProfileScope): number {
if (scopeType === "system") return 0;
if (scopeType === "tenant") return 1;
if (scopeType === "user" || scopeType === "group") return 2;
return 3;
}
function policyHelp(description: string): ReactNode {
return <span>{description}</span>;
}
function credentialSelectionLabel(inherit: boolean | null | undefined): string {
return inherit === false ? "i18n:govoplan-mail.credential_policy_explicit" : "i18n:govoplan-mail.credential_policy_profile";
}
function mailCredentialPolicyPathLines(key: "smtp_credentials" | "imap_credentials", items: NormalizedPolicySourcePathItem[]): string[] {
const lines: string[] = [];
for (const [index, item] of items.entries()) {
const policy = policySourceRecord(item);
const value = asRecord(policy[key]).inherit;
const label = typeof value === "boolean" ? credentialSelectionLabel(value) : "i18n:govoplan-mail.credential_policy_parent";
const locked = asRecord(policy.allow_lower_level_limits)[`${key}.inherit`] === false;
lines.push(i18nMessage(locked ? "i18n:govoplan-mail.credential_policy_path_locked" : "i18n:govoplan-mail.credential_policy_path", { value0: `${policyPathPrefix(index)}${item.label}`, value1: label }));
if (locked) break;
}
return lines;
}
function mailBooleanPolicyPathHelp(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", sources: PolicySourcePathItem[]): ReactNode {
return <PolicyPathHelp lines={mailBooleanPolicyPathLines(key, normalizePolicySourcePathItems(sources))} />;
}
function mailBooleanPolicyPathLines(key: "allow_user_profiles" | "allow_group_profiles" | "allow_campaign_profiles", items: NormalizedPolicySourcePathItem[]): string[] {
if (items.length === 0) return ["i18n:govoplan-mail.system_allow.ed6744b1"];
const lines: string[] = [];
for (const [index, item] of items.entries()) {
const policy = policySourceRecord(item);
const rawValue = policy[key];
const value = rawValue === true ? "i18n:govoplan-mail.allow.3ad0e369" : rawValue === false ? "i18n:govoplan-mail.deny.53577bb5" : "i18n:govoplan-mail.inherit.18f99833";
const lowerLocked = asRecord(policy.allow_lower_level_limits)[key] === false;
const stops = rawValue === false || lowerLocked;
lines.push(`${policyPathPrefix(index)}${item.label}: ${stops ? `${value} without override` : value}`);
if (stops) break;
}
return lines;
}
function policySourceRecord(item: NormalizedPolicySourcePathItem): Record<string, unknown> {
return asRecord(item.policy);
}
function asRecord(value: unknown): Record<string, unknown> {
return value && typeof value === "object" && !Array.isArray(value) ? value as Record<string, unknown> : {};
}
function policyPathPrefix(index: number): string {
return index === 0 ? "" : `${" ".repeat(index - 1)}> `;
}
function effectiveBooleanLabel(value: boolean | null | undefined, policy: MailProfilePolicy | null): string {
if (!policy) return "i18n:govoplan-mail.loading.b04ba49f";
return value ? "i18n:govoplan-mail.allowed.77c7b490" : "i18n:govoplan-mail.blocked.99613c74";
}
function patternPolicyNote(key: MailProfilePatternKey): string {
if (key === "smtp_hosts") return "i18n:govoplan-mail.smtp_server_host_patterns.cf6120c3";
if (key === "imap_hosts") return "i18n:govoplan-mail.imap_server_host_patterns.52b20b83";
if (key === "envelope_senders") return "i18n:govoplan-mail.smtp_envelope_sender_patterns.8c1fd95e";
if (key === "from_headers") return "i18n:govoplan-mail.visible_from_header_patterns.ea77d99d";
return "i18n:govoplan-mail.recipient_domain_patterns.68466f5b";
}
function booleanToFlag(value: boolean | null | undefined): PolicyFlagValue {
if (value === true) return "allow";
if (value === false) return "deny";
return "inherit";
}
function flagToBoolean(value: PolicyFlagValue): boolean | null {
if (value === "allow") return true;
if (value === "deny") return false;
return null;
}
function parsePatternList(value: string): string[] {
const seen = new Set<string>();
const result: string[] = [];
for (const item of value.split(/[\n,]+/)) {
const pattern = item.trim();
if (pattern && !seen.has(pattern)) {
seen.add(pattern);
result.push(pattern);
}
}
return result;
}
function patternsToText(value: string[] | undefined): string {
return (value ?? []).join("\n");
}
function mailPolicySourcePath(scopeType: MailProfileScope): string[] {
if (scopeType === "system") return ["i18n:govoplan-mail.system.bc0792d8"];
if (scopeType === "tenant") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78"];
if (scopeType === "user") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.user.9f8a2389"];
if (scopeType === "group") return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.group.171a0606"];
return ["i18n:govoplan-mail.system.bc0792d8", "i18n:govoplan-mail.tenant.3ca93c78", "i18n:govoplan-mail.owner_policy.1e8df143", "i18n:govoplan-mail.campaign.69390e16"];
}
export function transportLabel(transport: MailSmtpTestPayload | MailImapTestPayload | MailJmapTransportSettings | null | undefined): string {
if (!transport) return "i18n:govoplan-mail.not_configured.811931bb";
if ("session_url" in transport) return transport.session_url || "No Session URL";
const host = transport.host || "i18n:govoplan-mail.no_host.4c710d7d";
const port = transport.port ? `:${transport.port}` : "";
return `${host}${port}`;
}
export function scopeLabel(profile: MailServerProfile): string {
if (profile.scope_type === "system") return "i18n:govoplan-mail.system.bc0792d8";
if (profile.scope_type === "tenant") return "i18n:govoplan-mail.tenant.3ca93c78";
if (profile.scope_type === "user") return "i18n:govoplan-mail.user.9f8a2389";
if (profile.scope_type === "group") return "i18n:govoplan-mail.group.171a0606";
return "i18n:govoplan-mail.campaign.69390e16";
}
export function errorMessage(err: unknown): string {
return err instanceof Error ? err.message : String(err);
}
+290 -120
View File
@@ -1,17 +1,22 @@
import { useEffect, useMemo, useRef, useState } from "react"; import { useEffect, useMemo, useRef, useState } from "react";
import { Activity, Check, ChevronRight, Database, Home, Mail, MailOpen, Paperclip, RefreshCw, Search, UserPlus, X } from "lucide-react"; import { Activity, Check, ChevronRight, Database, Home, Mail, MailOpen, Paperclip, RefreshCw, Search, UserPlus, X } from "lucide-react";
import { useLocation } from "react-router"; import { useLocation } from "react-router";
import { ToolbarGroup, ActionToolbar, import { ActionToolbar,
ActionBlockerHint, ActionBlockerHint,
Button, Button,
CountBadge, CountBadge,
DataGridPaginationBar, DataGridPaginationBar,
DocumentationHelpLink, DocumentationHelpLink,
Dialog,
DismissibleAlert, DismissibleAlert,
ExplorerTree, ExplorerTree,
FormField,
FormSection,
IconButton, IconButton,
LoadingIndicator, LoadingIndicator,
MessageDisplayPanel, MessageDisplayPanel,
WorkspaceActionBar,
WorkspaceFrame,
hasAnyScope, hasAnyScope,
formatDateTime, formatDateTime,
i18nMessage, i18nMessage,
@@ -25,6 +30,7 @@ import {
getMailboxMessage, getMailboxMessage,
listMailAddressWriteTargets, listMailAddressWriteTargets,
listMailboxMessages, listMailboxMessages,
listMailboxFolders,
listMailServerProfiles, listMailServerProfiles,
type MailAddressWriteTarget, type MailAddressWriteTarget,
type MailImapFolderResponse, type MailImapFolderResponse,
@@ -43,6 +49,11 @@ const MAILBOX_DOCUMENTATION = {
documentationType: "user" documentationType: "user"
} as const; } as const;
// Each context read revalidates the current principal and explicit Reload must
// not reuse Core's short-lived GET response/in-flight promise cache. Mail's
// bounded provider index remains available unless the refresh flag is set.
const MAILBOX_READ_OPTIONS = { cache: "no-store" } as const;
export default function MailboxPage({ settings, auth }: { settings: ApiSettings; auth: AuthInfo }) { export default function MailboxPage({ settings, auth }: { settings: ApiSettings; auth: AuthInfo }) {
const navigate = useGuardedNavigate(); const navigate = useGuardedNavigate();
const location = useLocation(); const location = useLocation();
@@ -50,6 +61,7 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
const [selectedProfileId, setSelectedProfileId] = useState(""); const [selectedProfileId, setSelectedProfileId] = useState("");
const [folders, setFolders] = useState<MailImapFolderResponse[]>([]); const [folders, setFolders] = useState<MailImapFolderResponse[]>([]);
const [selectedFolder, setSelectedFolder] = useState("INBOX"); const [selectedFolder, setSelectedFolder] = useState("INBOX");
const [selectedFolderGroup, setSelectedFolderGroup] = useState<Pick<MailFolderNode, "id" | "label"> | null>(null);
const [foldersLoadedForProfile, setFoldersLoadedForProfile] = useState(""); const [foldersLoadedForProfile, setFoldersLoadedForProfile] = useState("");
const [expandedFolders, setExpandedFolders] = useState<Set<string>>(() => new Set()); const [expandedFolders, setExpandedFolders] = useState<Set<string>>(() => new Set());
const [messages, setMessages] = useState<MailMailboxMessageSummary[]>([]); const [messages, setMessages] = useState<MailMailboxMessageSummary[]>([]);
@@ -69,10 +81,21 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
const [folderError, setFolderError] = useState(""); const [folderError, setFolderError] = useState("");
const [messageError, setMessageError] = useState(""); const [messageError, setMessageError] = useState("");
const [detailError, setDetailError] = useState(""); const [detailError, setDetailError] = useState("");
const [mailToolsOpen, setMailToolsOpen] = useState(false);
const [reloadingMailbox, setReloadingMailbox] = useState(false);
const profileRequestRef = useRef(0);
const mailboxReloadRequestRef = useRef(0);
const selectedProfileIdRef = useRef(selectedProfileId);
selectedProfileIdRef.current = selectedProfileId;
const authorityKey = JSON.stringify([settings.apiBaseUrl, settings.apiKey, settings.accessToken, auth.user.id, auth.active_tenant?.id ?? auth.tenant.id]);
const authorityRef = useRef(authorityKey);
authorityRef.current = authorityKey;
const revealedFolderRef = useRef("");
const selectedMessageKeyRef = useRef(""); const selectedMessageKeyRef = useRef("");
const folderRequestRef = useRef(0); const folderRequestRef = useRef(0);
const messageListRequestRef = useRef(0); const messageListRequestRef = useRef(0);
const messageDetailRequestRef = useRef(0); const messageDetailRequestRef = useRef(0);
const loadedMessagePageRef = useRef<{ profileId: string; folder: string; page: number; pageSize: number } | null>(null);
const mailboxPageCursorsRef = useRef<Record<string, string | null>>({}); const mailboxPageCursorsRef = useRef<Record<string, string | null>>({});
const skipNextMessageLoadRef = useRef(false); const skipNextMessageLoadRef = useRef(false);
const launchRequestRef = useRef<MailboxLaunch | null>(parseMailboxLaunch(location.search)); const launchRequestRef = useRef<MailboxLaunch | null>(parseMailboxLaunch(location.search));
@@ -81,34 +104,46 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
const mailboxProfiles = useMemo(() => profiles.filter((profile) => profile.is_active && mailboxProtocolForProfile(profile)), [profiles]); const mailboxProfiles = useMemo(() => profiles.filter((profile) => profile.is_active && mailboxProtocolForProfile(profile)), [profiles]);
const selectedMailboxProtocol = mailboxProtocolForProfile(selectedProfile) ?? "imap"; const selectedMailboxProtocol = mailboxProtocolForProfile(selectedProfile) ?? "imap";
const folderTree = useMemo(() => buildMailboxFolderTree(folders), [folders]); const folderTree = useMemo(() => buildMailboxFolderTree(folders), [folders]);
const selectedFolderNodeId = useMemo(() => findFolderNodeId(folderTree, selectedFolder) ?? "", [folderTree, selectedFolder]); const selectedFolderNodeId = useMemo(() => selectedFolderGroup?.id ?? findFolderNodeId(folderTree, selectedFolder) ?? "", [folderTree, selectedFolder, selectedFolderGroup]);
const filteredMessages = useMemo(() => filterMessages(messages, messageQuery), [messageQuery, messages]); const filteredMessages = useMemo(() => filterMessages(messages, messageQuery), [messageQuery, messages]);
const messagePageCount = Math.max(1, Math.ceil((messageTotalCount ?? 0) / messagePageSize)); const messagePageCount = Math.max(1, Math.ceil((messageTotalCount ?? 0) / messagePageSize));
const shellBusy = loadingProfiles || loadingFolders || loadingMessages; const shellBusy = loadingProfiles || loadingFolders || loadingMessages || reloadingMailbox;
const noMailboxProfiles = !loadingProfiles && mailboxProfiles.length === 0; const noMailboxProfiles = !loadingProfiles && mailboxProfiles.length === 0;
const foldersReady = Boolean(selectedProfileId) && foldersLoadedForProfile === selectedProfileId; const foldersReady = Boolean(selectedProfileId) && foldersLoadedForProfile === selectedProfileId;
const selectedMessageKey = pendingMessageKey || selectedMessageKeyState || (selectedMessage ? mailboxMessageKey(selectedMessage.folder || selectedFolder, selectedMessage.uid) : ""); const selectedMessageKey = pendingMessageKey || selectedMessageKeyState || (selectedMessage ? mailboxMessageKey(selectedMessage.folder || selectedFolder, selectedMessage.uid) : "");
const messageCountLabel = messageListCountLabel(messages.length, messageTotalCount, loadingMessages, foldersReady); const messageCountLabel = messageListCountLabel(messages.length, messageTotalCount, loadingMessages, foldersReady);
const syncState = mailboxSyncState(messageProvenance); const syncState = mailboxSyncState(messageProvenance);
const folderEmptyText = folderError || (noMailboxProfiles ? "No IMAP- or JMAP-enabled Mail profiles are available." : loadingFolders ? "i18n:govoplan-mail.loading_folders.17f9f0e2" : "i18n:govoplan-mail.no_folders_available.14133b26"); const folderEmptyText = folderError || (noMailboxProfiles ? "No IMAP- or JMAP-enabled Mail profiles are available." : loadingFolders ? "i18n:govoplan-mail.loading_folders.17f9f0e2" : "i18n:govoplan-mail.no_folders_available.14133b26");
const messageEmptyText = messageError || (!selectedProfileId ? "i18n:govoplan-mail.select_an_imap_profile.5445648c" : !foldersReady || loadingMessages ? "i18n:govoplan-mail.loading_messages.77b62232" : messages.length > 0 && filteredMessages.length === 0 ? "i18n:govoplan-mail.no_messages_match_the_current_filter_on_this_pag.9dda6916" : "i18n:govoplan-mail.no_messages_in_this_folder.5c7fa25d"); const messageEmptyText = messageError || (selectedFolderGroup ? "i18n:govoplan-mail.folder_group_selection" : !selectedProfileId ? "i18n:govoplan-mail.select_an_imap_profile.5445648c" : !foldersReady || loadingMessages ? "i18n:govoplan-mail.loading_messages.77b62232" : messages.length > 0 && filteredMessages.length === 0 ? "i18n:govoplan-mail.no_messages_match_the_current_filter_on_this_pag.9dda6916" : "i18n:govoplan-mail.no_messages_in_this_folder.5c7fa25d");
const previewEmptyText = detailError || (loadingMessage ? "i18n:govoplan-mail.loading_message.815c2094" : "i18n:govoplan-mail.select_a_message_to_inspect_its_content.5f3d1342"); const previewEmptyText = detailError || (loadingMessage ? "i18n:govoplan-mail.loading_message.815c2094" : "i18n:govoplan-mail.select_a_message_to_inspect_its_content.5f3d1342");
const loadingLabel = loadingProfiles ? "i18n:govoplan-mail.loading_mail_profiles.87de3560" : loadingFolders ? "i18n:govoplan-mail.loading_folders.17f9f0e2" : loadingMessages ? "i18n:govoplan-mail.loading_messages.77b62232" : "i18n:govoplan-mail.loading_message.815c2094"; const loadingLabel = loadingProfiles ? "i18n:govoplan-mail.loading_mail_profiles.87de3560" : loadingFolders ? "i18n:govoplan-mail.loading_folders.17f9f0e2" : loadingMessages ? "i18n:govoplan-mail.loading_messages.77b62232" : "i18n:govoplan-mail.loading_message.815c2094";
const profileReloadBlocker = loadingProfiles ? "Mail profiles are already loading." : ""; const profileReloadBlocker = shellBusy ? "i18n:govoplan-mail.mailbox_refresh_in_progress" : "";
const folderReloadBlocker = !selectedProfileId const folderReloadBlocker = !selectedProfileId
? "Select an IMAP- or JMAP-enabled Mail profile before refreshing folders." ? "Select an IMAP- or JMAP-enabled Mail profile before refreshing folders."
: loadingFolders || loadingMessages : shellBusy
? "Wait for the current mailbox refresh to finish." ? "Wait for the current mailbox refresh to finish."
: ""; : "";
const messageReloadBlocker = !selectedProfileId const messageReloadBlocker = !selectedProfileId
? "Select an IMAP- or JMAP-enabled Mail profile before refreshing messages." ? "Select an IMAP- or JMAP-enabled Mail profile before refreshing messages."
: !selectedFolder || !foldersReady : !selectedFolder || !foldersReady
? "Select a loaded mailbox folder before refreshing messages." ? "Select a loaded mailbox folder before refreshing messages."
: loadingMessages : shellBusy
? "Messages are already loading." ? "Messages are already loading."
: ""; : "";
useEffect(() => {void loadProfiles();}, [settings.apiBaseUrl, settings.apiKey, settings.accessToken]); useEffect(() => {
selectProfile("");
setProfiles([]);
setMailToolsOpen(false);
void loadProfiles();
return () => {
profileRequestRef.current += 1;
folderRequestRef.current += 1;
messageListRequestRef.current += 1;
messageDetailRequestRef.current += 1;
mailboxReloadRequestRef.current += 1;
};
}, [authorityKey]);
useEffect(() => { useEffect(() => {
const request = parseMailboxLaunch(location.search); const request = parseMailboxLaunch(location.search);
launchRequestRef.current = request; launchRequestRef.current = request;
@@ -137,13 +172,17 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
}, [foldersReady, messagePage, messagePageSize, selectedProfileId, selectedFolder]); }, [foldersReady, messagePage, messagePageSize, selectedProfileId, selectedFolder]);
useEffect(() => { useEffect(() => {
if (selectedMailboxProtocol !== "jmap" || !selectedProfileId || !selectedFolder || !foldersReady) return; if (selectedMailboxProtocol !== "jmap" || !selectedProfileId || !selectedFolder || !foldersReady) return;
const requestAuthority = authorityKey;
const profileId = selectedProfileId;
const listRequest = messageListRequestRef.current;
const handle = window.setTimeout(() => { const handle = window.setTimeout(() => {
if (requestAuthority !== authorityRef.current || profileId !== selectedProfileIdRef.current || listRequest !== messageListRequestRef.current) return;
setMessagePage(1); setMessagePage(1);
mailboxPageCursorsRef.current = {}; mailboxPageCursorsRef.current = {};
void loadMessages(selectedProfileId, selectedFolder, 1, messagePageSize); void loadMessages(selectedProfileId, selectedFolder, 1, messagePageSize);
}, 250); }, 250);
return () => window.clearTimeout(handle); return () => window.clearTimeout(handle);
}, [messageQuery]); }, [messageQuery, selectedFolderGroup]);
useEffect(() => { useEffect(() => {
const request = launchRequestRef.current; const request = launchRequestRef.current;
@@ -160,10 +199,12 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
useEffect(() => { useEffect(() => {
const handlePreviewShortcut = (event: KeyboardEvent) => { const handlePreviewShortcut = (event: KeyboardEvent) => {
if (isEditableTarget(event.target)) return; if (mailToolsOpen || isEditableTarget(event.target)) return;
if (event.key === "Escape") { if (event.key === "Escape") {
if (selectedMessage || selectedMessageKey || pendingMessageKey || detailError) { if (selectedMessage || selectedMessageKey || pendingMessageKey || detailError) {
event.preventDefault(); event.preventDefault();
messageDetailRequestRef.current += 1;
setLoadingMessage(false);
setSelectedMessage(null); setSelectedMessage(null);
setSelectedMessageKeyState(""); setSelectedMessageKeyState("");
selectedMessageKeyRef.current = ""; selectedMessageKeyRef.current = "";
@@ -187,55 +228,86 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
window.addEventListener("keydown", handlePreviewShortcut); window.addEventListener("keydown", handlePreviewShortcut);
return () => window.removeEventListener("keydown", handlePreviewShortcut); return () => window.removeEventListener("keydown", handlePreviewShortcut);
}, [detailError, filteredMessages, loadingMessage, pendingMessageKey, selectedFolder, selectedMessage, selectedMessageKey, shellBusy]); }, [detailError, filteredMessages, loadingMessage, mailToolsOpen, pendingMessageKey, selectedFolder, selectedMessage, selectedMessageKey, shellBusy]);
useEffect(() => { useEffect(() => {
const revealKey = `${selectedProfileId}:${selectedFolder}`;
if (revealedFolderRef.current === revealKey) return;
const ancestorIds = folderAncestorIds(folderTree, selectedFolder); const ancestorIds = folderAncestorIds(folderTree, selectedFolder);
if (ancestorIds.length === 0) return; if (ancestorIds.length === 0) return;
revealedFolderRef.current = revealKey;
setExpandedFolders((current) => { setExpandedFolders((current) => {
const next = new Set(current); const next = new Set(current);
ancestorIds.forEach((id) => next.add(id)); ancestorIds.forEach((id) => next.add(id));
return next; return next;
}); });
}, [folderTree, selectedFolder]); }, [folderTree, selectedFolder, selectedProfileId]);
async function loadProfiles() { async function loadProfiles() {
const requestId = ++profileRequestRef.current;
const requestAuthority = authorityRef.current;
setLoadingProfiles(true); setLoadingProfiles(true);
setError(""); setError("");
try { try {
const loaded = await listMailServerProfiles(settings); const loaded = await listMailServerProfiles(settings, false, undefined, MAILBOX_READ_OPTIONS);
if (requestId !== profileRequestRef.current || requestAuthority !== authorityRef.current) return null;
const usable = loaded.filter((profile) => profile.is_active && mailboxProtocolForProfile(profile)); const usable = loaded.filter((profile) => profile.is_active && mailboxProtocolForProfile(profile));
const requestedProfileId = parseMailboxLaunch(location.search).profileId; const requestedProfileId = parseMailboxLaunch(location.search).profileId;
setProfiles(loaded); setProfiles(loaded);
setSelectedProfileId((current) => const currentId = selectedProfileIdRef.current;
requestedProfileId && usable.some((profile) => profile.id === requestedProfileId) const next = usable.find((profile) => profile.id === currentId)
? requestedProfileId ?? usable.find((profile) => profile.id === requestedProfileId)
: current && usable.some((profile) => profile.id === current) ?? usable[0] ?? null;
? current const changed = (next?.id ?? "") !== currentId;
: usable[0]?.id ?? "" if (changed) selectProfile(next?.id ?? "");
); return { selected: next, changed };
if (usable.length === 0) {
setFolders([]);
setFoldersLoadedForProfile("");
setMessages([]);
setMessageTotalCount(null);
setMessageProvenance(null);
setSelectedMessage(null);
setSelectedMessageKeyState("");
setPendingMessageKey("");
mailboxPageCursorsRef.current = {};
skipNextMessageLoadRef.current = false;
}
} catch (err) { } catch (err) {
if (requestId !== profileRequestRef.current || requestAuthority !== authorityRef.current) return null;
setError(errorText(err)); setError(errorText(err));
return null;
} finally { } finally {
setLoadingProfiles(false); if (requestId === profileRequestRef.current && requestAuthority === authorityRef.current) setLoadingProfiles(false);
} }
} }
async function loadMailboxBootstrap(profileId = selectedProfileId, refresh = false) { async function reloadMailbox() {
const requestId = ++mailboxReloadRequestRef.current;
setReloadingMailbox(true);
try {
const result = await loadProfiles();
if (!result || requestId !== mailboxReloadRequestRef.current || result.changed || !result.selected) return;
if (selectedFolderGroup) await refreshFolderCatalogue(result.selected);
else await loadMailboxBootstrap(result.selected.id, true, result.selected);
} finally {
if (requestId === mailboxReloadRequestRef.current) setReloadingMailbox(false);
}
}
async function refreshFolderCatalogue(profile = selectedProfile) {
if (!profile) return;
const requestId = ++folderRequestRef.current;
const requestAuthority = authorityRef.current;
setLoadingFolders(true);
setFolderError("");
setError("");
try {
const response = await listMailboxFolders(settings, profile.id, true, true, mailboxProtocolForProfile(profile) ?? "imap", MAILBOX_READ_OPTIONS);
if (requestId !== folderRequestRef.current || requestAuthority !== authorityRef.current || profile.id !== selectedProfileIdRef.current) return;
if (!response.ok) throw new Error(response.message || "i18n:govoplan-mail.mailbox_folders_could_not_be_loaded.c3e3880e");
setFolders(response.folders ?? []);
setFoldersLoadedForProfile(profile.id);
} catch (err) {
if (requestId !== folderRequestRef.current || requestAuthority !== authorityRef.current || profile.id !== selectedProfileIdRef.current) return;
setFolderError(errorText(err));
setError(errorText(err));
} finally {
if (requestId === folderRequestRef.current && requestAuthority === authorityRef.current) setLoadingFolders(false);
}
}
async function loadMailboxBootstrap(profileId = selectedProfileId, refresh = false, profileOverride?: MailServerProfile) {
if (!profileId) return; if (!profileId) return;
const targetProfile = profiles.find((profile) => profile.id === profileId) ?? null; const targetProfile = profileOverride ?? profiles.find((profile) => profile.id === profileId) ?? null;
const mailboxProtocol = mailboxProtocolForProfile(targetProfile) ?? "imap"; const mailboxProtocol = mailboxProtocolForProfile(targetProfile) ?? "imap";
const profileInbox = mailboxProtocol === "imap" ? targetProfile?.imap?.folder_mappings?.inbox || "" : ""; const profileInbox = mailboxProtocol === "imap" ? targetProfile?.imap?.folder_mappings?.inbox || "" : "";
const requestedLaunch = launchRequestRef.current; const requestedLaunch = launchRequestRef.current;
@@ -247,28 +319,38 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
: profileInbox || "INBOX"); : profileInbox || "INBOX");
const folderRequestId = ++folderRequestRef.current; const folderRequestId = ++folderRequestRef.current;
const messageRequestId = ++messageListRequestRef.current; const messageRequestId = ++messageListRequestRef.current;
messageDetailRequestRef.current += 1; const requestAuthority = authorityRef.current;
const isCurrent = () => folderRequestId === folderRequestRef.current
&& messageRequestId === messageListRequestRef.current
&& requestAuthority === authorityRef.current && profileId === selectedProfileIdRef.current;
const preserve = refresh && foldersLoadedForProfile === profileId;
// A refreshed JMAP query starts a new cursor chain; IMAP offsets can retain
// the current page without silently losing the user's mailbox context.
const requestedPage = preserve && mailboxProtocol !== "jmap" ? messagePage : 1;
const rememberedMessageKey = preserve ? selectedMessageKeyRef.current : "";
const detailRequestId = ++messageDetailRequestRef.current;
setLoadingMessage(false);
setPendingMessageKey("");
setLoadingFolders(true); setLoadingFolders(true);
setLoadingMessages(true); setLoadingMessages(true);
setFoldersLoadedForProfile(""); if (!preserve) {
setMessageTotalCount(null); setFoldersLoadedForProfile("");
setMessageProvenance(null); setMessageTotalCount(null);
setMessagePage(1); setMessageProvenance(null);
setSelectedMessage(null); setMessagePage(1);
setSelectedMessageKeyState(""); setSelectedMessage(null);
selectedMessageKeyRef.current = ""; setSelectedMessageKeyState("");
setPendingMessageKey(""); selectedMessageKeyRef.current = "";
}
setFolderError(""); setFolderError("");
setMessageError(""); setMessageError("");
setDetailError(""); setDetailError("");
setError(""); setError("");
try { try {
const response = await bootstrapMailbox(settings, profileId, requestedFolder, messagePageSize, 0, refresh, mailboxProtocol); const response = await bootstrapMailbox(settings, profileId, requestedFolder, messagePageSize, (requestedPage - 1) * messagePageSize, refresh, mailboxProtocol, MAILBOX_READ_OPTIONS);
if (folderRequestId !== folderRequestRef.current || messageRequestId !== messageListRequestRef.current) return; if (!isCurrent()) return;
if (!response.folders.ok) throw new Error(response.folders.message || "i18n:govoplan-mail.mailbox_folders_could_not_be_loaded.c3e3880e"); if (!response.folders.ok) throw new Error(response.folders.message || "i18n:govoplan-mail.mailbox_folders_could_not_be_loaded.c3e3880e");
const loadedFolders = response.folders.folders?.length ? response.folders.folders : [{ name: "INBOX", flags: [] }]; const loadedFolders = response.folders.folders?.length ? response.folders.folders : [{ name: "INBOX", flags: [] }];
const loadedMessages = response.messages.messages ?? [];
const total = response.messages.total_count ?? loadedMessages.length;
let nextFolder = response.folder || response.messages.folder || selectedFolder || "INBOX"; let nextFolder = response.folder || response.messages.folder || selectedFolder || "INBOX";
if (!loadedFolders.some((folder) => folder.name === nextFolder)) { if (!loadedFolders.some((folder) => folder.name === nextFolder)) {
const detectedInbox = response.folders.detected_folder_mappings?.inbox; const detectedInbox = response.folders.detected_folder_mappings?.inbox;
@@ -276,39 +358,67 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
? detectedInbox ? detectedInbox
: loadedFolders.some((folder) => folder.name === "INBOX") ? "INBOX" : response.folders.detected_sent_folder || loadedFolders[0]?.name || "INBOX"; : loadedFolders.some((folder) => folder.name === "INBOX") ? "INBOX" : response.folders.detected_sent_folder || loadedFolders[0]?.name || "INBOX";
} }
let messageResponse = mailboxProtocol === "jmap" && messageQuery.trim()
? await listMailboxMessages(settings, profileId, nextFolder, messagePageSize, 0, null, refresh, mailboxProtocol, messageQuery, MAILBOX_READ_OPTIONS)
: response.messages;
if (!isCurrent()) return;
const total = messageResponse.total_count ?? messageResponse.messages?.length ?? 0;
const nextPage = Math.min(requestedPage, Math.max(1, Math.ceil(total / messagePageSize)));
if (nextPage !== requestedPage) {
messageResponse = await listMailboxMessages(settings, profileId, nextFolder, messagePageSize, (nextPage - 1) * messagePageSize, null, refresh, mailboxProtocol, null, MAILBOX_READ_OPTIONS);
if (!isCurrent()) return;
}
const loadedMessages = messageResponse.messages ?? [];
const foldersWithCounts = loadedFolders.map((folder) => folder.name === nextFolder ? { ...folder, message_count: total } : folder); const foldersWithCounts = loadedFolders.map((folder) => folder.name === nextFolder ? { ...folder, message_count: total } : folder);
const cursorKey = mailboxCursorKey(profileId, nextFolder, messagePageSize, ""); const cursorKey = mailboxCursorKey(profileId, nextFolder, messagePageSize, mailboxProtocol === "jmap" ? messageQuery : "");
mailboxPageCursorsRef.current = { mailboxPageCursorsRef.current = {
[`${cursorKey}:1`]: null, [`${cursorKey}:${nextPage}`]: null,
[`${cursorKey}:2`]: response.messages.next_cursor ?? null [`${cursorKey}:${nextPage + 1}`]: messageResponse.next_cursor ?? null
}; };
skipNextMessageLoadRef.current = foldersLoadedForProfile !== profileId || nextFolder !== selectedFolder || messagePage !== 1; skipNextMessageLoadRef.current = foldersLoadedForProfile !== profileId || nextFolder !== selectedFolder || messagePage !== nextPage;
loadedMessagePageRef.current = { profileId, folder: nextFolder, page: nextPage, pageSize: messagePageSize };
setFolders(foldersWithCounts); setFolders(foldersWithCounts);
setExpandedFolders(new Set()); if (!preserve) setExpandedFolders(new Set());
setSelectedFolderGroup(null);
setSelectedFolder(nextFolder); setSelectedFolder(nextFolder);
setMessagePage(nextPage);
setFoldersLoadedForProfile(profileId); setFoldersLoadedForProfile(profileId);
setMessages(loadedMessages); setMessages(loadedMessages);
setMessageTotalCount(total); setMessageTotalCount(total);
setMessageProvenance(mailboxProvenance(response.messages)); setMessageProvenance(mailboxProvenance(messageResponse));
const retainedMessage = loadedMessages.find((message) => mailboxMessageKey(message.folder || nextFolder, message.uid) === rememberedMessageKey);
// Explicit preview navigation or Escape during a refresh wins over the
// remembered selection; completing a read must not undo the user's action.
if (detailRequestId === messageDetailRequestRef.current && selectedMessageKeyRef.current === rememberedMessageKey) {
if (retainedMessage) await openMessage(retainedMessage, profileId, mailboxProtocol, true);
else if (rememberedMessageKey) {
setSelectedMessage(null);
setSelectedMessageKeyState("");
selectedMessageKeyRef.current = "";
}
}
} catch (err) { } catch (err) {
if (folderRequestId !== folderRequestRef.current || messageRequestId !== messageListRequestRef.current) return; if (!isCurrent()) return;
const message = errorText(err); const message = errorText(err);
skipNextMessageLoadRef.current = false; skipNextMessageLoadRef.current = false;
setFolderError(message); setFolderError(message);
setMessageError(message); setMessageError(message);
setError(message); setError(message);
setFolders([]); if (!preserve) {
setFoldersLoadedForProfile(""); loadedMessagePageRef.current = null;
setMessages([]); setFolders([]);
setMessageTotalCount(null); setFoldersLoadedForProfile("");
setMessageProvenance(null); setMessages([]);
setSelectedMessage(null); setMessageTotalCount(null);
setSelectedMessageKeyState(""); setMessageProvenance(null);
selectedMessageKeyRef.current = ""; setSelectedMessage(null);
setPendingMessageKey(""); setSelectedMessageKeyState("");
selectedMessageKeyRef.current = "";
setPendingMessageKey("");
}
} finally { } finally {
if (folderRequestId === folderRequestRef.current) setLoadingFolders(false); if (folderRequestId === folderRequestRef.current && requestAuthority === authorityRef.current) setLoadingFolders(false);
if (messageRequestId === messageListRequestRef.current) setLoadingMessages(false); if (messageRequestId === messageListRequestRef.current && requestAuthority === authorityRef.current) setLoadingMessages(false);
} }
} }
@@ -316,11 +426,13 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
if (!profileId || !folder) return; if (!profileId || !folder) return;
const mailboxProtocol = mailboxProtocolForProfile(profiles.find((profile) => profile.id === profileId) ?? null) ?? "imap"; const mailboxProtocol = mailboxProtocolForProfile(profiles.find((profile) => profile.id === profileId) ?? null) ?? "imap";
const requestId = ++messageListRequestRef.current; const requestId = ++messageListRequestRef.current;
const requestAuthority = authorityRef.current;
const isCurrent = () => requestId === messageListRequestRef.current && requestAuthority === authorityRef.current && profileId === selectedProfileIdRef.current;
const offset = (Math.max(1, page) - 1) * pageSize; const offset = (Math.max(1, page) - 1) * pageSize;
const cursorKey = mailboxCursorKey(profileId, folder, pageSize, mailboxProtocol === "jmap" ? messageQuery : ""); const cursorKey = mailboxCursorKey(profileId, folder, pageSize, mailboxProtocol === "jmap" ? messageQuery : "");
const cursor = page <= 1 ? null : mailboxPageCursorsRef.current[`${cursorKey}:${page}`] || null; const cursor = page <= 1 ? null : mailboxPageCursorsRef.current[`${cursorKey}:${page}`] || null;
setLoadingMessages(true); setLoadingMessages(true);
setMessageProvenance(null); if (!refresh) setMessageProvenance(null);
setMessageError(""); setMessageError("");
setDetailError(""); setDetailError("");
setError(""); setError("");
@@ -334,11 +446,13 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
cursor, cursor,
refresh, refresh,
mailboxProtocol, mailboxProtocol,
mailboxProtocol === "jmap" ? messageQuery : null mailboxProtocol === "jmap" ? messageQuery : null,
MAILBOX_READ_OPTIONS
); );
if (requestId !== messageListRequestRef.current) return; if (!isCurrent()) return;
const loaded = response.messages ?? []; const loaded = response.messages ?? [];
const total = response.total_count ?? loaded.length; const total = response.total_count ?? loaded.length;
loadedMessagePageRef.current = { profileId, folder, page, pageSize };
if (page <= 1) mailboxPageCursorsRef.current[`${cursorKey}:1`] = null; if (page <= 1) mailboxPageCursorsRef.current[`${cursorKey}:1`] = null;
mailboxPageCursorsRef.current[`${cursorKey}:${page + 1}`] = response.next_cursor ?? null; mailboxPageCursorsRef.current[`${cursorKey}:${page + 1}`] = response.next_cursor ?? null;
setMessages(loaded); setMessages(loaded);
@@ -347,66 +461,87 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
setFolderMessageCount(folder, total); setFolderMessageCount(folder, total);
const rememberedKey = selectedMessageKeyRef.current; const rememberedKey = selectedMessageKeyRef.current;
if (rememberedKey && !loaded.some((message) => mailboxMessageKey(message.folder || folder, message.uid) === rememberedKey)) { if (rememberedKey && !loaded.some((message) => mailboxMessageKey(message.folder || folder, message.uid) === rememberedKey)) {
messageDetailRequestRef.current += 1;
setLoadingMessage(false);
setSelectedMessage(null); setSelectedMessage(null);
setSelectedMessageKeyState(""); setSelectedMessageKeyState("");
setPendingMessageKey(""); setPendingMessageKey("");
selectedMessageKeyRef.current = "";
} }
} catch (err) { } catch (err) {
if (requestId !== messageListRequestRef.current) return; if (!isCurrent()) return;
const message = errorText(err); const message = errorText(err);
setMessageError(message); setMessageError(message);
setError(message); setError(message);
setMessages([]); const committed = loadedMessagePageRef.current;
setMessageTotalCount(null); if (committed?.profileId === profileId && committed.folder === folder && (committed.page !== page || committed.pageSize !== pageSize)) {
setMessageProvenance(null); // Retained rows must keep their actual page/size labels after a failed
setSelectedMessage(null); // pagination read; restoring controls is not a second provider request.
setSelectedMessageKeyState(""); skipNextMessageLoadRef.current = true;
setPendingMessageKey(""); setMessagePage(committed.page);
setMessagePageSize(committed.pageSize);
}
// A failed read is not an empty mailbox. Keep the last loaded index and
// selection visible until a successful refresh or an explicit switch.
} finally { } finally {
if (requestId === messageListRequestRef.current) setLoadingMessages(false); if (isCurrent()) setLoadingMessages(false);
} }
} }
async function openMessage(message: MailMailboxMessageSummary) { async function openMessage(message: MailMailboxMessageSummary, profileId = selectedProfileId, protocol = selectedMailboxProtocol, preservePreview = false) {
if (!selectedProfileId) return; if (!profileId) return;
const folderName = message.folder || selectedFolder; const folderName = message.folder || selectedFolder;
const requestId = ++messageDetailRequestRef.current; const requestId = ++messageDetailRequestRef.current;
const requestAuthority = authorityRef.current;
const isCurrent = () => requestId === messageDetailRequestRef.current && requestAuthority === authorityRef.current && profileId === selectedProfileIdRef.current;
const nextKey = mailboxMessageKey(folderName, message.uid); const nextKey = mailboxMessageKey(folderName, message.uid);
setSelectedMessageKeyState(nextKey); setSelectedMessageKeyState(nextKey);
selectedMessageKeyRef.current = nextKey; selectedMessageKeyRef.current = nextKey;
setPendingMessageKey(nextKey); setPendingMessageKey(nextKey);
setSelectedMessage(null); if (!preservePreview) setSelectedMessage(null);
setDetailError(""); setDetailError("");
setLoadingMessage(true); setLoadingMessage(true);
setError(""); setError("");
try { try {
const response = await getMailboxMessage(settings, selectedProfileId, folderName, message.uid, selectedMailboxProtocol); const response = await getMailboxMessage(settings, profileId, folderName, message.uid, protocol, MAILBOX_READ_OPTIONS);
if (requestId !== messageDetailRequestRef.current) return; if (!isCurrent()) return;
setSelectedMessage(response.message); setSelectedMessage(response.message);
setSelectedMessageKeyState(mailboxMessageKey(response.message.folder || folderName, response.message.uid)); setSelectedMessageKeyState(mailboxMessageKey(response.message.folder || folderName, response.message.uid));
setPendingMessageKey(""); setPendingMessageKey("");
} catch (err) { } catch (err) {
if (requestId !== messageDetailRequestRef.current) return; if (!isCurrent()) return;
const messageText = errorText(err); const messageText = errorText(err);
setDetailError(messageText); setDetailError(messageText);
setError(messageText); setError(messageText);
setPendingMessageKey(""); setPendingMessageKey("");
} finally { } finally {
if (requestId === messageDetailRequestRef.current) setLoadingMessage(false); if (isCurrent()) setLoadingMessage(false);
} }
} }
function selectProfile(profileId: string) { function selectProfile(profileId: string) {
loadedMessagePageRef.current = null;
mailboxReloadRequestRef.current += 1;
folderRequestRef.current += 1; folderRequestRef.current += 1;
messageListRequestRef.current += 1; messageListRequestRef.current += 1;
messageDetailRequestRef.current += 1; messageDetailRequestRef.current += 1;
setSelectedProfileId(profileId); setSelectedProfileId(profileId);
selectedProfileIdRef.current = profileId;
setReloadingMailbox(false);
setSelectedFolderGroup(null);
setFolders([]); setFolders([]);
setFoldersLoadedForProfile(""); setFoldersLoadedForProfile("");
setMessages([]); setMessages([]);
setMessageTotalCount(null); setMessageTotalCount(null);
setMessageProvenance(null); setMessageProvenance(null);
setMessagePage(1); setMessagePage(1);
setSelectedFolder("INBOX");
setMessageQuery("");
setError("");
setFolderError("");
setMessageError("");
setDetailError("");
revealedFolderRef.current = "";
setSelectedMessage(null); setSelectedMessage(null);
setSelectedMessageKeyState(""); setSelectedMessageKeyState("");
selectedMessageKeyRef.current = ""; selectedMessageKeyRef.current = "";
@@ -421,8 +556,16 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
function openFolderNode(node: MailFolderNode) { function openFolderNode(node: MailFolderNode) {
if (node.folderName) { if (node.folderName) {
setSelectedFolderGroup(null);
if (node.folderName === selectedFolder && foldersReady) void loadMessages(selectedProfileId, node.folderName, messagePage, messagePageSize);else if (node.folderName === selectedFolder && foldersReady) void loadMessages(selectedProfileId, node.folderName, messagePage, messagePageSize);else
{ {
loadedMessagePageRef.current = null;
messageListRequestRef.current += 1;
messageDetailRequestRef.current += 1;
setLoadingMessage(false);
setMessages([]);
setMessageTotalCount(null);
setMessageProvenance(null);
setSelectedFolder(node.folderName); setSelectedFolder(node.folderName);
setMessagePage(1); setMessagePage(1);
setSelectedMessage(null); setSelectedMessage(null);
@@ -433,7 +576,26 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
} }
return; return;
} }
toggleFolderNode(node); // Synthetic parent folders have no provider mailbox to open. Selecting
// their label must not toggle expansion or fetch an invented folder name.
loadedMessagePageRef.current = null;
messageListRequestRef.current += 1;
messageDetailRequestRef.current += 1;
setSelectedFolderGroup({ id: node.id, label: node.label });
setSelectedFolder("");
setMessages([]);
setMessageTotalCount(0);
setMessageProvenance(null);
setMessagePage(1);
setSelectedMessage(null);
setSelectedMessageKeyState("");
selectedMessageKeyRef.current = "";
setPendingMessageKey("");
setLoadingMessage(false);
setLoadingMessages(false);
setMessageError("");
setDetailError("");
skipNextMessageLoadRef.current = false;
} }
function toggleFolderNode(node: MailFolderNode) { function toggleFolderNode(node: MailFolderNode) {
@@ -460,9 +622,35 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
} }
return ( return (
<div className="workspace-data-page module-entry-page file-manager-page file-manager-fullscreen mailbox-page"> <WorkspaceFrame as="main" height="viewport" surface="plain" label="i18n:govoplan-mail.mailbox_workspace" className="mailbox-page" helpContextId="mail.mailbox" helpModuleId="mail" helpTopicId="mail.workflow.read-mailbox">
{error && <DismissibleAlert tone="danger" resetKey={error} floating>{error}</DismissibleAlert>} {error && <DismissibleAlert tone="danger" resetKey={error} floating>{error}</DismissibleAlert>}
<WorkspaceActionBar
title="i18n:govoplan-mail.mailbox_workspace"
titleHelp={<DocumentationHelpLink reference={MAILBOX_DOCUMENTATION} />}
variant="workspace"
scope="workspace"
label="i18n:govoplan-mail.mail_actions.c08b5f08"
refreshable
reloadAction={{
onReload: () => void reloadMailbox(),
loading: shellBusy,
state: error ? "reload-failed" : "current",
helpContextId: "mail.mailbox.reload",
helpModuleId: "mail",
helpTopicId: "mail.workflow.read-mailbox"
}}
contextActions={<>
<FormField label="i18n:govoplan-mail.mailbox_profile" className="mailbox-profile-field">
<select value={selectedProfileId} disabled={loadingProfiles || mailboxProfiles.length === 0} onChange={(event) => selectProfile(event.target.value)}>
{mailboxProfiles.length === 0 && <option value="">i18n:govoplan-mail.no_mailbox_profiles</option>}
{mailboxProfiles.map((profile) => <option key={profile.id} value={profile.id}>{profile.name}</option>)}
</select>
</FormField>
<Button type="button" onClick={() => setMailToolsOpen(true)} helpContextId="mail.mailbox.tools" helpModuleId="mail" helpTopicId="mail.workflow.read-mailbox">i18n:govoplan-mail.mailbox_tools</Button>
</>}
/>
<div className={`file-manager-shell mailbox-shell ${shellBusy ? "is-loading" : ""}`}> <div className={`file-manager-shell mailbox-shell ${shellBusy ? "is-loading" : ""}`}>
<aside className="file-tree-panel" aria-label="i18n:govoplan-mail.mailbox_folders.c92f6de4"> <aside className="file-tree-panel" aria-label="i18n:govoplan-mail.mailbox_folders.c92f6de4">
<div className="file-tree-heading">i18n:govoplan-mail.folders.19adc47b</div> <div className="file-tree-heading">i18n:govoplan-mail.folders.19adc47b</div>
@@ -497,37 +685,6 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
<section className="file-list-panel mailbox-message-list-panel" aria-label="i18n:govoplan-mail.mailbox_messages.5c06afaf"> <section className="file-list-panel mailbox-message-list-panel" aria-label="i18n:govoplan-mail.mailbox_messages.5c06afaf">
<div className="file-list-sticky"> <div className="file-list-sticky">
<ActionToolbar justify="between" className="file-manager-toolbar mailbox-toolbar" aria-label="i18n:govoplan-mail.mail_actions.c08b5f08">
<label className="mailbox-profile-field">
<span>Mailbox profile</span>
<select value={selectedProfileId} disabled={loadingProfiles || loadingFolders || mailboxProfiles.length === 0} onChange={(event) => selectProfile(event.target.value)}>
{mailboxProfiles.length === 0 && <option value="">No mailbox profiles available</option>}
{mailboxProfiles.map((profile) => <option key={profile.id} value={profile.id}>{profile.name}</option>)}
</select>
</label>
<ToolbarGroup grow className="mailbox-toolbar-meta">{selectedProfile ? transportLabel(selectedProfile) : "No mailbox profile selected"}</ToolbarGroup>
<ToolbarGroup align="end" className="mailbox-toolbar-actions">
<DocumentationHelpLink reference={MAILBOX_DOCUMENTATION} />
{hasAnyScope(auth, ["mail:bounce:read", "mail:bounce:manage"]) &&
<Button onClick={() => navigate("/mail/bounces")} title="Open bounce processing">
<Activity size={16} aria-hidden="true" />
Bounce status
</Button>}
<Button onClick={() => void loadProfiles()} disabled={Boolean(profileReloadBlocker)} disabledReason={profileReloadBlocker} title="i18n:govoplan-mail.reload_imap_profiles.b04c11c8">
<RefreshCw size={16} aria-hidden="true" />
i18n:govoplan-mail.profiles.0c2a9300
</Button>
<Button onClick={() => void loadMailboxBootstrap(selectedProfileId, true)} disabled={Boolean(folderReloadBlocker)} disabledReason={folderReloadBlocker} title="i18n:govoplan-mail.refresh_mailbox_folders.d9af9963">
<RefreshCw size={16} aria-hidden="true" />
i18n:govoplan-mail.folders.19adc47b
</Button>
<Button onClick={() => void loadMessages(selectedProfileId, selectedFolder, messagePage, messagePageSize, true)} disabled={Boolean(messageReloadBlocker)} disabledReason={messageReloadBlocker} title="i18n:govoplan-mail.refresh_messages_in_the_current_folder.b6546a2c">
<RefreshCw size={16} aria-hidden="true" />
i18n:govoplan-mail.messages.f1702b46
</Button>
</ToolbarGroup>
</ActionToolbar>
{noMailboxProfiles && {noMailboxProfiles &&
<ActionBlockerHint <ActionBlockerHint
className="mailbox-profile-blocker" className="mailbox-profile-blocker"
@@ -543,7 +700,7 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
<nav className="file-breadcrumbs" aria-label="i18n:govoplan-mail.current_mailbox_folder.55e2aea5"> <nav className="file-breadcrumbs" aria-label="i18n:govoplan-mail.current_mailbox_folder.55e2aea5">
<span className="file-breadcrumb mailbox-breadcrumb-static"><Home size={15} aria-hidden="true" /> {selectedProfile?.name || "i18n:govoplan-mail.mail.92379cbb"}</span> <span className="file-breadcrumb mailbox-breadcrumb-static"><Home size={15} aria-hidden="true" /> {selectedProfile?.name || "i18n:govoplan-mail.mail.92379cbb"}</span>
<span className="file-breadcrumb-segment"><ChevronRight size={14} aria-hidden="true" /><span className="file-breadcrumb mailbox-breadcrumb-static">{selectedFolder}</span></span> <span className="file-breadcrumb-segment"><ChevronRight size={14} aria-hidden="true" /><span className="file-breadcrumb mailbox-breadcrumb-static">{selectedFolderGroup?.label ?? selectedFolder}</span></span>
</nav> </nav>
<div className="mailbox-filter-row"> <div className="mailbox-filter-row">
@@ -667,7 +824,20 @@ export default function MailboxPage({ settings, auth }: { settings: ApiSettings;
</div> </div>
} }
</div> </div>
</div>); <Dialog open={mailToolsOpen} title="i18n:govoplan-mail.mailbox_tools" description={selectedProfile ? `${selectedProfile.name} · ${transportLabel(selectedProfile)}` : "i18n:govoplan-mail.no_mailbox_profiles"} onClose={() => setMailToolsOpen(false)}
footer={<Button type="button" onClick={() => setMailToolsOpen(false)}>i18n:govoplan-core.close.bbfa773e</Button>}>
<FormSection title="i18n:govoplan-mail.mailbox_refresh_tools" description="i18n:govoplan-mail.mailbox_refresh_tools_help">
<ActionToolbar surface="plain">
<Button type="button" onClick={() => { setMailToolsOpen(false); void loadProfiles(); }} disabledReason={profileReloadBlocker}><RefreshCw size={16} aria-hidden="true" /> i18n:govoplan-mail.refresh_mailbox_profiles</Button>
<Button type="button" onClick={() => { setMailToolsOpen(false); void refreshFolderCatalogue(); }} disabledReason={folderReloadBlocker}><RefreshCw size={16} aria-hidden="true" /> i18n:govoplan-mail.refresh_mailbox_folder_catalogue</Button>
<Button type="button" onClick={() => { setMailToolsOpen(false); void loadMessages(selectedProfileId, selectedFolder, messagePage, messagePageSize, true); }} disabledReason={messageReloadBlocker}><RefreshCw size={16} aria-hidden="true" /> i18n:govoplan-mail.refresh_mailbox_message_index</Button>
</ActionToolbar>
</FormSection>
<FormSection variant="separated" title="i18n:govoplan-mail.mailbox_related_tools">
<ActionToolbar surface="plain"><Button type="button" onClick={() => { setMailToolsOpen(false); navigate("/mail/bounces"); }} disabledReason={!hasAnyScope(auth, ["mail:bounce:read", "mail:bounce:manage"]) ? "i18n:govoplan-mail.mailbox_bounce_permission" : ""}><Activity size={16} aria-hidden="true" /> i18n:govoplan-mail.mailbox_bounce_status</Button></ActionToolbar>
</FormSection>
</Dialog>
</WorkspaceFrame>);
} }
@@ -889,7 +1059,7 @@ function transportLabel(profile: MailServerProfile): string {
return `${imap.host}:${imap.port ?? "?"} ${imap.security ?? ""}`.trim(); return `${imap.host}:${imap.port ?? "?"} ${imap.security ?? ""}`.trim();
} }
function preferredJmapServer(profile: MailServerProfile | null): MailServerProfile["servers"][number] | null { function preferredJmapServer(profile: MailServerProfile | null): NonNullable<MailServerProfile["servers"]>[number] | null {
if (!profile) return null; if (!profile) return null;
const servers = (profile.servers ?? []).filter((server) => server.protocol === "jmap" && server.is_active); const servers = (profile.servers ?? []).filter((server) => server.protocol === "jmap" && server.is_active);
return servers.find((server) => server.is_default) ?? servers[0] ?? null; return servers.find((server) => server.is_default) ?? servers[0] ?? null;
@@ -4,6 +4,7 @@ import {
type ApiSettings, type ApiSettings,
type CredentialReferenceSelectorContext, type CredentialReferenceSelectorContext,
type CredentialReferenceSelectorsUiCapability, type CredentialReferenceSelectorsUiCapability,
type DeltaDeletedItem,
type ReferenceOption, type ReferenceOption,
type ReferenceOptionProvider type ReferenceOptionProvider
} from "@govoplan/core-webui"; } from "@govoplan/core-webui";
@@ -24,7 +25,11 @@ export function createMailServerReferenceProvider(
let cataloguePromise: Promise<ReferenceOption[]> | null = null; let cataloguePromise: Promise<ReferenceOption[]> | null = null;
async function catalogue(signal: AbortSignal): Promise<ReferenceOption[]> { async function catalogue(signal: AbortSignal): Promise<ReferenceOption[]> {
cataloguePromise ??= loadProfiles(settings, context, signal) if (signal.aborted) throw abortError();
// The catalogue belongs to this provider, not to its first subscriber.
// StrictMode, closing an editor, or a new search can cancel one caller
// while another is still awaiting the same authorized metadata request.
cataloguePromise ??= loadProfiles(settings, context)
.then(mailServerOptions) .then(mailServerOptions)
.catch((error: unknown) => { .catch((error: unknown) => {
cataloguePromise = null; cataloguePromise = null;
@@ -95,8 +100,7 @@ function mailServerOptions(
async function loadProfiles( async function loadProfiles(
settings: ApiSettings, settings: ApiSettings,
context: CredentialReferenceSelectorContext, context: CredentialReferenceSelectorContext
signal: AbortSignal
): Promise<MailServerProfile[]> { ): Promise<MailServerProfile[]> {
let watermark: string | null = null; let watermark: string | null = null;
let profiles: MailServerProfile[] = []; let profiles: MailServerProfile[] = [];
@@ -109,7 +113,6 @@ async function loadProfiles(
since: first ? null : watermark, since: first ? null : watermark,
limit: 200 limit: 200
}); });
if (signal.aborted) throw abortError();
profiles = response.full profiles = response.full
? response.profiles ? response.profiles
: mergeProfiles(profiles, response.profiles, response.deleted); : mergeProfiles(profiles, response.profiles, response.deleted);
@@ -123,12 +126,12 @@ async function loadProfiles(
function mergeProfiles( function mergeProfiles(
current: readonly MailServerProfile[], current: readonly MailServerProfile[],
changed: readonly MailServerProfile[], changed: readonly MailServerProfile[],
deleted: readonly { resource_type: string; resource_id: string }[] deleted: readonly DeltaDeletedItem[]
): MailServerProfile[] { ): MailServerProfile[] {
const removed = new Set( const removed = new Set(
deleted deleted
.filter((item) => item.resource_type === "mail_profile") .filter((item) => item.resource_type === "mail_profile")
.map((item) => item.resource_id) .map((item) => item.id)
); );
const merged = new Map( const merged = new Map(
current current
+52 -2
View File
@@ -2,6 +2,31 @@ import type { PlatformTranslations } from "@govoplan/core-webui";
export const generatedTranslations: PlatformTranslations = { export const generatedTranslations: PlatformTranslations = {
"en": { "en": {
"i18n:govoplan-mail.mailbox_workspace": "Mailbox workspace",
"i18n:govoplan-mail.mailbox_refresh_in_progress": "Wait for the current mailbox refresh to finish.",
"i18n:govoplan-mail.mailbox_profile": "Mailbox profile",
"i18n:govoplan-mail.no_mailbox_profiles": "No mailbox profiles available",
"i18n:govoplan-mail.mailbox_tools": "Mailbox tools",
"i18n:govoplan-mail.mailbox_refresh_tools": "Refresh a specific part",
"i18n:govoplan-mail.mailbox_refresh_tools_help": "The page Reload refreshes the current mailbox context. Use these targeted reads only when you need to refresh account availability, the folder catalogue, or the current message page separately. No read/unread flags or other provider state are changed.",
"i18n:govoplan-mail.refresh_mailbox_profiles": "Refresh available profiles",
"i18n:govoplan-mail.refresh_mailbox_folder_catalogue": "Refresh folders only",
"i18n:govoplan-mail.refresh_mailbox_message_index": "Refresh messages only",
"i18n:govoplan-mail.mailbox_related_tools": "Related Mail tools",
"i18n:govoplan-mail.mailbox_bounce_status": "Bounce status",
"i18n:govoplan-mail.mailbox_bounce_permission": "Permission to read or manage Mail bounce processing is required.",
"i18n:govoplan-mail.folder_group_selection": "This grouping contains mailbox folders. Use its folder icon to expand it, then select a mailbox folder to view messages.",
"i18n:govoplan-mail.credential_selection_policy": "Credential selection",
"i18n:govoplan-mail.credential_selection_policy_help": "Allow the selected Mail server's default credential, or require the campaign to explicitly select an authorized Mail-owned credential. Both choices keep secrets in Mail; neither permits campaign-local passwords. Inherit policy uses the parent scope's decision.",
"i18n:govoplan-mail.smtp_credential_selection": "SMTP credential selection",
"i18n:govoplan-mail.imap_credential_selection": "IMAP credential selection",
"i18n:govoplan-mail.credential_policy_parent": "Inherit policy from parent",
"i18n:govoplan-mail.credential_policy_profile": "Allow profile default credential",
"i18n:govoplan-mail.credential_policy_explicit": "Require explicit Mail credential",
"i18n:govoplan-mail.credential_policy_parent_locked": "An ancestor has locked credential selection. Change the controlling policy shown in the policy path; lower scopes cannot override or unlock it.",
"i18n:govoplan-mail.credential_policy_path": "{value0}: {value1}",
"i18n:govoplan-mail.credential_policy_path_locked": "{value0}: {value1}; lower-level override locked",
"i18n:govoplan-mail.policy_saved_refresh_failed": "Mail policy was saved, but refreshing dependent data failed: {value0}. Reload to refresh the display; the saved policy does not need to be submitted again.",
"i18n:govoplan-mail.active.a733b809": "Active", "i18n:govoplan-mail.active.a733b809": "Active",
"i18n:govoplan-mail.allow_override.ffa6e9a0": "Allow override", "i18n:govoplan-mail.allow_override.ffa6e9a0": "Allow override",
"i18n:govoplan-mail.allow.3ad0e369": "Allow", "i18n:govoplan-mail.allow.3ad0e369": "Allow",
@@ -40,7 +65,7 @@ export const generatedTranslations: PlatformTranslations = {
"i18n:govoplan-mail.deactivate_value.a276a667": "Deactivate {value0}", "i18n:govoplan-mail.deactivate_value.a276a667": "Deactivate {value0}",
"i18n:govoplan-mail.deactivate.d65ded94": "Deactivate", "i18n:govoplan-mail.deactivate.d65ded94": "Deactivate",
"i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_imap_.ac607ee3": "Controls credential inheritance for compatible consumers. Campaign delivery requires credentials to remain on and inherit from the selected Mail profile.", "i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_imap_.ac607ee3": "Controls credential inheritance for compatible consumers. Campaign delivery requires credentials to remain on and inherit from the selected Mail profile.",
"i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_smtp_.93f1c4d0": "Controls credential inheritance for compatible consumers. Campaign delivery requires credentials to remain on and inherit from the selected Mail profile.", "i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_smtp_.93f1c4d0": "Controls whether consumers may use a selected Mail server's default credentials or must explicitly select authorized Mail-owned credentials. Explicit selection remains allowed when defaults are permitted; Campaign never stores local passwords.",
"i18n:govoplan-mail.deny.53577bb5": "Deny", "i18n:govoplan-mail.deny.53577bb5": "Deny",
"i18n:govoplan-mail.description.55f8ebc8": "Description", "i18n:govoplan-mail.description.55f8ebc8": "Description",
"i18n:govoplan-mail.development_mock_mailbox.1a379865": "Development mock mailbox", "i18n:govoplan-mail.development_mock_mailbox.1a379865": "Development mock mailbox",
@@ -217,6 +242,31 @@ export const generatedTranslations: PlatformTranslations = {
"i18n:govoplan-mail.working.049ac820": "Working..." "i18n:govoplan-mail.working.049ac820": "Working..."
}, },
"de": { "de": {
"i18n:govoplan-mail.mailbox_workspace": "Postfach-Arbeitsbereich",
"i18n:govoplan-mail.mailbox_refresh_in_progress": "Warten Sie, bis die aktuelle Postfachaktualisierung abgeschlossen ist.",
"i18n:govoplan-mail.mailbox_profile": "Postfachprofil",
"i18n:govoplan-mail.no_mailbox_profiles": "Keine Postfachprofile verfügbar",
"i18n:govoplan-mail.mailbox_tools": "Postfachwerkzeuge",
"i18n:govoplan-mail.mailbox_refresh_tools": "Einen bestimmten Bereich aktualisieren",
"i18n:govoplan-mail.mailbox_refresh_tools_help": "Neuladen aktualisiert den aktuellen Postfachkontext. Diese gezielten Leseaktionen aktualisieren bei Bedarf nur die verfügbaren Profile, den Ordnerkatalog oder die aktuelle Nachrichtenseite. Gelesen-/Ungelesen-Kennzeichen und andere Anbieterzustände bleiben unverändert.",
"i18n:govoplan-mail.refresh_mailbox_profiles": "Verfügbare Profile aktualisieren",
"i18n:govoplan-mail.refresh_mailbox_folder_catalogue": "Nur Ordner aktualisieren",
"i18n:govoplan-mail.refresh_mailbox_message_index": "Nur Nachrichten aktualisieren",
"i18n:govoplan-mail.mailbox_related_tools": "Weitere Mail-Werkzeuge",
"i18n:govoplan-mail.mailbox_bounce_status": "Zustellrückläufer",
"i18n:govoplan-mail.mailbox_bounce_permission": "Eine Berechtigung zum Lesen oder Verwalten der Rückläuferverarbeitung in Mail ist erforderlich.",
"i18n:govoplan-mail.folder_group_selection": "Diese Gruppe enthält Postfachordner. Klappen Sie sie über das Ordnersymbol auf und wählen Sie einen Postfachordner aus, um Nachrichten anzuzeigen.",
"i18n:govoplan-mail.credential_selection_policy": "Auswahl der Zugangsdaten",
"i18n:govoplan-mail.credential_selection_policy_help": "Die Standard-Zugangsdaten des ausgewählten Mail-Servers zulassen oder eine ausdrückliche Auswahl berechtigter Mail-Zugangsdaten in der Kampagne verlangen. Beide Optionen belassen Geheimnisse in Mail; kampagnenlokale Passwörter sind nicht erlaubt. Richtlinie erben übernimmt die Entscheidung des übergeordneten Bereichs.",
"i18n:govoplan-mail.smtp_credential_selection": "SMTP-Zugangsdaten auswählen",
"i18n:govoplan-mail.imap_credential_selection": "IMAP-Zugangsdaten auswählen",
"i18n:govoplan-mail.credential_policy_parent": "Richtlinie vom übergeordneten Bereich erben",
"i18n:govoplan-mail.credential_policy_profile": "Standard-Zugangsdaten des Profils zulassen",
"i18n:govoplan-mail.credential_policy_explicit": "Ausdrückliche Mail-Zugangsdaten verlangen",
"i18n:govoplan-mail.credential_policy_parent_locked": "Ein übergeordneter Bereich hat die Auswahl der Zugangsdaten gesperrt. Die maßgebliche Richtlinie im Richtlinienpfad ändern; untergeordnete Bereiche können diese Vorgabe weder überschreiben noch entsperren.",
"i18n:govoplan-mail.credential_policy_path": "{value0}: {value1}",
"i18n:govoplan-mail.credential_policy_path_locked": "{value0}: {value1}; Überschreiben in unteren Bereichen gesperrt",
"i18n:govoplan-mail.policy_saved_refresh_failed": "Die Mail-Richtlinie wurde gespeichert, aber abhängige Daten konnten nicht aktualisiert werden: {value0}. Zum Aktualisieren der Anzeige neu laden; die gespeicherte Richtlinie muss nicht erneut gesendet werden.",
"i18n:govoplan-mail.active.a733b809": "Aktiv", "i18n:govoplan-mail.active.a733b809": "Aktiv",
"i18n:govoplan-mail.allow_override.ffa6e9a0": "Allow override", "i18n:govoplan-mail.allow_override.ffa6e9a0": "Allow override",
"i18n:govoplan-mail.allow.3ad0e369": "Allow", "i18n:govoplan-mail.allow.3ad0e369": "Allow",
@@ -255,7 +305,7 @@ export const generatedTranslations: PlatformTranslations = {
"i18n:govoplan-mail.deactivate_value.a276a667": "Deactivate {value0}", "i18n:govoplan-mail.deactivate_value.a276a667": "Deactivate {value0}",
"i18n:govoplan-mail.deactivate.d65ded94": "Deactivate", "i18n:govoplan-mail.deactivate.d65ded94": "Deactivate",
"i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_imap_.ac607ee3": "Steuert die Vererbung fuer kompatible Verbraucher. Kampagnen muessen die Zugangsdaten aus dem ausgewaehlten Mailprofil erben.", "i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_imap_.ac607ee3": "Steuert die Vererbung fuer kompatible Verbraucher. Kampagnen muessen die Zugangsdaten aus dem ausgewaehlten Mailprofil erben.",
"i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_smtp_.93f1c4d0": "Steuert die Vererbung fuer kompatible Verbraucher. Kampagnen muessen die Zugangsdaten aus dem ausgewaehlten Mailprofil erben.", "i18n:govoplan-mail.decides_whether_lower_scopes_inherit_saved_smtp_.93f1c4d0": "Legt fest, ob Verbraucher die Standard-Zugangsdaten eines ausgewählten Mailservers verwenden dürfen oder ausdrücklich berechtigte, von Mail verwaltete Zugangsdaten auswählen müssen. Eine ausdrückliche Auswahl bleibt auch bei erlaubten Standard-Zugangsdaten möglich; Campaign speichert niemals lokale Passwörter.",
"i18n:govoplan-mail.deny.53577bb5": "Deny", "i18n:govoplan-mail.deny.53577bb5": "Deny",
"i18n:govoplan-mail.description.55f8ebc8": "Beschreibung", "i18n:govoplan-mail.description.55f8ebc8": "Beschreibung",
"i18n:govoplan-mail.development_mock_mailbox.1a379865": "Entwicklungs-Mailbox", "i18n:govoplan-mail.development_mock_mailbox.1a379865": "Entwicklungs-Mailbox",
+3 -3
View File
@@ -1,5 +1,5 @@
import { createElement, lazy } from "react"; import { createElement, lazy } from "react";
import type { MailDevMailboxUiCapability, MailProfilesUiCapability, PlatformWebModule, QuickAccessToolsUiCapability } from "@govoplan/core-webui"; import { messagesProductSurfaceTranslations, type MailDevMailboxUiCapability, type MailProfilesUiCapability, type PlatformWebModule, type QuickAccessToolsUiCapability } from "@govoplan/core-webui";
import { MailProfilePolicyEditor, MailProfileScopeManager } from "./features/mail/MailProfileManagement"; import { MailProfilePolicyEditor, MailProfileScopeManager } from "./features/mail/MailProfileManagement";
import { validateMailPolicy } from "./features/mail/mailPolicyValidation"; import { validateMailPolicy } from "./features/mail/mailPolicyValidation";
import { mailCredentialReferenceSelectors } from "./features/mail/mailReferenceProviders"; import { mailCredentialReferenceSelectors } from "./features/mail/mailReferenceProviders";
@@ -14,8 +14,8 @@ const mailboxRead = ["mail:mailbox:read"];
const bounceRead = ["mail:bounce:read", "mail:bounce:manage"]; const bounceRead = ["mail:bounce:read", "mail:bounce:manage"];
const legacyImportAccess = ["mail:pop3:import", "mail:pop3:manage"]; const legacyImportAccess = ["mail:pop3:import", "mail:pop3:manage"];
const translations = { const translations = {
en: generatedTranslations.en, en: { ...generatedTranslations.en, ...messagesProductSurfaceTranslations.en },
de: generatedTranslations.de de: { ...generatedTranslations.de, ...messagesProductSurfaceTranslations.de }
}; };
const mailQuickAccessTools: QuickAccessToolsUiCapability = { const mailQuickAccessTools: QuickAccessToolsUiCapability = {
tools: [ tools: [
+23 -68
View File
@@ -181,18 +181,6 @@
flex-direction: column; flex-direction: column;
} }
} }
.mailbox-page {
display: grid;
gap: 18px;
}
.mailbox-toolbar label {
display: grid;
gap: 5px;
min-width: min(340px, 100%);
}
.mailbox-toolbar label span,
.mailbox-preview-header span { .mailbox-preview-header span {
color: var(--muted); color: var(--muted);
font-size: 12px; font-size: 12px;
@@ -200,15 +188,6 @@
text-transform: uppercase; text-transform: uppercase;
} }
.mailbox-toolbar-meta {
flex: 1;
min-width: 0;
color: var(--muted);
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.mailbox-layout { .mailbox-layout {
display: grid; display: grid;
grid-template-columns: minmax(190px, 240px) minmax(0, 1.25fr) minmax(320px, .75fr); grid-template-columns: minmax(190px, 240px) minmax(0, 1.25fr) minmax(320px, .75fr);
@@ -388,11 +367,6 @@
} }
@media (max-width: 760px) { @media (max-width: 760px) {
.mailbox-toolbar {
align-items: stretch;
flex-direction: column;
}
.mailbox-layout { .mailbox-layout {
grid-template-columns: 1fr; grid-template-columns: 1fr;
} }
@@ -402,7 +376,10 @@
/* Mailbox work surface: shared explorer/list pattern with mail-specific columns. */ /* Mailbox work surface: shared explorer/list pattern with mail-specific columns. */
.mailbox-shell.file-manager-shell { .mailbox-shell.file-manager-shell {
position: relative; position: relative;
flex: 1 1 auto;
min-height: 0;
grid-template-columns: minmax(230px, 290px) minmax(390px, 1fr) minmax(340px, .82fr); grid-template-columns: minmax(230px, 290px) minmax(390px, 1fr) minmax(340px, .82fr);
grid-template-rows: minmax(0, 1fr);
} }
.mailbox-shell.is-loading .mailbox-preview-panel { .mailbox-shell.is-loading .mailbox-preview-panel {
@@ -451,45 +428,11 @@
flex: 0 0 auto; flex: 0 0 auto;
} }
.mailbox-toolbar.file-manager-toolbar {
display: grid;
grid-template-columns: minmax(180px, 280px) minmax(0, 1fr) auto;
gap: 12px;
}
.mailbox-profile-field { .mailbox-profile-field {
display: grid; flex: 0 1 20rem;
gap: 4px;
min-width: 0; min-width: 0;
} }
.mailbox-profile-field > span {
color: var(--muted);
font-size: 11px;
font-weight: 800;
text-transform: uppercase;
}
.mailbox-toolbar-meta {
min-width: 0;
overflow: hidden;
color: var(--muted);
text-overflow: ellipsis;
white-space: nowrap;
}
.mailbox-toolbar-actions {
display: flex;
flex-wrap: wrap;
justify-content: flex-end;
gap: 8px;
min-width: 0;
}
.mailbox-toolbar-actions .btn {
white-space: nowrap;
}
.mailbox-profile-blocker { .mailbox-profile-blocker {
margin: 12px; margin: 12px;
} }
@@ -680,25 +623,37 @@
@media (max-width: 1280px) { @media (max-width: 1280px) {
.mailbox-shell.file-manager-shell { .mailbox-shell.file-manager-shell {
grid-template-columns: minmax(220px, 280px) minmax(0, 1fr); grid-template-columns: minmax(220px, 280px) minmax(0, 1fr);
grid-template-rows: minmax(0, 1.4fr) minmax(0, 1fr);
} }
.mailbox-preview-panel { .mailbox-preview-panel {
grid-column: 1 / -1; grid-column: 1 / -1;
min-height: 320px; min-height: 0;
border-top: var(--border-line); border-top: var(--border-line);
} }
} }
@media (max-width: 760px) { @media (max-width: 760px) {
.mailbox-toolbar.file-manager-toolbar { .mailbox-shell.file-manager-shell {
grid-template-columns: 1fr; grid-template-columns: minmax(0, 1fr);
/* The three domain panes no longer compete for a fraction of one short
mobile viewport. Scroll this bounded workspace, not the action header;
the index and preview retain their own usable, bounded scroll regions. */
grid-template-rows: 8rem max-content minmax(14rem, 35dvh);
align-content: start;
overflow-y: auto;
} }
.mailbox-toolbar-actions { .mailbox-page .mailbox-message-list-panel {
justify-content: flex-start; display: grid;
/* Header and pagination take their intrinsic space. The message viewport
has its own bound, so translated wrapping cannot squeeze it to zero. */
grid-template-rows: auto clamp(8rem, 24dvh, 14rem) auto;
border-right: 0;
border-top: var(--border-line);
} }
.mailbox-message-head { .mailbox-page .mailbox-message-head {
display: none; display: none;
} }
@@ -706,7 +661,7 @@
min-width: 0; min-width: 0;
} }
.mailbox-message-row { .mailbox-page .mailbox-message-row {
grid-template-columns: 1fr; grid-template-columns: 1fr;
gap: 8px; gap: 8px;
} }