GovOPlaN/govoplan-mail
2
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(mail): complete German help coverage
Module Package Release / publish-packages (push) Successful in 11s
Details

Browse Source
This commit is contained in:
zemion
2026-08-22 05:44:34 +02:00
parent 218fef11f1
commit fd808336bc
10 changed files with 315 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/govoplan_mail/backend/manifest.py
+221 -1
View File
@@ -400,7 +400,7 @@ POP3_PROVIDER = ExternalProviderDeclaration(
manifest = ModuleManifest(
id="mail",
name="Mail",
version="0.1.20",
version="0.1.21",
required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR),
optional_dependencies=("campaigns", "addresses", "calendar", "postbox", "search"),
provides_interfaces=(
@@ -615,10 +615,75 @@ manifest = ModuleManifest(
),
related_modules=("audit", "records"),
unlocks=("Governed retirement of legacy POP3 mailboxes without making destructive retrieval the default.",),
translations={
"de": {
"title": "Nachrichten aus einem alten POP3-Postfach importieren",
"summary": "Begrenzt viele POP3-Nachrichten in verschlüsselte lokale Prüfdatensätze übernehmen, ohne die Quelldaten standardmäßig zu löschen.",
"body": (
"POP3 ist ausschließlich ein nachrangiger Migrationsweg und wird niemals stillschweigend aktiviert. "
"Eine Mail-Administration legt eine eigene POP3-Quelle an, aktiviert den Altimport ausdrücklich, "
"hinterlegt Zugangsdaten verschlüsselt, prüft TLS und Anmeldung und entscheidet getrennt, ob das Löschen "
"an der Quelle überhaupt angefordert werden darf. Importberechtigte laden eine begrenzte Live-Vorschau, "
"wählen Nachrichten anhand stabiler UIDL-Kennungen und übernehmen sie als verschlüsselte Datensätze mit "
"ausstehender Prüfung. Wiederholte Importe werden als Duplikate ausgewiesen und nicht erneut gespeichert. "
"Quelldaten bleiben unverändert, solange nicht die Endpunktrichtlinie Löschen nach Import erlaubt, die "
"ausführende Person zusätzlich mail:pop3:delete besitzt und das Löschen für den konkreten Stapel ausdrücklich "
"ausgewählt wird. Mail schreibt und protokolliert zuerst den lokalen Import und versucht erst danach die "
"Löschung beim Anbieter. Eine fehlgeschlagene oder unklare Löschung entfernt deshalb niemals den verwalteten "
"lokalen Datensatz und muss vor einem weiteren destruktiven Versuch abgestimmt werden. Für den laufenden "
"Postfachzugriff sind IMAP oder JMAP vorzuziehen."
),
}
},
metadata={
"kind": "workflow",
"route": "/mail/legacy-import",
"screen": "Legacy POP3 import",
"help_contexts": [
"mail.pop3",
"mail.pop3.source-editor",
"mail.pop3.action.reload",
"mail.pop3.action.create-source",
"mail.pop3.action.configure-source",
"mail.pop3.action.save-source",
"mail.pop3.action.test",
"mail.pop3.action.preview",
"mail.pop3.action.import",
"mail.pop3.field.profile",
"mail.pop3.field.name",
"mail.pop3.field.host",
"mail.pop3.field.port",
"mail.pop3.field.transport-security",
"mail.pop3.field.timeout",
"mail.pop3.field.max-message-size",
"mail.pop3.field.max-batch-size",
"mail.pop3.field.preview-body-lines",
"mail.pop3.field.username",
"mail.pop3.field.password",
"mail.pop3.field.enabled",
"mail.pop3.field.allow-delete-after-import",
"mail.pop3.field.message-selection",
"mail.pop3.field.delete-after-import",
"mail.pop3.confirm-delete-source",
],
"fields": [
{
"label": "Transport security",
"user_description": "Use TLS or STARTTLS; unencrypted transport remains subject to deployment egress policy and is not the safe default.",
},
{
"label": "Message and batch limits",
"user_description": "Bound both each downloaded message and the total imported batch before provider content enters local encrypted storage.",
},
{
"label": "Explicitly enable legacy import",
"user_description": "Keeps the source inert until endpoint metadata and its encrypted credential have both been stored.",
},
{
"label": "Permit delete-after-import requests",
"user_description": "Allows, but never selects, the separately authorized destructive request; each batch still needs explicit confirmation.",
},
],
"steps": [
"Ask a Mail administrator to configure and explicitly enable a dedicated POP3 legacy source.",
"Test the source and refresh a bounded preview; no message flags or deletion state are changed.",
@@ -630,6 +695,11 @@ manifest = ModuleManifest(
"POP3 has no folder or flag semantics and is not the recommended protocol for ongoing mailbox access.",
"Source deletion cannot be rolled back and may have an unknown outcome if the connection fails while QUIT commits deletions.",
],
"operational_consequences": [
"Changing host, port, security, account identity, or import limits rotates the transport revision and invalidates stale previews.",
"Enabling source deletion creates an irreversible external effect boundary; unknown QUIT outcomes require reconciliation rather than blind retry.",
"Disabling legacy import leaves governed local imports and their evidence available for review while preventing new provider access.",
],
"verification": "Prove disabled policy, TLS and authentication diagnostics, non-destructive preview/import, UIDL duplicate prevention, encrypted raw retention, separate delete authorization, import-before-delete audit ordering, and failed or outcome-unknown deletion evidence.",
},
),
@@ -656,6 +726,27 @@ manifest = ModuleManifest(
DocumentationLink(label="Mail handbook", href="govoplan-mail/docs/MAIL_HANDBOOK.md", kind="repository"),
),
related_modules=("access", "audit", "campaigns", "postbox"),
translations={
"de": {
"title": "Mail-Daten in einer Auskunftsanfrage prüfen",
"summary": "Mandantenbezogene Mail-Metadaten zusammentragen und dabei Transportnachweise sowie die Zuständigkeit des externen Postfachs bewahren.",
"body": (
"Der Mail-Provider für Betroffenenanfragen durchsucht den wirksamen Mandanten anhand normalisierter "
"Absender-, Empfänger- oder Unzustellbarkeitsadressen, direkter Mitgliedschaftsverweise und namensraumgebundener "
"Verweise auf Mail-Profile, Nachrichtenindizes, POP3-Importe, Zustellbefehle oder Rückläufer. Er grenzt nur "
"passende Absender-, An- und Cc-Beteiligte ab und liefert begrenzte Inhalte aus Nachrichtenindex oder Import, "
"sichere Metadaten persönlicher Profile sowie Zustell-, Versuch-, Abstimmungs- und Rückläufergebnisse. "
"Ausgeschlossen bleiben SMTP-, IMAP- und POP3-Konfiguration, Benutzernamen und Zugangsdaten, verschlüsselte "
"Nachrichten und Umschläge, POP3-UIDLs und Quellrevisionen, Ablehnungsdetails, Postfachordner und UIDs, Endpunkt- "
"und Zugangsdatenkennungen, Idempotenz- und Worker-Ansprüche, Diagnosen, Fehlertexte und undurchsichtige Nachweise. "
"Zustellversuche, Abstimmungsentscheidungen und Rückläuferbeobachtungen bleiben als unveränderliche Transport- "
"und Wiederherstellungsnachweise erhalten. Nachrichtenindizes, verschlüsselte POP3-Importe und persönliche Profile "
"müssen in Mail und im maßgeblichen externen Postfach manuell geprüft werden. Der Provider löscht nicht unmittelbar, "
"weil das Entfernen eines abgeleiteten oder importierten Datensatzes den Zustand seiner externen Quelle nicht belegt "
"und Änderungen an Profilen oder Zustellbefehlen Zugangsdaten, andere Personen und aufbewahrte Nachweise betreffen können."
),
}
},
metadata={
"kind": "workflow",
"route": "/admin?section=tenant-data-subject-requests",
@@ -855,6 +946,19 @@ manifest = ModuleManifest(
documentation_types=("admin", "user"),
audience=("mail_user", "mail_admin", "administrator"),
related_modules=("search",),
translations={
"de": {
"title": "Berechtigte Postfachnachrichten durchsuchen",
"summary": "Begrenzte Metadaten und Vorschauen aus dem zwischengespeicherten Postfach für die berechtigungsbewusste Plattformsuche bereitstellen.",
"body": (
"Ist Search installiert, stellt Mail seinen nur lesbaren Postfachzwischenspeicher bereit, niemals Zugangsdaten "
"oder unbegrenzte Rohnachrichten. Ergebnisse erfordern sowohl Leseberechtigung für das Postfach als auch "
"Nutzungsberechtigung für das Profil. Vor jeder Ausgabe werden aktueller Profilbereich, Richtlinie, Aktivität "
"sowie Sichtbarkeit für Mandant, Person, Gruppe oder Campaign erneut geprüft. Postfachaktualisierungen veröffentlichen "
"dauerhafte Indexänderungen; für die Abstimmung bleibt ein vollständiger Neuaufbau verfügbar."
),
}
},
order=39,
),
DocumentationTopic(
@@ -883,6 +987,17 @@ manifest = ModuleManifest(
related_modules=("campaigns",),
unlocks=("Campaign-local delivery rules become visible when govoplan-campaign is installed.",),
configuration_keys=("mail_profile_policy",),
translations={
"de": {
"title": "Mail-Profile und Richtlinienhierarchie",
"summary": "Den Mail-Versand über wiederverwendbare SMTP-/IMAP-Profile und eine wirksame Richtlinie aus System-, Mandanten-, Eigentümer- und gegebenenfalls Campaign-Ebene steuern.",
"body": (
"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. "
"Die Laufzeitdokumentation ergänzt die aktuelle Lage des Mandanten, wenn die handelnde Person die Mail-Profilrichtlinie lesen darf."
),
}
},
metadata={
"kind": "reference",
"route": "/settings?section=mail-profiles",
@@ -918,6 +1033,21 @@ manifest = ModuleManifest(
DocumentationLink(label="Mail handbook", href="govoplan-mail/docs/MAIL_HANDBOOK.md", kind="repository"),
),
related_modules=("campaigns",),
translations={
"de": {
"title": "Standardordner eines IMAP-Profils zuordnen",
"summary": "Zuordnungen für Posteingang, Gesendet, Entwürfe, Papierkorb, Archiv und Junk am wiederverwendbaren Mail-Profil speichern und durch begrenzte IMAP-Erkennung vorbelegen.",
"body": (
"Ordnernamen sind Metadaten des Profils beziehungsweise Servers und keine Campaign-Einstellungen. Eine berechtigte "
"Profiladministration kann Namen direkt eintragen oder die Ordnererkennung verwenden; leere Zuordnungen behalten "
"das automatische Verhalten bei. Vorhandene Werte aus imap.sent_folder werden als Zuordnung für Gesendet angezeigt "
"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. "
"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."
),
}
},
metadata={
"kind": "workflow",
"route": "/settings?section=mail-profiles",
@@ -958,6 +1088,20 @@ manifest = ModuleManifest(
),
),
related_modules=("campaigns", "calendar", "audit"),
translations={
"de": {
"title": "Zustellstatus und Rückläufer verarbeiten",
"summary": "Einen berechtigten IMAP-Ordner beobachten und DSN-Ergebnisse mit dauerhaften Mail-Befehlen abgleichen.",
"body": (
"Mail speichert die ausgehende RFC-Message-ID zusammen mit dem dauerhaften Befehl, verarbeitet begrenzte "
"message/delivery-status-Berichte ohne Postfachkennzeichen zu ändern und zeichnet je Empfänger idempotente "
"Beobachtungen auf. Die SMTP-Annahme bleibt von einem späteren Rückläufer getrennt. Nicht zuordenbare Berichte "
"bleiben zur Prüfung sichtbar; Mail speichert nur begrenzte Diagnosen und einen Digest des Rohinhalts, nicht den "
"Rohtext des Rückläufers. Ist Calendar aktiv, leitet derselbe begrenzte Quellscan iCalendar-Teile mit METHOD:REPLY "
"zur idempotenten Abstimmung der Teilnehmenden an Calendar weiter, ohne die Nachricht als Rückläufer einzuordnen."
),
}
},
metadata={
"kind": "workflow",
"route": "/mail/bounces",
@@ -996,6 +1140,21 @@ manifest = ModuleManifest(
),
related_modules=("campaigns", "access"),
unlocks=("Reusable, governed delivery identities without cross-module secret duplication.",),
translations={
"de": {
"title": "Mail besitzt Transportprofile und Zugangsdaten",
"summary": "Andere Module wählen berechtigte Mail-Profile über stabile Kennungen aus; sie kopieren weder SMTP-/IMAP-Einstellungen noch Geheimnisse.",
"body": (
"Mail verschlüsselt Zugangsdaten, prüft Verbindungen, bewertet Profilbereich und Richtlinie und führt "
"revisionsgebundene Transportwirkungen aus, ohne die aufgelöste Konfiguration zurückzugeben. Zufällige gespeicherte "
"Revisionen wechseln, wenn sich normalisierte Transportdaten oder die Kontoidentität ändern; eine reine "
"Passwortrotation bleibt für bereits aufgebauten fachlichen Willen transparent. Campaign speichert nur "
"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 "
"Auditdatensatz bewahrt und eine bearbeitbare Version aktualisiert."
),
}
},
metadata={
"kind": "reference",
"route": "/settings?section=mail-profiles",
@@ -1030,6 +1189,17 @@ manifest = ModuleManifest(
),
related_modules=("campaigns",),
unlocks=("Reusable SMTP/IMAP identities that consumers can reference without handling credentials.",),
translations={
"de": {
"title": "Ein wiederverwendbares Mail-Profil auswählen und prüfen",
"summary": "Ein im aktuellen Kontext sichtbares Profil auswählen, seine SMTP- oder IMAP-Verbindung prüfen und im verbrauchenden Vorgang nur den stabilen Verweis speichern.",
"body": (
"Profiltests prüfen die aktuelle Verbindung und Anmeldung mit den von Mail verwalteten Zugangsdaten. Sie belegen "
"weder eine spätere Richtlinienfreigabe in Campaign noch Zustellbarkeit, Empfängerannahme oder künftige Verfügbarkeit. "
"Verwenden Sie die Auswahlkomponente, statt Kennungen einzugeben oder Transporteinstellungen in ein anderes Modul zu kopieren."
),
}
},
metadata={
"kind": "workflow",
"route": "/settings?section=mail-profiles",
@@ -1073,6 +1243,20 @@ manifest = ModuleManifest(
DocumentationLink(label="Mail handbook", href="govoplan-mail/docs/MAIL_HANDBOOK.md", kind="repository"),
),
unlocks=("Read-only access to an authorized operational mailbox without broadening profile administration rights.",),
translations={
"de": {
"title": "Ein berechtigtes Postfach ohne Änderungen lesen",
"summary": "Ein IMAP-fähiges Profil auswählen, synchronisierte Ordner durchsuchen und begrenzte Nachrichteninhalte in der nur lesbaren Postfachoberfläche prüfen.",
"body": (
"Der Postfachzugriff erfordert sowohl Leseberechtigung für das Postfach als auch Nutzungsberechtigung für ein "
"im Bereich der handelnden Person sichtbares Profil. 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 "
"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 "
"unbegrenzten Inhalte offenlegen."
),
}
},
metadata={
"kind": "workflow",
"route": "/mail",
@@ -1117,6 +1301,21 @@ manifest = ModuleManifest(
),
related_modules=("audit",),
unlocks=("A testable Mail trust boundary with fail-closed egress and auditable secret disposal.",),
translations={
"de": {
"title": "Mail-Zugangsdaten, Netzausgänge und Außerbetriebnahme schützen",
"summary": "Geheimnisse in Mail belassen, jeden SMTP-/IMAP-/POP3-Gegenpunkt fest binden, Antworten begrenzen und eigene Zugangsdaten sofort mit nicht geheimem Auditnachweis löschen.",
"body": (
"Der Zugriff von Konnektoren auf private Netze wird bereitstellungsweit gesteuert; dennoch wird jeder erlaubte "
"Hostname in einen freigegebenen Gegenpunkt aufgelöst und beim Aufbau des Sockets fest gebunden. Nicht unterstützte "
"Transporte scheitern vor dem Verbindungsaufbau. Beim Löschen eines Profils werden dessen verschlüsselte SMTP-, IMAP- "
"und POP3-Passwörter sofort entfernt und, sofern Geheimnisse vorhanden waren, mit nicht geheimen Angaben protokolliert. "
"Scheitert das Entfernen oder das Audit, wird die Aktion zurückgerollt. Verschlüsselte POP3-Importinhalte folgen der "
"Aufbewahrung von Mail beziehungsweise Records. Bei einer destruktiven Modulaußerbetriebnahme gilt dieselbe Regel: "
"Zuerst werden Geheimnisse entfernt, erst danach alle Mail-Tabellen einschließlich der Importdaten gelöscht."
),
}
},
metadata={
"kind": "reference",
"route": "/settings?section=mail-profiles",
@@ -1152,6 +1351,27 @@ manifest = ModuleManifest(
),
related_modules=("campaigns", "audit"),
unlocks=("Profile-backed campaign delivery without cross-module credential or configuration copies.",),
translations={
"de": {
"title": "Campaign über den Mail-Zustellvertrag integrieren",
"summary": "Campaign friert Profilverweis und undurchsichtige Revision ein; Mail berechtigt erneut, prüft die Revision, löst Zugangsdaten auf und führt die Wirkung in einem Aufruf aus.",
"body": (
"Der Vertrag mail.campaign_delivery 0.2 gibt niemals entschlüsselte Zugangsdaten oder aufgelöste SMTP-/IMAP-Konfiguration zurück. "
"Mail vergleicht die erwartete zufällige Transportrevision vor dem Entschlüsseln protokollspezifischer Zugangsdaten und liefert "
"nur begrenzte, bereinigte Ergebnisse. Synchrone Stapel berechtigen die vollständige Empfängermenge und prüfen DNS, Netzausgang, "
"Verbindung, TLS und Anmeldung vor der ersten Wirkung. Wenn die Bereitstellungsrichtlinie es erlaubt, verwendet Mail die begrenzte "
"Verbindung erneut, prüft sie zuvor und verbindet vor der nächsten Nachricht neu, sobald sie veraltet ist. Ein Verbindungsverlust nach "
"Beginn von DATA bleibt mit unbekanntem Ergebnis bestehen und wird niemals automatisch wiederholt. Systemische Anmelde-, Absender- oder "
"Verbindungsfehler tragen stabile Ursachencodes, damit Campaign verbleibende Aufträge anhält und Verbindung, Neuverbindung, Fehler und "
"Pausenfortschritt anzeigt. Campaign besitzt gewöhnliche Empfängeraufträge; Berichtsnachrichten nutzen das verschlüsselte, idempotente "
"Zustellbefehls- und Versuchsledger von Mail. Jeder aktuelle SMTP- und Gesendet-Ordner-Versuch übergibt vor dem Providerkontakt eine "
"stabile Wirkungskennung an einen von Mail besessenen Core-Wiederherstellungsvorgang. Der Nachweis des Wirkungsbeginns verhindert blinde "
"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 "
"angenommene Befehle und Nachweise daher zur Klärung durch den Betrieb unverändert bestehen."
),
}
},
metadata={
"kind": "reference",
"route": "/campaigns/{campaign_id}/mail-settings",