aboutsummaryrefslogtreecommitdiffstats
path: root/listadmin.txt
blob: 7412f1e2247ce726b2dd4cfef3c2f5cf64766eaf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
LISTADMIN(1)		    General Commands Manual		  LISTADMIN(1)



NAME
       listadmin - process messages held by Mailman for approval

SYNOPSIS
       listadmin [-?] [-V] [-f configfile] [-t minutes] [--mail] [--nomail]
       [{-a|-r} file] [--add-member address] [--remove-member address] [-l]
       [listname]

DESCRIPTION
       listadmin is a textual alternative to Mailman's WWW interface for
       administering mailing lists.

OPTIONS
       -f configfile
	      Fetch list of mailing lists from configfile rather than the
	      default (~/.listadmin.ini or ~/.config/listadmin.ini).

       -t minutes
	      Stop processing after minutes has passed.	 Mostly useful for
	      completely automated configurations of listadmin.

       --mail Addresses added as subscribers will have nomail turned off.

       --nomail
	      Addresses added as subscribers will have nomail turned on.

       --dry-run
	      Acts as if the user responded with (S)kip to message handling
	      queries.

       --discard-all
	      Acts as if the user responded with (D)iscard. Dry-run takes
	      precedence.

       -a file
	      Add e-mail addresses listed in file (one address per line) to
	      the subscriber list.  The welcome message is suppressed.

       --add-member address
	      Add address to the subscriber list, works as above.

       -r file
	      Remove e-mail addresses listed in file (one address per line)
	      from the subscriber list.

       --remove-member address
	      Remove address from the subscriber list.

       -l     Display the subscriber list.

       listname
	      Only process the lists matching listname.	 Specify a complete
	      address, a substring or a regular expression.

       -? or --help
	      Display short usage description.

       -V or --version
	      Output version number.

CONFIGURATION SYNTAX
       The configuration file contains lines which can contain either a
       comment, a directive, or a mailing list address.

       A line can be continued by putting a backslash character at the end of
       the line.  Any leading whitespace on the following line is removed.

       Comments begin with the character # and extend to the end of line.
       Backslash continuation is not applied to comments.

       The argument to the directive can be put in double quotes to protect
       space characters.  Inside double quotes, \" can be used to include a
       literal double quote, and \\ for a literal backslash.


DIRECTIVES
       A directive affects all the mailing lists addresses which follow after
       it in the configuration file.  The directives are:

	      username username
		     Specifies the username to use for authentication.	(Not
		     all Mailman servers require a username.)

	      password password
		     Specifies the password to use for authentication.

	      adminurl url
		     The URL for maintaining Mailman requests.	Some
		     substitutions are performed: (examples below refer to the
		     hypothetical list foo-devel@example.net)

		     {list} The local part of the list name, e.g., "foo-
			    devel".

		     {domain}
			    The domain part of the list name, e.g.,
			    "example.net".

		     {subdomain}
			    The first component of the domain part, e.g.,
			    "example".

	      default action
		     Specifies the action to take when the user presses just
		     Return.  Available actions are:

		     approve
			    The message will be sent to all member of the
			    list.

		     reject Notify sender that the message was rejected.

		     discard
			    Throw message away, don't notify sender.

		     skip   Don't decide now, leave it for later.

		     none   Reset to no default action.

	      action action
		     This action will be taken for all messages where none of
		     the other rules apply (e.g., spamlevel, discard_if_from
		     etc.), ie., whenever the user would have been asked what
		     to do.  The same actions as for default are available,
		     although reject isn't very useful.

	      spamlevel number
		     This specifies the threshold for automatic discard of
		     suspected spam messages.  12 is unlikely to have false
		     positives.	 No user confirmation is needed, so it is best
		     to play it safe.  Less than 5 is not recommended.

	      spamheader header-name
		     The name of the header which contains the spam score.  It
		     is assumed that the score is encoded as a sequence of
		     characters, like "*****" for the value 5.	By default it
		     will look for all headers with names containing "spam"
		     and "score" or "level", and pick the highest score if
		     there is more than one. Setting the header-name to
		     default will restore this behaviour.

	      not_spam_if_from pattern
		     If the message's From header matches the pattern, all
		     automatic actions will be cancelled and you will be asked
		     what action to take explicitly.  The pattern can use Perl
		     regexp syntax.  If enclosed in slashes, some modifiers
		     can be added, a typical example being /pattern/i to match
		     case-insensitively.

	      not_spam_if_subject pattern
		     As above, but matches against the Subject header.

	      discard_if_from pattern
		     If the message's From header matches the pattern, it will
		     be discarded automatically.

	      discard_if_subject pattern
		     As above, but matches against the Subject header.

	      discard_if_reason pattern
		     As above, but matches against Mailman's reason for
		     holding the message for approval.

	      approve_if_from pattern
		     If the message's From header matches the pattern, it will
		     be approved automatically.

	      subscription_default action
		     Specifies the action to take when the user presses just
		     Return while processing subscriptions.  Available actions
		     are:

		     accept The new subscriber will be added.

		     reject Notify sender that s/he was not allowed to join
			    the list.

		     skip   Don't decide now, leave it for later.

		     none   Reset to no default action.

	      subscription_action action
		     This action will be taken always for all new subscribers
		     in the relevant lists, no user interaction will take
		     place.  The same actions as for subscription_default are
		     available, although only skip is very useful.  It is
		     better to get automatic accept and reject behaviour by
		     changing the Mailman configuration.

	      confirm yes|no
		     Before submitting changes, ask for confirmation.  Default
		     is "yes".

	      unprintable questionmark|unicode
		     If the subject or sender address contains characters the
		     terminal can't display, they will be replaced by either
		     "<?>" (in questionmark mode, the default) or something
		     like "<U+86a8>" (in unicode mode).

	      log filename
		     Changes submitted to the web interface are logged.	 All
		     the changes for one list are sent in batches at the end
		     of processing.  The format in the log is first a line
		     containing the list name and a time stamp in local time.
		     Then one line for each message, in the format

		     action D:[date] F:[sender] S:[subject]

		     This batch of lines is terminated by a line saying
		     changes sent to server.

		     The same substitutions are performed on filename as on
		     the argument to adminurl.	Tilde syntax can be used to
		     refer to home directories.	 The filename none turns off
		     logging.

	      meta_member_support yes|no
		     Meta members are an experimental feature at the
		     University of Oslo.  This option is enabled by default
		     for lists in uio.no, and is needed to avoid clearing the
		     list of meta members when manipulating the list of
		     ordinary members.	Note: Requires additional Perl module
		     WWW::Mechanize

	      cafile /path/to/CAcertificate
		     Specify which CA certificate to use for all lists
		     following. Setting cafile to NONE will use the default
		     cafile.

	      verify_peer yes|no
		     If set to no SSL certificate verification will be
		     disabled for all lists following.





