diff options
| -rw-r--r-- | src/mailman/queue/docs/OVERVIEW.txt | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/src/mailman/queue/docs/OVERVIEW.txt b/src/mailman/queue/docs/OVERVIEW.txt index 46c70f574..41ccc18c9 100644 --- a/src/mailman/queue/docs/OVERVIEW.txt +++ b/src/mailman/queue/docs/OVERVIEW.txt @@ -13,16 +13,16 @@ wrapped scripts. E.g. for a list named ``mylist``, you'd have:: mylist -> post mylist-request -> request --request, -join, and -leave are a robot addresses; their sole purpose is to -process emailed commands, although the latter two are hardcoded to -subscription and unsubscription requests. -bounces is the automated bounce -processor, and all messages to list members have their return address set to --bounces. If the bounce processor fails to extract a bouncing member address, -it can optionally forward the message on to the list owners. +``-request``, ``-join``, and ``-leave`` are a robot addresses; their sole +purpose is to process emailed commands, although the latter two are hardcoded +to subscription and unsubscription requests. ``-bounces`` is the automated +bounce processor, and all messages to list members have their return address +set to ``-bounces``. If the bounce processor fails to extract a bouncing +member address, it can optionally forward the message on to the list owners. --owner is for reaching a human operator with minimal list interaction (i.e. no -bounce processing). -confirm is another robot address which processes replies -to VERP-like confirmation notices. +``-owner`` is for reaching a human operator with minimal list interaction +(i.e. no bounce processing). ``-confirm`` is another robot address which +processes replies to VERP-like confirmation notices. So delivery flow of messages look like this:: @@ -58,21 +58,22 @@ So delivery flow of messages look like this:: |[bounces] | +----------------------+ -A person can send an email to the list address (for posting), the -owner -address (to reach the human operator), or the -confirm, -join, -leave, and --request mailbots. Message to the list address are then forwarded on to the -list membership, with bounces directed to the -bounces address. +A person can send an email to the list address (for posting), the ``-owner`` +address (to reach the human operator), or the ``-confirm``, ``-join``, +``-leave``, and ``-request`` mailbots. Message to the list address are then +forwarded on to the list membership, with bounces directed to the -bounces +address. -[*] Messages sent to the -owner address are forwarded on to the list -owner/moderators. All -owner destined messages have their bounces directed to -the site list -bounces address, regardless of whether a human sent the message -or the message was crafted internally. The intention here is that the site -owners want to be notified when one of their list owners' addresses starts -bouncing (yes, the will be automated in a future release). +[*] Messages sent to the ``-owner`` address are forwarded on to the list +owner/moderators. All ``-owner`` destined messages have their bounces +directed to the site list ``-bounces`` address, regardless of whether a human +sent the message or the message was crafted internally. The intention here is +that the site owners want to be notified when one of their list owners' +addresses starts bouncing (yes, the will be automated in a future release). -Any messages to site owners has their bounces directed to a special -"loop-killer" address, which just dumps the message into -data/owners-bounces.mbox. +Any messages to site owners has their bounces directed to a special *loop +killer* address, which just dumps the message into +``data/owners-bounces.mbox``. Finally, message to any of the mailbots causes the requested action to be performed. Results notifications are sent to the author of the message, which |