fix(kerio): korrekte Admin-API gemäß Delivery.idl + Pop3Account-Doku

- Methoden: Delivery.getPop3AccountList / addPop3AccountList /
  setPop3Account (vorher geraten als Pop3Accounts.set/.create →
  Method not found).
- Pop3Account-Felder mit den richtigen Namen: isActive (statt enabled),
  mode (statt sslMode), authentication (statt authType), und
  leaveOnServer.removeAfterPeriod als OptionalLong-Wrapper.
  Falsche Namen wurden von Kerio still ignoriert → Sammler war inaktiv.
- User-Struct: allowPasswordChange=false (statt mayChangePassword,
  das es nicht gibt). emailAddresses weggelassen, Kerio leitet die
  primäre Adresse aus loginName+domain ab.
- Kerio-Step in 2 Sub-Steps aufgeteilt: User (skip wenn vorhanden) +
  POP3 (upsert). Damit wird bei einem zweiten Lauf der Sammler nicht
  übersprungen, nur weil der User schon existiert.
- POP3-Sammler ist jetzt UPSERT: existierende werden via setPop3Account
  überschrieben → Selbstreparatur kaputter Einträge + Passwort-
  Änderungen aus der CSV ziehen sich von selbst nach.

GUI: 👁/🙈-Toggle pro Passwort-Feld (Klartext temporär einsehbar).

Filenames der Sammel-PDFs + Admin-Report ohne Zeitstempel –
erneuter Lauf überschreibt statt anzuhäufen.

