# HG changeset patch
# User mortenp
# Date 1266489492 -39600
# Node ID 7e1127e22936328df99d60043e6dd7656d7168ec
# Parent  4a8acfd3f95ffde21e4a94e05c5d82f3ac06890c
added description of the keywords, added flow graph

diff -r 4a8acfd3f95f -r 7e1127e22936 README.access
--- a/README.access	Wed Feb 17 03:59:48 2010 +1100
+++ b/README.access	Thu Feb 18 21:38:12 2010 +1100
@@ -23,9 +23,42 @@
 - "Regexp" is a POSIX.2 extended regular expression. Matching is done case
   insensitive.
 
+The action "allow" will pass the mail on to the next step in processing. The
+mail may still be held for moderation, if it would have been so without access
+rules.
+
+The action "deny" will not send the mail to the mailing list, but will send a
+rejection mail to the sender.
+
+The action "discard" will not send the mail to the list, and will not send a
+rejection mail.
+
+The action "moderate" will hold the mail for moderation.
+
 IMPORTANT: if "moderate" is used then don't forget to add people who should
            function as moderators in listdir/control/moderators
 
+
+The flow out of the access system is like this:
+
+                      |
+                      v
++--------+   deny +--------+ discard   +---------+
+| reject |<-------| access |---------->| discard |
++--------+        +--------+           +---------+
+               allow |  | moderate
+                     |  +-----------+
+                     v              v
+               +------------+    +------+
+               | moderation |--->| hold |
+               +------------+    +------+
+                     |              |
+                     v              |
+                  +------+          |
+                  | send |<---------+
+                  +------+
+
+
 First a simple example. This rule set will reject any mail that is NOT plain
 text, or has a subject that contains "BayStar", and allow anything else: