Skip to content
Newer
Older
100644 338 lines (245 sloc) 13.2 KB
9e951b0 @trentm listadmin 2.40 from http://heim.ifi.uio.no/kjetilho/hacks/#listadmin
authored Jun 10, 2010
1 LISTADMIN(1) LISTADMIN(1)
2
3 NAME
4 listadmin - process messages held by Mailman for approval
5
6 SYNOPSIS
7 listadmin [-?] [-V] [-f configfile] [-t minutes] [--mail] [--nomail]
8 [{-a|-r} file] [--add-member address] [--remove-member address] [-l]
9 [listname]
10
11 DESCRIPTION
12 listadmin is a textual alternative to Mailman's WWW interface for
13 administering mailing lists.
14
15 OPTIONS
16 -f configfile
17 Fetch list of mailing lists from configfile rather than the
18 default (~/.listadmin.ini).
19
20 -t minutes
21 Stop processing after minutes has passed. Mostly useful for
22 completely automated configurations of listadmin.
23
24 --mail Addresses added as subscribers will have nomail turned off.
25
26 --nomail
27 Addresses added as subscribers will have nomail turned on.
28
29 -a file
30 Add e-mail addresses listed in file (one address per line) to
31 the subscriber list. The welcome message is suppressed.
32
33 --add-member address
34 Add address to the subscriber list, works as above.
35
36 -r file
37 Remove e-mail addresses listed in file (one address per line)
38 from the subscriber list.
39
40 --remove-member address
41 Remove address from the subscriber list.
42
43 -l Display the subscriber list.
44
45 listname
46 Only process the lists matching listname. Specify a complete
47 address, a substring or a regular expression.
48
49 -? or --help
50 Display short usage description.
51
52 -V or --version
53 Output version number.
54
55 CONFIGURATION SYNTAX
56 The configuration file contains lines which can contain either a
57 comment, a directive, or a mailing list address.
58
59 A line can be continued by putting a backslash character at the end of
60 the line. Any leading whitespace on the following line is removed.
61
62 Comments begin with the character # and extend to the end of line.
63 Backslash continuation is not applied to comments.
64
65 The argument to the directive can be put in double quotes to protect
66 space characters. Inside double quotes, \" can be used to include a
67 literal double quote, and \\ for a literal backslash.
68
69 DIRECTIVES
70 A directive affects all the mailing lists addresses which follow after
71 it in the configuration file. The directives are:
72
73 username username
74 Specifies the username to use for authentication. (Not
75 all Mailman servers require a username.)
76
77 password password
78 Specifies the password to use for authentication.
79
80 adminurl url
81 The URL for maintaining Mailman requests. Some
82 substitutions are performed: (examples below refer to the
83 hypothetical list foo-devel@example.net)
84
85 {list} The local part of the list name, e.g., "foo-
86 devel".
87
88 {domain}
89 The domain part of the list name, e.g.,
90 "example.net".
91
92 {subdomain}
93 The first component of the domain part, e.g.,
94 "example".
95
96 default action
97 Specifies the action to take when the user presses just
98 Return. Available actions are:
99
100 approve
101 The message will be sent to all member of the
102 list.
103
104 reject Notify sender that the message was rejected.
105
106 discard
107 Throw message away, don't notify sender.
108
109 skip Don't decide now, leave it for later.
110
111 none Reset to no default action.
112
113 action action
114 This action will be taken for all messages where none of
115 the other rules apply (e.g., spamlevel, discard_if_from
116 etc.), ie., whenever the user would have been asked what
117 to do. The same actions as for default are available,
118 although reject isn't very useful.
119
120 spamlevel number
121 This specifies the threshold for automatic discard of
122 suspected spam messages. 12 is unlikely to have false
123 positives. No user confirmation is needed, so it is best
124 to play it safe. Less than 5 is not recommended.
125
126 spamheader header-name
127 The name of the header which contains the spam score. It
128 is assumed that the score is encoded as a sequence of
129 characters, like "*****" for the value 5. By default it
130 will look for all headers with names containing "spam"
131 and "score" or "level", and pick the highest score if
132 there is more than one. Setting the header-name to
133 default will restore this behaviour.
134
135 not_spam_if_from pattern
136 If the message's From header matches the pattern, all
137 automatic actions will be cancelled and you will be asked
138 what action to take explicitly. The pattern can use Perl
139 regexp syntax. If enclosed in slashes, some modifiers
140 can be added, a typical example being /pattern/i to match
141 case-insensitively.
142
143 not_spam_if_subject pattern
144 As above, but matches against the Subject header.
145
146 discard_if_from pattern
147 If the message's From header matches the pattern, it will
148 be discarded automatically.
149
150 discard_if_subject pattern
151 As above, but matches against the Subject header.
152
153 discard_if_reason pattern
154 As above, but matches against Mailman's reason for
155 holding the message for approval.
156
157 subscription_default action
158 Specifies the action to take when the user presses just
159 Return while processing subscriptions. Available actions
160 are:
161
162 accept The new subscriber will be added.
163
164 reject Notify sender that s/he was not allowed to join
165 the list.
166
167 skip Don't decide now, leave it for later.
168
169 none Reset to no default action.
170
171 subscription_action action
172 This action will be taken always for all new subscribers
173 in the relevant lists, no user interaction will take
174 place. The same actions as for subscription_default are
175 available, although only skip is very useful. It is
176 better to get automatic accept and reject behaviour by
177 changing the Mailman configuration.
178
179 confirm yes|no
180 Before submitting changes, ask for confirmation. Default
181 is "yes".
182
183 unprintable questionmark|unicode
184 If the subject or sender address contains characters the
185 terminal can't display, they will be replaced by either
186 "<?>" (in questionmark mode, the default) or something
187 like "<U+86a8>" (in unicode mode).
188
189 log filename
190 Changes submitted to the web interface are logged. All
191 the changes for one list are sent in batches at the end
192 of processing. The format in the log is first a line
193 containing the list name and a time stamp in local time.
194 Then one line for each message, in the format
195
196 action D:[date] F:[sender] S:[subject]
197
198 This batch of lines is terminated by a line saying
199 changes sent to server.
200
201 The same substitutions are performed on filename as on
202 the argument to adminurl. Tilde syntax can be used to
203 refer to home directories. The filename none turns off
204 logging.
205
206 meta_member_support yes|no
207 Meta members are an experimental feature at the
208 University of Oslo. This option is enabled by default
209 for lists in uio.no, and is needed to avoid clearing the
210 list of meta members when manipulating the list of
211 ordinary members. Note: Requires additional Perl module
212 WWW::Mechanize
213
214 INTERACTIVE USE
215 The user interface to listadmin is line oriented with single letter
216 commands. By pressing Return, the default action is chosen. The
217 default action is printed in brackets in the prompt. The available
218 actions are:
219
220 a Approve sending the message to all members of the list.
221
222 r Reject the message and notify sender of the decision.
223
224 d Discard the message silently, don't notify sender.
225
226 s Skip the message, leave its status as pending unchanged.
227
228 b View Body, display the first 20 lines of the message.
229
230 f View Full, display the complete message, including
231 headers.
232
233 t View Time, display the Date header from the message.
234
235 number Jump forward or backward to message number.
236
237 u Go back to the previous message and undo the last
238 approve, discard or reject action.
239
240 /pattern
241 Search (case-insensitively) for the next message with
242 matching From or Subject. If pattern is left out, the
243 previous value will be used.
244
245 ?pattern
246 As above, but backwards.
247
248 . Redisplay information about current message.
249
250 add Add address as subscriber to the list. If address is
251 left out, use the sender of the current message.
252
253 nomail As add, but adds address with "nomail" enabled.
254
255 list List subscriber addresses matching pattern, or the full
256 list if no pattern is specified.
257
258 rem Remove address from the subscriber list. Note: there is
259 no undo for this action.
260
261 q Quit processing this list and go on to the next.
262
263 Changes will not take effect until the end of the list has been
264 reached. At that time, the user will be prompted whether the changes
265 should be submitted to Mailman (see also "confirm" directive above).
266
267 EXAMPLES
268 To process only the lists of a single domain, specify the domain as the
269 pattern:
270 listadmin example.com
271
272 To disable the printing of characters outside US-ASCII, set the locale
273 appropriately:
274 env LC_CTYPE=C listadmin
275
276 An example configuration file:
277 # A comment, it must appear on a line by itself.
278 #
279 # Settings affect all lists being listed after it.
280
281 username jdoe@example.com
282 password Geheim
283 default discard
284 # This one works for Sourceforge:
285 adminurl http://{domain}/lists/admindb/{list}
286
287 slartibartfast@lists.sourceforge.net
288
289 # This is how the default Mailman URLs look:
290 adminurl http://{domain}/mailman/admindb/{list}
291
292 # If the password contains quotes or spaces, you may need
293 # to put it in quotes. A complex example:
294 password "\"lise\\ "
295
296 # These lists will still use the username [jdoe], but the
297 # password is now ["lise\ ].
298
299 default approve
300 discard_if_reason "Message has implicit|Too many recipients"
301 discard_if_from ^(postmaster|mailer(-daemon)?|listproc|no-reply)@
302
303 foo-devel@example.net
304
305 # No one should ever send e-mail to the next list, so throw it
306 # all away, without asking any questions
307 action discard
308 confirm no
309 foo-announce@example.net
310
311 ENVIRONMENT
312 http_proxy or HTTP_PROXY
313 Specifies a proxy to use for HTTP.
314
315 https_proxy or HTTPS_PROXY
316 Specifies a proxy to use for HTTPS.
317
318 LC_CTYPE
319 The character set support is deduced from this variable.
320
321 FILES
322 $HOME/.listadmin.ini
323
324 The default configuration file.
325
326 BUGS
327 The HTML parser is quite fragile and depends on Mailman not to change
328 the format of its generated code.
329
330 An extra blank line is sometimes added to the subject when it contains
331 double width characters (e.g. Chinese). This is probably a bug in
332 Text::Reform.
333
334 AUTHOR
335 Kjetil T. Homme <kjetilho+listadmin@ifi.uio.no>
336
337 24 Feb 2005 LISTADMIN(1)
Something went wrong with that request. Please try again.