docs: describe which bounce reports count and the 30-day window

- README: only RFC 3464 reports with Action: failed and a
  recipient-unknown code count; bounces count for 30 days.
- openapi: Member.disabled and bounce_count say the count is recent.
This commit is contained in:
tgiachi 2026-11-10 11:51:17 +01:00
commit 8317e44338
2 changed files with 9 additions and 3 deletions

View file

@ -12,7 +12,7 @@ A modern, single-binary mailing list manager: an evolution of Mailman.
- Self-service subscribe and unsubscribe by email with double opt-in:
send to `list+join@domain` or `list+leave@domain`, then reply to the confirmation.
- Moderated lists: posts wait in a queue that the API can approve or discard.
- VERP bounces: every recipient gets a signed return address; 3 hard bounces disable a member.
- VERP bounces: every recipient gets a signed return address; 3 hard bounces within 30 days disable a member.
- Archive with full-text search (SQLite FTS5) and threading. Each list has an
`archive_policy`: `private` (default, API only), `public` (web pages) or `off`.
Public pages hide email addresses.
@ -183,6 +183,12 @@ It answers `451` only when the database itself fails.
delivery and counts as a hard bounce for the member (3 disable it). Nothing else counts: not "relay access denied", not a
refused sender (`5.1.7`, `5.1.8`, or any code answering `MAIL FROM`), not a refusal after `DATA`. Those deliveries are kept
as failed.
- A bounce that comes back later to the member's return address counts only if it is a real delivery status report
(RFC 3464: `multipart/report` with a `message/delivery-status` part) with `Action: failed` and one of the same
codes. A spam or policy rejection (`5.7.x`), a full mailbox (`5.2.x`), a delay, a `4.x.x`, or a `Status:` line in a
plain or quoted message does not count.
- Hard bounces count for 30 days: when the last one is older, the next one starts again from 1. A disabled member
stays disabled until it is added again.
- A relay that accepted the message is never asked again because `QUIT` went wrong.
- Delivery is at-least-once: a crash between the relay accepting a message and the queue entry being
removed can send one message to one recipient twice.

View file

@ -50,8 +50,8 @@ components:
properties:
address: {type: string}
display_name: {type: string}
disabled: {type: boolean, description: Disabled after 3 hard bounces; re-adding the member re-enables it}
bounce_count: {type: integer}
disabled: {type: boolean, description: Disabled after 3 hard bounces within 30 days; re-adding the member re-enables it}
bounce_count: {type: integer, description: Recent hard bounces (restarts at 1 when the last one is older than 30 days)}
Held:
type: object
properties: