Mercurial > p > roundup > code

annotate share/man/man1/roundup-mailgw.1 @ 5973:fe334430ca07

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
issue2550919 - Anti-bot signup using 4 second delay Took the code by erik forsberg and massaged it into the core. So this is no longer needed in the tracker. Updated devel and responsive trackers to remove timestamp.py and update input field name. Docs, changes and tests complete. Hopefully these tracker changes won't cause an issue for other tests.
author John Rouillard <rouilj@ieee.org>
date Sat, 09 Nov 2019 00:30:37 -0500
parents 76e270b35e63
children f0d39308819f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
1 .TH ROUNDUP-MAILGW 1 "07 October 2019"
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
2 .SH NAME
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
3 roundup-mailgw \- mail gateway for roundup
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
4 .SH SYNOPSIS
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
5 \fBroundup-mailgw\fP [\fI-v\fP] [\fI-c\fP \fIdefault_class\fP]
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
6 [[\fI-C\fP \fIclass\fP] \fI-S\fP \fIfield=value\fP]
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
7 [\fIinstance_home\fP] [\fImail source [specification]\fP]
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
8 .SH OPTIONS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
9 .TP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
10 \fB-v\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
11 Print version and exit.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
12 .TP
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
13 \fB-c\fP \fIhyperdb class\fP
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
14 specify the default tracker class - one of issue (the default), msg, file, user etc. Overrides the
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
15 tracker's mailgw default_class setting.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
16 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
17 \fB-C\fP \fIhyperdb class\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
18 specify a tracker class - one of msg (the default), issue, file, user - to
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
19 manipulate with -S options
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
20 .TP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
21 \fB-S\fP \fIproperty\fP\fB=\fP\fIvalue\fP[\fB;\fP\fIproperty\fP\fB=\fP\fIvalue\fP] \fIpairs\fP
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
22 specify the values to set on the class specified by \fB-C\fP using the same
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
23 format as the Subject line property manipulations. Can also be
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
24 specified with \fB--set\fP.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
25 .SH DESCRIPTION
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
26 The roundup mail gateway may be called in one of four ways:
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
27 .IP \(bu
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
28 without arguments which will use the env var ROUNDUP_INSTANCE,
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
29 .IP \(bu
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
30 with an instance_home as the only argument,
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
31 .IP \(bu
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
32 with both an instance_home and a mail spool file, or
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
33 .IP \(bu
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
34 with both an instance home and a mail source type and its specification.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
35 .PP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
36 \fBPIPE\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
37 .br
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
38 In the first and second cases, the mail gateway reads a single message from the
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
39 standard input and submits the message to the roundup.mailgw module.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
40
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
41 \fBUNIX mailbox\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
42 .br
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
43 In the second case, the gateway reads all messages from the mail spool
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
44 file and submits each in turn to the roundup.mailgw module. The file is
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
45 emptied once all messages have been successfully handled. The file is
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
46 specified as:
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
47 \fImailbox /path/to/mailbox\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
48
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
49 In all of the following the username and password can be stored in a
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
50 ~/.netrc file. In this case only the server name need be specified on
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
51 the command-line.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
52
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
53 The username and/or password will be prompted for if not supplied on
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
54 the command-line or in ~/.netrc.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
55
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
56 \fBPOP\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
57 .br
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
58 In the third case, the gateway reads all messages from the POP server
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
59 specified and submits each in turn to the roundup.mailgw module. The
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
60 server is specified as:
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
61 \fBpop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
62 .br
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
63 The username and password may be omitted:
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
64 \fBpop\fP \fIusername\fP\fB@\fP\fIserver\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
65 \fBpop\fP \fIserver\fP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
66 .br
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
67 are both valid.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
68
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
69 \fBPOPS\fP
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
70 .br
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
71 Connect to the POP server over ssl/tls. This requires python 2.4 or
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
72 later. This supports the same notation as POP.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
73
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
74
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
75 \fBpops\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
76 .br
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
77 etc.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
78
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
79 \fBAPOP\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
80 .br
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
81 Same as POP, but using Authenticated POP:
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
82 \fBapop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
83
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
84 \fBIMAP\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
85 .br
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
86 Connect to an IMAP server. This supports the same notation as that of
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
87 POP mail.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
88 \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
89 .br
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
90 It also allows you to specify a specific mailbox other than INBOX using
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
91 this format:
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
92 \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver mailbox\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
93
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
94 \fBIMAPS\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
95 .br
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
96 Connect to an IMAP server over ssl/tls.
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
97 This supports the same notation as IMAP.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
98 \fBimaps\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP [\fImailbox\fP]
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
99
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
100
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
101 \fBIMAPS_CRAM\fP
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
102 .br
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
103 Connect to an IMAP server over ssl/tls using CRAM-MD5 authentication.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
104 This supports the same notation as IMAP.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
105 \fBimaps_cram\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP [\fImailbox\fP]
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
106
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
107 .SH ENVIRONMENT VARIABLES
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
108
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
109 \fBROUNDUP_INSTANCE\fP
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
110 .br
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
111 This can be used to set the instance directory. If it is set, the
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
112 \fIinstance_home\fP argument is optional.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
113
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
114 .SH EXAMPLE
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
115 If your msg class has a messsagetype property you can set
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
116 up aliases to receive the different types of messages. Setting up
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
117 an alias in your MTA Using:
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
118
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
119 tracker: |/tools/roundup/bin/roundup-mailgw -C msg
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
120 -S "messagetype=reply - to all" /var/roundup/sysadmin
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
121
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
122 (the lines are split for readability. In the alias file they will be
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
123 on the same line). Replace /tools/roundup/bin/roundup-mailgw by your
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
124 path to the roundup-mailgw. This creates the email alias "tracker". All
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
125 messages sent to it have their messagetype property set to "reply -
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
126 to all". The roundup tracker instance is located at
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
127 /var/roundup/sysadmin.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
128
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
129 A comment alias would receive emails at tracker_comment with:
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
130
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
131 tracker_comment: |/tools/roundup/bin/roundup-mailgw -C msg
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
132 -S "messagetype=comment - to technical" /var/roundup/sysadmin
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
133
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
134 which would be a technical message. These messages can trigger
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
135 different workflows based on the messagetype.
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
136
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
137 Both examples use the default class specified in the tracker's
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
138 config.ini (usually the issue class).
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
139
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
140 .SH AUTHOR
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
141 This manpage was written by Bastian Kleineidam
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
142 <calvin@debian.org> for the Debian distribution of roundup.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
143
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
144 The main author of roundup is Richard Jones
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
145 <richard@users.sourceforge.net>.
5905
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
146
76e270b35e63 issue2550885: Documentation: update the roundup-mailgw manpage
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
147 Updates by John Rouillard <rouilj@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/