Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 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 | df3f553fa414 64ceb9c14b28 |
comparison
equal
deleted
inserted
replaced
| 5055:a2b7cfa8d7e9 | 5056:d995ee7d49bf |
|---|---|
| 400 Subject-line information | 400 Subject-line information |
| 401 ------------------------ | 401 ------------------------ |
| 402 | 402 |
| 403 The subject line of the incoming message is examined to find one of: | 403 The subject line of the incoming message is examined to find one of: |
| 404 | 404 |
| 405 1. the item that the message is responding to, | 405 1. a case insentive ``help``, |
| 406 2. the type of item the message should create, or | 406 2. a match for ``-- key <OneTimeKey>``, |
| 407 3. we default the item class and try some trickiness | 407 3. the item that the message is responding to, |
| 408 4. the type of item the message should create, or | |
| 409 5. we default the item class and try some trickiness. | |
| 410 | |
| 411 If the subject is ``help`` (case insensitive), the gateway responds | |
| 412 with an explaination of the interface. | |
| 413 | |
| 414 If a one-time key is found, we're processing an in-progress | |
| 415 registration confirmation. | |
| 408 | 416 |
| 409 If the subject line contains a prefix in ``[square brackets]`` then | 417 If the subject line contains a prefix in ``[square brackets]`` then |
| 410 we're looking at case 1 or 2 above. Any "re:" or "fwd:" prefixes are | 418 we're looking at case 3 or 4 above. Any "re:" or "fwd:" prefixes are |
| 411 stripped off the subject line before we start looking for real | 419 stripped off the subject line before we start looking for real |
| 412 information. | 420 information. |
| 413 | 421 |
| 414 If an item designator (class name and id number, for example | 422 If an item designator (class name and id number, for example |
| 415 ``issue123``) is found there, a new "msg" item is added to the | 423 ``issue123``) is found there, a new "msg" item is added to the |
| 419 If just an item class name is found there, we attempt to create a new | 427 If just an item class name is found there, we attempt to create a new |
| 420 item of that class with its "messages" property initialized to contain | 428 item of that class with its "messages" property initialized to contain |
| 421 the new "msg" item and its "files" property initialized to contain any | 429 the new "msg" item and its "files" property initialized to contain any |
| 422 new "file" items. | 430 new "file" items. |
| 423 | 431 |
| 424 The third case above - where no ``[information]`` is provided, the | 432 The fifth case above - where no ``[information]`` is provided, the |
| 425 tracker's ``MAIL_DEFAULT_CLASS`` configuration variable defines what | 433 tracker's ``MAIL_DEFAULT_CLASS`` configuration variable defines what |
| 426 class of item the message relates to. We try to match the subject line | 434 class of item the message relates to. We try to match the subject line |
| 427 to an existing item of the default class, and if there's a match, the | 435 to an existing item of the default class, and if there's a match, the |
| 428 message is related to that matched item. If not, then a new item of the | 436 message is related to that matched item. If not, then a new item of the |
| 429 default class is created. | 437 default class is created. |