3 ezmlm-get \- handles mailing list archive retrieval and digests
20 Copy administrative information and the request to the bottom of replies.
21 This informs the recipient of other commands, and allows some error tracking
22 in case the recipient did not originate the request.
25 Suppress the normal administrative information and request copy. This may make
26 it harder for the recipient to diagnose problems and learn commands.
30 Process and reply to commands (does not affect digests).
33 Ignore all commands except digest.
39 as the default format for all returned message collections. The default
40 is 'm' for MIME with a header subset (see below). Format specifiers
41 send with individual requests override the default set with the
46 \-get, \-index, and \-thread commands are available to all users,
47 provided other flags are permissive. This overrides normal behavior,
48 which is to allow archive retrieval only to moderators, when
50 does not exist. This is useful to set up non-public lists that still give
54 \-get, \-index, and \-thread commands are available
55 only to moderators, even if
61 flags can restrict this further. This is useful for public lists with
62 archive retrieval restricted to a subset of users (moderators).
65 \-get, \-index, and \-thread requests are processed only if
71 Anyone can issue \-get, \-index, and \-thread requests.
80 handles archive retrieval and optionally makes and sends out
81 digests for the mailing list
84 Subscribers of the digest list are stored in
85 .IR dir\fB/digest/subscribers/ .
89 are added to the header of outgoing messages.
92 is normally invoked from a
96 It reads a mail message from its standard input,
97 and a mail envelope from the
102 environment variables.
107 to determine where it is invoked. If
109 is the list local name only,
111 assumes it is run from
114 The digest is sent directly to the digest list subscribers.
118 is empty or undefined,
120 assumes it is run from the command line or a script. In this case
121 it behaves as if run from
123 and sends out a digest to the digest subscribers.
130 .IR list\fB-\fIaction .
138 The output is sent to the envelope sender.
144 .BR dig\.\fIdigestcode ,
153 handles the request and sends a reply. If successful, it
154 exits 99 (ignore remaining
161 exits 0 (success) to pass the message on to later handlers,
163 .BR ezmlm-manage(1) .
168 to match the first line of
171 .BR ezmlm-dig\.\fIdigestcode
172 returns a digest of messages received since the last digest, unless
173 numerical arguments are given.
175 must be alphanumeric, and match (case-insensitive)
179 command line. Otherwise, the request will be ignored. This is to restrict
180 digest creation. The body of the requesting message up to the first line
181 starting with '-' is copied into the
183 section of the digest. This is followed by the contents of
184 .IR dir\fB/text/digest ,
188 Anyone who can read your
190 file, digest-requesting scripts, or mail log knows the
192 and can trigger digests.
196 .I dir\fB/mailinglist
199 field in its response.
200 If the incoming message has a
206 also refuses to respond to bounce messages.
212 will assume that the format is correct and
213 create a ``List-ID:'' header by placing the contents after the
217 .I dir\fB/qmqpservers
219 .B ezmlm-get will use
221 to send digests. Other messages are sent by the normal qmail mechanism.
227 rejects all archive retrieval attempts, unless the
229 command line switch is used.
231 Archive retrieval actions can be of the form
235 .BR action[f].\fInum_num2 ,
238 is the message number for the action or
240 the range of message numbers for the action.
243 is an optional format specifier for
248 requests. It is allowed, but ignored for
250 requests. Currently, the following are allowed:
254 rfc1153. This is a ``plain'' non-MIME format for dumb clients.
259 with a subset of ordered headers sorted.
260 Currently, the following headers are
261 included in the order listed:
271 This can be customized with the optional file
272 .IR dir\fB/digheaders ,
273 which should contain the desired headers up to but not including the colon.
275 The format is no longer compliant
276 with rfc1153, as the rfc1153 format is incompatible with rfc2046, which
277 which the format is (should be) compatible.
280 MIXED: This is the same as the default MIME
281 format, except that the Content-Type is
282 .IR multipart/mixed .
283 This helps circumnavigate a Pine bug: when the digest is
284 content-transfer-encoded, Pine will refuse to display the initial
287 message, but display the same part of a
289 message. Some MUAs for some strange reason treat the two multipart formats
290 differently. In some cases, ``x'' works better than ``m''.
295 with messages returned without any header filtering.
298 NATIVE: This is VIRGIN format without threading, i.e. messages are
299 presented in numerical order and the message index is suppressed.
302 For flexibility and backwards compatibility, the '.' separating the action from
303 the first argument can be replaced by '\-',
305 Any non-alphanumeric character can separate
316 returns a digest of the messages received since the last digest, and updates
317 the digest issue counter.
324 sends back message(s)
331 .IR dir\fB/archive/ .
336 does not exist or is 0, the latest HISTGET message (default 30) are
338 the messages since the latest digest are returned including the last
339 message in that digest, so that always at least 1 message is send. If the
341 exceeds MAXGET (default 100), only the MAXGET last messages are returned.
344 is greater than the latest message in the archive _and_
346 is specified, the latest messages back to HISTGET before the end of the
347 latest digest up to MAXGET messages are returned. This is a good way of
348 always getting at least the latest 30 messages without knowing the latest
349 message number. A link with such a command could be put into e.g.
350 .IR dir\fB/text/sub-ok .
355 are adjusted to make both > 0, and
359 If either is greater than
360 the largest message number processed, it is silently
361 set to the largest message number.
362 At most 100 messages are
370 sends back the subjects and authors of the message(s)
377 .IR dir\fB/archive/ .
381 are reasonable adjusted as for 'get'. No warnings are
382 sent. At most 20 sets of 100 message entries are returned per request. If
386 returns the last 100-200 message entries, which automatically gives
387 information about the last message number.
394 sends back the message(s) that have an index subject entry identical to
398 .IR dir\fB/archive/ .
402 is given it is ignored. If
404 is out of range, and error
405 message is returned. The message range scanned for the subject is limited
406 to 2000 messages before and after the master message, i.e. the
409 This limit protects very large archives.
410 Most threads are expected to be considerably more short-lived.
411 In the unlikely event that there are further messages,
412 these can be retrieved by a second request for the
413 highest/lowest message returned in the first request.
419 will use the character set listed for all messages. Otherwise, the
420 default ``us-ascii'' will be used. The character set can be suffixed
421 by ``:'' followed by a code. If the code is ``Q'', outgoing messages are
422 sent as ``Quoted-Printable'', if it is ``B'' they are sent ``base64'' encoded.
423 Otherwise, text is sent as is.
427 The last message included in the latest normal mode digest.
430 The issue number of the latest normal mode digest.
432 .I dir\fB/text/get-bad
433 Returned if a/the message cannot be found.
435 .I dir\fB/text/digest
438 section of digests after the body of the requesting message.
441 The character set used for all
443 messages (see above).
444 If not present, the default, ``us-ascii'', is used without encoding.
446 The digest format per rfc2046
447 should (but is not required to) be multipart/mixed
448 with the table-of-contents a text/plain part, and the entire remainder of
449 the digest a multipart/digest part. The multipart/digest in turn should
450 contain all the messages. Many
451 MUA's fail to split out the individual messages from such a hierarchy, so the
454 is a simple multipart/digest, explicitly typing the table-of-contents
455 to text/plain, with the ``x'' format changing the mail content-type to
~mdw / ezmlm / blob