Import ezmlm-idx 0.40
[ezmlm] / ezmlm-receipt.1
1 .TH ezmlm-receipt 1
2 .SH NAME
3 ezmlm-receipt \- handle sublist replies at the main list
4 .SH SYNOPSIS
5 .B ezmlm-receipt
6 [
7 .B \-dD
8 ]
9 .I dir
10 .SH DESCRIPTION
11 .B ezmlm-receipt
12 handles mail from sublists of the main list
13 stored in
14 .I dir
15 and, if it exists, the associated main digest list.
16 .B ezmlm-receipt
17 is used for main list with only sublists as subscribers. It is not
18 useful for normal mailing lists.
19
20 .B ezmlm-receipt
21 is normally invoked from a
22 .B .qmail
23 file.
24 It reads a mail message from its standard input,
25 and a mail envelope from the
26 .BR SENDER ,
27 .BR LOCAL ,
28 and
29 .BR HOST
30 environment variables.
31
32 .B ezmlm-receipt
33 has two functions. It takes the place of
34 .B ezmlm-receipt(1)
35 for main lists that have only sublists as subscribers.
36 Bounces do not lead to removal of the bouncing
37 address.
38 .B emzlm-receipt
39 saves the
40 bounce, and logs the event to the mail log.
41 .B ezmlm-receipt
42 also saves the bounce to
43 .I dir\fB/bounce/dnnn.ppp
44 where
45 .B nnn
46 is a time stamp and
47 .B ppp
48 the PID of the process. A maximum of 50 bounces are saved. Further bounces
49 are discarded until room is made in the bounce directory by manually removing
50 files.
51 If the list uses and SQL
52 database, the even is logged to the _mlog table instead, and only if the
53 distribution cookie matches. The bounce is still saved, but only if it
54 contained a matching distribution cookie.
55
56 .B ezmlm-receipt
57 also handles feedback messages from the sublist. These are used to monitor
58 that the sublist is able to send out messages. Receipt of feedback messages
59 is logged to the mail log.
60 If the list uses and SQL
61 database, the even is logged to the _mlog table instead, and only if the
62 distribution cookie matches.
63 .SH OPTIONS
64 .TP
65 .B \-d
66 .B ezmlm-receipt
67 will assume the message is for a digest list.
68 Normally,
69 .B ezmlm-receipt
70 will autodetect this from the bounce address. Autodetection makes
71 .B ezmlm-receipt
72 less flexible and will be removed in future versions.
73 .TP
74 .B \-D
75 .B ezmlm-receipt
76 will assume that the bounce is for a normal (non-digest) list.
77 Normally,
78 .B ezmlm-receipt
79 will autodetect this from the bounce address. Autodetection makes
80 .B ezmlm-receipt
81 less flexible and will be removed in future versions.
82 .B \-D
83 will become the default.
84 .SH ADDRESSES
85 .B ezmlm-receipt
86 handles mail sent to any of the following addresses:
87 .TP
88 .I local\fB\-return\-
89 Trash.
90 A help message or subscription acknowledgment bounced.
91 .TP
92 .I local\fB\-return\-\fImsg\fB\-\fIbox\fB=\fIdomain
93 Distribution bounce.
94 Message number
95 .I msg
96 was lost on the way to the sublist
97 .IR box\fB@\fIdomain .
98 .TP
99 .I local\fB\-return\-\fImsg\fB\-
100 Pre-VERP distribution bounce, in QSBMF format.
101 Message number
102 .I msg
103 was lost on the way to one or more sublists;
104 .B ezmlm-receipt
105 will parse the bounce to figure out the addresses.
106 .TP
107 .I local\fB\-return\-receipt
108 Feedback message from a sublist.
109 .B ezmlm-receipt
110 will figure out message number and sublist address from the envelope sender.
111
112 For all the above addresses if,
113 .I local
114 is followed by
115 .IR \-digest ,
116 messages are assumed to relate to the digest list, and are stored in
117 .I dir\fB/digest/bounce
118 rather than in
119 .I dir \fB/bounce .
120 .SH "SEE ALSO"
121 ezmlm-manage(1),
122 ezmlm-make(1),
123 ezmlm-return(1),
124 ezmlm-send(1),
125 ezmlm-sub(1),
126 ezmlm-unsub(1),
127 ezmlm-weed(1),
128 ezmlm(5),
129 qmail-command(8)