Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 1359:ebfd8dd1cce7
missed this part of the patch, added doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sun, 12 Jan 2003 00:03:11 +0000 |
| parents | 28ae91aae74f |
| children | 8ee69708da0c |
comparison
equal
deleted
inserted
replaced
| 1358:e0bf31867fa5 | 1359:ebfd8dd1cce7 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.12 $ | 5 :Version: $Revision: 1.13 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 Note: this document will refer to *issues* as the primary store of information | 9 Note: this document will refer to *issues* as the primary store of information |
| 10 in the tracker. This is the default of the classic template, bubt may vary in | 10 in the tracker. This is the default of the classic template, bubt may vary in |
| 298 provides a log of when the message was sent to whom. | 298 provides a log of when the message was sent to whom. |
| 299 | 299 |
| 300 If the author of the message is also in the nosy list for the item that the | 300 If the author of the message is also in the nosy list for the item that the |
| 301 message is attached to, then the config var ``MESSAGES_TO_AUTHOR`` is queried | 301 message is attached to, then the config var ``MESSAGES_TO_AUTHOR`` is queried |
| 302 to determine if they get a nosy list copy of the message too. | 302 to determine if they get a nosy list copy of the message too. |
| 303 | |
| 304 | |
| 305 Mail gateway script command line | |
| 306 -------------------------------- | |
| 307 | |
| 308 The roundup mail gateway may be called in one of three ways: | |
| 309 | |
| 310 . with an instance home as the only argument, | |
| 311 . with both an instance home and a mail spool file, or | |
| 312 . with both an instance home and a pop server account. | |
| 313 | |
| 314 It also supports optional -C and -S arguments that allows you to set a | |
| 315 fields for a class created by the roundup-mailgw. The default class if | |
| 316 not specified is msg, but the other classes: issue, file, user can | |
| 317 also be used. The -S or --set options uses the same | |
| 318 property=value[;property=value] notation accepted by the command line | |
| 319 roundup command or the commands that can be given on the Subject line | |
| 320 of an email message. | |
| 321 | |
| 322 It can let you set the type of the message on a per email address basis. | |
| 323 | |
| 324 PIPE: | |
| 325 In the first case, the mail gateway reads a single message from the | |
| 326 standard input and submits the message to the roundup.mailgw module. | |
| 327 | |
| 328 UNIX mailbox: | |
| 329 In the second case, the gateway reads all messages from the mail spool | |
| 330 file and submits each in turn to the roundup.mailgw module. The file is | |
| 331 emptied once all messages have been successfully handled. The file is | |
| 332 specified as:: | |
| 333 | |
| 334 mailbox /path/to/mailbox | |
| 335 | |
| 336 POP: | |
| 337 In the third case, the gateway reads all messages from the POP server | |
| 338 specified and submits each in turn to the roundup.mailgw module. The | |
| 339 server is specified as:: | |
| 340 pop username:password@server | |
| 341 | |
| 342 The username and password may be omitted:: | |
| 343 pop username@server | |
| 344 pop server | |
| 345 | |
| 346 are both valid. The username and/or password will be prompted for if | |
| 347 not supplied on the command-line. | |
| 303 | 348 |
| 304 | 349 |
| 305 Command Line Tool | 350 Command Line Tool |
| 306 ================= | 351 ================= |
| 307 | 352 |