Import ezmlm-idx 0.40
[ezmlm] / ezmlm-warn.1
1 .TH ezmlm-warn 1
2 .SH NAME
3 ezmlm-warn \- send out bounce warnings
4 .SH SYNOPSIS
5 .B ezmlm-warn
6 [
7 .B \-dD
8 ][
9 .B \-t
10 .I timeout
11 ][
12 .B \-l
13 .I lockout
14 ]
15 .I dir
16 .SH DESCRIPTION
17 .B ezmlm-warn
18 sends out warning messages
19 for the mailing list stored in
20 .IR dir .
21
22 .B ezmlm-warn
23 scans
24 .I dir\fB/bounce/d/
25 for directories older than
26 .I timeout
27 days ago (see
28 .BR \-t ).
29 The directories are created by
30 B ezmlm-return
31 and contain bounces.
32 If
33 .B ezmlm-warn
34 sees a distribution bounce for
35 .I box\fB@\fIdomain
36 received more than
37 .I timeout
38 days ago,
39 it sends
40 .I box\fB@\fIdomain
41 a list of all the message numbers missed recently,
42 and deletes the bounce.
43 If it sees a warning bounce for
44 .I box\fB@\fIdomain
45 received more than
46 .I timeout
47 days ago,
48 it sends
49 .I box\fB@\fIdomain
50 a probe,
51 and deletes the bounce.
52
53 .B ezmlm-warn
54 uses
55 .I dir\fB/bounce/lastd
56 to keep track of when it was last run. If insufficient time has
57 passed (see
58 .BR \-l )
59 .B ezmlm-warn
60 exits without further action.
61
62 .B ezmlm-warn
63 keeps files with the bounced message numbers in
64 .IR dir\fB/bounce/h .
65 Expired files are removed and
66 .I dir\fB/bounce/lasth
67 keeps track of the last subdirectory scanned.
68
69 .B ezmlm-warn
70 will not send a warning or probe to an address that is
71 not currently a subscriber.
72 .SH OPTIONS
73 .TP
74 .B \-d
75 process bounces for the digest list, rather than for the main list.
76 Digest list bounces are stored in
77 .I dir\fB/digest/bounce/
78 rather than in
79 .IR dir\fB/bounce/ .
80 .TP
81 .B \-D
82 (Default.)
83 Process bounces for the main list.
84 .TP
85 .B \-l \fIlockout
86 .B ezmlm-warn
87 will abort execution if it was run less than
88 .I lockout
89 seconds ago. The default is
90 .I timeout /
91 50, which with the default
92 .I timeout
93 is 20,000 seconds (approx. 5.6 hours). There is no reason to use this
94 switch, except for testing and possibly in combination with
95 .BR \-t.
96 .TP
97 .B \-t \fItimeout
98 Bounces received more than
99 .I timeout
100 days ago are processed. This overrides the default of 1,000,000
101 seconds (approximately 10 days)
102 and may possibly be useful for very large busy lists. Also, a
103 .I timeout
104 of zero can be used to send a warning to all addresses for which
105 a bounce has been received and a probe for all addresses for which a
106 warning has bounces.
107 This is useful to rapidly clear
108 out bouncing addresses from a (low quality) address list.
109 .SH "SEE ALSO"
110 ezmlm-make(1),
111 ezmlm-return(1),
112 ezmlm(5)