README: Ablauf-Sektion + Idempotenz-Tabelle aktualisiert; Kerio-
Caveat ersetzt durch konkrete Methoden-/Feld-Liste mit Doku-Link.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-12 14:09:06 +02:00
parent 4711c55d89
commit 06d7e00e49
4 changed files with 235 additions and 86 deletions
+127 -28
View File
@@ -108,12 +108,13 @@ class KerioClient:
raise KerioError(f"Kerio: Domain '{domain_name}' nicht in Kerio konfiguriert")
return items[0]["id"]
def user_exists(self, email: str) -> bool:
def find_user_id(self, email: str) -> Optional[str]:
"""User-ID aus E-Mail finden, oder None wenn nicht vorhanden."""
local, domain = email.split("@", 1)
try:
domain_id = self.get_domain_id(domain)
except KerioError:
return False
return None
result = self._call("Users.get", {
"query": {
"fields": ["id", "loginName"],
@@ -129,23 +130,75 @@ class KerioClient:
},
"domainId": domain_id,
})
return bool(result.get("list"))
items = result.get("list") or []
if not items:
return None
return items[0].get("id")
def user_exists(self, email: str) -> bool:
return self.find_user_id(email) is not None
# ----- POP3 Download Accounts -----
# Korrekte API laut Kerio Connect Doku (Delivery.idl):
# Delivery.getPop3AccountList() → {"list": [Pop3Account, …]}
# Delivery.addPop3AccountList(accs) → {"errors": [...]}
# Delivery.removePop3AccountList(ids)
# Delivery.setPop3Account(id, acc)
# Delivery.runPop3Downloads()
def _pop3_get_all(self) -> list:
# SearchQuery ist Pflicht-Input ohne den liefert Kerio eine leere Liste
# (still!), und unser Existenz-Check würde immer "nicht vorhanden" sagen.
got = self._call("Delivery.getPop3AccountList", {
"query": {
"fields": [],
"start": 0,
"limit": 100000,
"orderBy": [],
"conditions": [],
"combining": "And",
},
})
return got.get("list") or []
def find_pop3_collector(self, *, deliver_to_email: str,
server: str, login_name: str) -> Optional[dict]:
"""Sucht einen Sammler über (deliveryAddress, server, userName).
Gibt das Pop3Account-Dict zurück (inkl. id) oder None."""
try:
accounts = self._pop3_get_all()
except KerioError:
return None
server_l = (server or "").lower()
login_l = (login_name or "").lower()
deliver_l = (deliver_to_email or "").lower()
for acc in accounts:
if ((acc.get("deliveryAddress") or "").lower() == deliver_l
and (acc.get("server") or "").lower() == server_l
and (acc.get("userName") or "").lower() == login_l):
return acc
return None
def pop3_collector_exists(self, **kw) -> bool:
return self.find_pop3_collector(**kw) is not None
def create_user(self, email: str, password: str, full_name: str) -> str:
local, domain = email.split("@", 1)
domain_id = self.get_domain_id(domain)
# Minimal-Set:
# - authType/role weggelassen (versions-spezifische Enums, Default reicht)
# - emailAddresses weggelassen: das ist die Alias-Liste in Kerio.
# Die primäre Adresse leitet Kerio automatisch aus loginName@domain
# ab, also `local@domain`.
# - allowPasswordChange=false: User kann sein Passwort NICHT selbst
# ändern (Feldname laut User-Struct in der Kerio-Doku).
user_def = {
"loginName": local,
"fullName": full_name,
"domainId": domain_id,
"password": password,
"authType": "Internal",
"isEnabled": True,
"role": "UserRole",
"emailAddresses": [email],
# User darf sein Passwort NICHT selbst ändern
"mayChangePassword": False,
"forceChangePassword": False,
"allowPasswordChange": False,
}
result = self._call("Users.create", {"users": [user_def]})
errors = result.get("errors") or []
@@ -158,24 +211,70 @@ class KerioClient:
# ----- POP3 Sammler -----
def add_pop3_collection(self, *, kerio_user_id: str,
server: str, login_name: str, password: str,
port: int = 465, ssl: bool = True,
leave_days: int = 14) -> None:
account = {
"enabled": True,
"deliverTo": kerio_user_id,
"server": server,
"loginName": login_name,
"password": password,
"port": port,
"ssl": ssl,
"useSpecificPort": True,
"leaveOnServer": True,
"deleteOnServer": True,
"deleteOnServerDays": leave_days,
}
result = self._call("Pop3Accounts.create", {"accounts": [account]})
def upsert_pop3_collection(self, *, deliver_to_email: str,
server: str, login_name: str, password: str,
port: int = 995, ssl: bool = True,
leave_days: int = 14) -> str:
"""Legt einen POP3-Sammler an oder aktualisiert ihn (Idempotent).
Returns: "angelegt" | "aktualisiert"
"""
existing = self.find_pop3_collector(
deliver_to_email=deliver_to_email,
server=server, login_name=login_name,
)
new_account = self._build_pop3_account(
deliver_to_email=deliver_to_email, server=server,
login_name=login_name, password=password,
port=port, ssl=ssl, leave_days=leave_days,
)
if existing:
account_id = existing.get("id")
if not account_id:
raise KerioError("Kerio: vorhandener Sammler ohne id zurückgegeben")
new_account["id"] = account_id
self._call("Delivery.setPop3Account",
{"accountId": account_id, "account": new_account})
return "aktualisiert"
self._add_pop3_account_list([new_account])
return "angelegt"
def _add_pop3_account_list(self, accounts: list) -> None:
result = self._call("Delivery.addPop3AccountList",
{"accounts": accounts})
errors = result.get("errors") or []
if errors:
raise KerioError(f"Kerio Pop3Accounts.create errors: {errors}")
raise KerioError(f"Kerio Delivery.addPop3AccountList errors: {errors}")
def _build_pop3_account(self, *, deliver_to_email: str,
server: str, login_name: str, password: str,
port: int, ssl: bool, leave_days: int) -> dict:
# Pop3Account-Felder, exakt wie in der Kerio-Doku
# (struct Pop3Account + LeaveOnServer):
# isActive (bool, NICHT "enabled"!) sonst defaultet auf inaktiv
# server, port, userName, password, deliveryAddress
# mode: SslMode = NoSsl | SpecialPort | StlsCommand
# authentication: Pop3Authentication = PlainPop3 | Apop
# leaveOnServer { enabled, removeAfterPeriod: OptionalLong{enabled,value} }
new_account = {
"isActive": True,
"server": server,
"port": port,
"mode": "SpecialPort" if ssl else "NoSsl",
"authentication": "PlainPop3",
"userName": login_name,
"password": password,
"deliveryAddress": deliver_to_email,
"leaveOnServer": {
"enabled": True,
"removeAfterPeriod": {
"enabled": True,
"value": leave_days,
},
},
}
return new_account
# Backwards-kompatibler Alias
def add_pop3_collection(self, **kw) -> None:
self.upsert_pop3_collection(**kw)