Debianization and various other fixes.
[ezmlm] / ezmlm-return.1
... / ...
CommitLineData
1.TH ezmlm-return 1
2.SH NAME
3ezmlm-return \- handle mailing list bounces
4.SH SYNOPSIS
5.B ezmlm-return
6[
7.B \-dD
8]
9.I dir
10.SH DESCRIPTION
11.B ezmlm-return
12handles bounces for the mailing list
13stored in
14.I dir
15and, if it exists, the associated digest list.
16
17.B ezmlm-return
18is normally invoked from a
19.B .qmail
20file.
21It reads a mail message from its standard input,
22and a mail envelope from the
23.BR SENDER ,
24.BR LOCAL ,
25and
26.BR HOST
27environment variables.
28
29.B ezmlm-return
30exits 99, not 0, upon success.
31.SH OPTIONS
32.TP
33.B \-d
34.B ezmlm-return
35will assume the bounce is for a digest list.
36Normally,
37.B ezmlm-return
38will autodetect this from the bounce address. Autodetection makes
39.B ezmlm-return
40less flexible and will be removed in future versions.
41.TP
42.B \-D
43.B ezmlm-return
44will assume that the bounce is for a normal (non-digest) list.
45Normally,
46.B ezmlm-return
47will autodetect this from the bounce address. Autodetection makes
48.B ezmlm-return
49less flexible and will be removed in future versions.
50.B \-D
51will become the default.
52.SH ADDRESSES
53.B ezmlm-return
54handles mail sent to any of the following addresses:
55.TP
56.I local\fB\-return\-
57Trash.
58A help message or subscription acknowledgment bounced.
59.TP
60.I local\fB\-return\-\fImsg\fB\-\fIbox\fB=\fIdomain
61Distribution bounce.
62Message number
63.I msg
64was lost on the way to
65.IR box\fB@\fIdomain .
66.TP
67.I local\fB\-return\-\fImsg\fB\-
68Pre-VERP distribution bounce, in QSBMF format.
69Message number
70.I msg
71was lost on the way to one or more addresses;
72.B ezmlm-return
73will parse the bounce to figure out the addresses.
74.TP
75.I local\fB\-return\-warn\-\fIcookie\fB-\fIbox\fB=\fIdomain
76Warning bounce.
77A warning message from
78.B ezmlm-warn
79bounced.
80.TP
81.I local\fB\-return\-probe\-\fIcookie\fB-\fIbox\fB=\fIdomain
82Probe bounce.
83A probe from
84.B ezmlm-warn
85bounced.
86.B ezmlm-return
87will remove
88.I box\fB@\fIdomain
89from the mailing list.
90.TP
91.I local\fB\-return\-receipt\-\fIcookie\-fImsg\-
92A receipt from the list. This is logged. For SQL supporting lists,
93.I cookie
94is verified and receipt logged only if the cookie is correct. The arrival
95of the receipt shows that qmail at the sending host is running.
96
97For all the above addresses if,
98.I local
99is followed by
100.IR \-digest ,
101bounces are assumed to be from the digest list, and are stored in
102.I dir\fB/digest/bounce
103rather than in
104.I dir \fB/bounce .
105.SH "SEE ALSO"
106ezmlm-manage(1),
107ezmlm-make(1),
108ezmlm-send(1),
109ezmlm-sub(1),
110ezmlm-unsub(1),
111ezmlm-warn(1),
112ezmlm-weed(1),
113ezmlm(5),
114qmail-command(8)