Mercurial > p > roundup > code

comparison roundup/mailgw.py @ 5056:d995ee7d49bf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
5055:a2b7cfa8d7e9 5056:d995ee7d49bf
29 subpart and ignore the other parts. 29 subpart and ignore the other parts.
30 . A message/rfc822 is treated similar tomultipart/mixed (except for 30 . A message/rfc822 is treated similar tomultipart/mixed (except for
31 special handling of the first text part) if unpack_rfc822 is set in 31 special handling of the first text part) if unpack_rfc822 is set in
32 the mailgw config section. 32 the mailgw config section.
33 33
34 Summary
35 -------
36 The "summary" property on message nodes is taken from the first non-quoting
37 section in the message body. The message body is divided into sections by
38 blank lines. Sections where the second and all subsequent lines begin with
39 a ">" or "|" character are considered "quoting sections". The first line of
40 the first non-quoting section becomes the summary of the message.
41
42 Addresses 34 Addresses
43 --------- 35 ---------
44 All of the addresses in the To: and Cc: headers of the incoming message are 36 All of the addresses in the To: and Cc: headers of the incoming message are
45 looked up among the user nodes, and the corresponding users are placed in 37 looked up among the user nodes, and the corresponding users are placed in
46 the "recipients" property on the new "msg" node. The address in the From: 38 the "recipients" property on the new "msg" node. The address in the From:
52 register an auditor on the "user" class that prevents the creation of user 44 register an auditor on the "user" class that prevents the creation of user
53 nodes with no passwords. 45 nodes with no passwords.
54 46
55 Actions 47 Actions
56 ------- 48 -------
57 The subject line of the incoming message is examined to determine whether 49 The subject line of the incoming message is examined to determine
58 the message is an attempt to create a new item or to discuss an existing 50 whether the message is an attempt to create a new item, discuss an
59 item. A designator enclosed in square brackets is sought as the first thing 51 existing item, or execute some other command.
60 on the subject line (after skipping any "Fwd:" or "Re:" prefixes). 52
53 If the subject consists of one of the following (case insensitive),
54 the corresponding action is taken:
55
56 help
57 Respond with an explanation of this interface.
58
59 If the subject contains the following, the corresponding action is
60 taken:
61
62 -- key <OneTimeKey>
63 Complete an in-progress user registration.
64
65 If the email is not a command, it is either a new item or a message
66 associated with an existing item. A designator enclosed in square
67 brackets is sought as the first thing on the subject line (after
68 skipping any "Fwd:" or "Re:" prefixes).
61 69
62 If an item designator (class name and id number) is found there, the newly 70 If an item designator (class name and id number) is found there, the newly
63 created "msg" node is added to the "messages" property for that item, and 71 created "msg" node is added to the "messages" property for that item, and
64 any new "file" nodes are added to the "files" property for the item. 72 any new "file" nodes are added to the "files" property for the item.
65 73
66 If just an item class name is found there, we attempt to create a new item 74 If just an item class name is found there, we attempt to create a new item
67 of that class with its "messages" property initialized to contain the new 75 of that class with its "messages" property initialized to contain the new
68 "msg" node and its "files" property initialized to contain any new "file" 76 "msg" node and its "files" property initialized to contain any new "file"
69 nodes. 77 nodes.
78
79 Summary
80 -------
81 The "summary" property on message nodes is taken from the first non-quoting
82 section in the message body. The message body is divided into sections by
83 blank lines. Sections where the second and all subsequent lines begin with
84 a ">" or "|" character are considered "quoting sections". The first line of
85 the first non-quoting section becomes the summary of the message.
70 86
71 Triggers 87 Triggers
72 -------- 88 --------
73 Both cases may trigger detectors (in the first case we are calling the 89 Both cases may trigger detectors (in the first case we are calling the
74 set() method to add the message to the item's spool; in the second case we 90 set() method to add the message to the item's spool; in the second case we
Roundup Issue Tracker: http://roundup-tracker.org/