INTERACTIVE USE
       The user interface to listadmin is line oriented with single letter
       commands.  By pressing Return, the default action is chosen.  The
       default action is printed in brackets in the prompt.  The available
       actions are:


	      a	     Approve sending the message to all members of the list.

	      r	     Reject the message and notify sender of the decision.

	      d	     Discard the message silently, don't notify sender.

	      s	     Skip the message, leave its status as pending unchanged.

	      b	     View Body, display the first 20 lines of the message.

	      f	     View Full, display the complete message, including
		     headers.

	      t	     View Time, display the Date header from the message.

	      number Jump forward or backward to message number.

	      u	     Go back to the previous message and undo the last
		     approve, discard or reject action.

	      /pattern
		     Search (case-insensitively) for the next message with
		     matching From or Subject.	If pattern is left out, the
		     previous value will be used.

	      ?pattern
		     As above, but backwards.

	      .	     Redisplay information about current message.

	      add    Add address as subscriber to the list.  If address is
		     left out, use the sender of the current message.

	      nomail As add, but adds address with "nomail" enabled.

	      list   List subscriber addresses matching pattern, or the full
		     list if no pattern is specified.

	      rem    Remove address from the subscriber list.  Note: there is
		     no undo for this action.

	      q	     Quit processing this list and go on to the next.

       Changes will not take effect until the end of the list has been
       reached.	 At that time, the user will be prompted whether the changes
       should be submitted to Mailman (see also "confirm" directive above).


EXAMPLES
       To process only the lists of a single domain, specify the domain as the
       pattern:
	  listadmin example.com

       To disable the printing of characters outside US-ASCII, set the locale
       appropriately:
	  env LC_CTYPE=C listadmin

       An example configuration file:
	  # A comment, it must appear on a line by itself.
	  #
	  # Settings affect all lists being listed after it.

	  username jdoe@example.com
	  password Geheim
	  default discard
	  # This one works for Sourceforge:
	  adminurl http://{domain}/lists/admindb/{list}

	  slartibartfast@lists.sourceforge.net

	  # This is how the default Mailman URLs look:
	  adminurl http://{domain}/mailman/admindb/{list}

	  # If the password contains quotes or spaces, you may need
	  # to put it in quotes.  A complex example:
	  password "\"lise\\ "

	  # These lists will still use the username [jdoe], but the
	  # password is now ["lise\ ].

	  default approve
	  discard_if_reason "Message has implicit|Too many recipients"
	  discard_if_from ^(postmaster|mailer(-daemon)?|listproc|no-reply)@

	  # These senders are automatically approved
	  approve_if_from "good-sender@example.com|another-one@example.net"

	  foo-devel@example.net

	  # No one should ever send e-mail to the next list, so throw it
	  # all away, without asking any questions
	  action discard
	  confirm no
	  foo-announce@example.net


ENVIRONMENT
       http_proxy or HTTP_PROXY
	      Specifies a proxy to use for HTTP.

       https_proxy or HTTPS_PROXY
	      Specifies a proxy to use for HTTPS.

       LC_CTYPE
	      The character set support is deduced from this variable.


FILES
       $HOME/.listadmin.ini
       $HOME/.config/listadmin.ini

       The default configuration file.


BUGS
       The HTML parser is quite fragile and depends on Mailman not to change
       the format of its generated code.

       An extra blank line is sometimes added to the subject when it contains
       double width characters (e.g. Chinese).	This is probably a bug in
       Text::Reform.

AUTHOR
       Kjetil T. Homme <kjetilho+listadmin@ifi.uio.no>
       Project manager: Johnny A. Solbu <johnny@solbu.net>



				  2018-08-08			  LISTADMIN(1)