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