From 37241464a711c0c67bd94aef63db276d3647ba9a Mon Sep 17 00:00:00 2001 From: tgiachi Date: Tue, 10 Nov 2026 11:42:42 +0100 Subject: [PATCH] docs: held queue summary, bounds and the From header in the API and README --- README.md | 4 ++++ docs/openapi.yaml | 7 +++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6f52ba..61453bc 100644 --- a/README.md +++ b/README.md @@ -249,6 +249,10 @@ lists.example.org lmtp:inet:127.0.0.1:2424 and `Reply-To` come from the header; so a post whose header names someone else (or has no usable `From`, or several addresses) is held for moderation instead of delivered, with the reason shown to the admin (API, CLI, UI). Let Postfix reject forged senders too (SPF, DKIM, DMARC checks on inbound mail). +- **The moderation queue is bounded.** A list holds at most 500 messages and 200 MiB, and one held message at most 10 MiB; a + full queue answers `452` (the sender retries later), a message over 10 MiB `552`. Messages nobody moderated for 30 days + are dropped. Listings (API, CLI, UI) show a summary and never read the bodies. The held view shows the From header + readers would see next to the real sender and flags a difference. - **API token.** `parsimony serve` refuses a token shorter than 24 characters or containing whitespace (`openssl rand -hex 24` makes a good one). After 10 wrong or missing tokens within 5 minutes an address is locked out for 5 minutes (HTTP 429, valid token included). The address is the TCP peer: behind a reverse proxy diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 57a00b1..d5b334b 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -56,9 +56,12 @@ components: type: object properties: id: {type: integer} - sender: {type: string} - subject: {type: string} + sender: {type: string, description: The SMTP (envelope) sender} + from: {type: string, description: "The From header as received: the author readers will see (at most 200 characters)"} + mismatch: {type: boolean, description: The From header names someone other than the sender, or no usable address} + subject: {type: string, description: Decoded, at most 200 characters} size: {type: integer} + reason: {type: string, description: Why the message was held} created_at: {type: string, format: date-time} Error: type: object