diff roundup/mailgw.py @ 5056:d995ee7d49bf

issue2550757: one bug raised by issue fixed. Patch created by W. Trevor King (wking) for documentation of mailgw applied by John Rouillard.
author John Rouillard <rouilj@ieee.org>
date Sat, 30 Apr 2016 21:33:41 -0400
parents a46d5d0fd5f8
children d3d9d1402763
line wrap: on
line diff
--- a/roundup/mailgw.py	Sat Apr 16 22:58:13 2016 -0400
+++ b/roundup/mailgw.py	Sat Apr 30 21:33:41 2016 -0400
@@ -31,14 +31,6 @@
    special handling of the first text part) if unpack_rfc822 is set in
    the mailgw config section.
 
-Summary
--------
-The "summary" property on message nodes is taken from the first non-quoting
-section in the message body. The message body is divided into sections by
-blank lines. Sections where the second and all subsequent lines begin with
-a ">" or "|" character are considered "quoting sections". The first line of
-the first non-quoting section becomes the summary of the message.
-
 Addresses
 ---------
 All of the addresses in the To: and Cc: headers of the incoming message are
@@ -54,10 +46,26 @@
 
 Actions
 -------
-The subject line of the incoming message is examined to determine whether
-the message is an attempt to create a new item or to discuss an existing
-item. A designator enclosed in square brackets is sought as the first thing
-on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
+The subject line of the incoming message is examined to determine
+whether the message is an attempt to create a new item, discuss an
+existing item, or execute some other command.
+
+If the subject consists of one of the following (case insensitive),
+the corresponding action is taken:
+
+help
+  Respond with an explanation of this interface.
+
+If the subject contains the following, the corresponding action is
+taken:
+
+-- key <OneTimeKey>
+  Complete an in-progress user registration.
+
+If the email is not a command, it is either a new item or a message
+associated with an existing item.  A designator enclosed in square
+brackets is sought as the first thing on the subject line (after
+skipping any "Fwd:" or "Re:" prefixes).
 
 If an item designator (class name and id number) is found there, the newly
 created "msg" node is added to the "messages" property for that item, and
@@ -68,6 +76,14 @@
 "msg" node and its "files" property initialized to contain any new "file"
 nodes.
 
+Summary
+-------
+The "summary" property on message nodes is taken from the first non-quoting
+section in the message body. The message body is divided into sections by
+blank lines. Sections where the second and all subsequent lines begin with
+a ">" or "|" character are considered "quoting sections". The first line of
+the first non-quoting section becomes the summary of the message.
+
 Triggers
 --------
 Both cases may trigger detectors (in the first case we are calling the

Roundup Issue Tracker: http://roundup-tracker.org/