Import ezmlm-idx 0.40
[ezmlm] / ezmlm-limit.1
1 .TH ezmlm-limit 1
2 .SH NAME
3 ezmlm-limit \- Limits traffic to list
4 .SH SYNOPSIS
5 .B ezmlm-limit
6 [
7 .B -f\fI file
8 ][
9 .B -dDF
10 ][
11 .B \-t
12 .I secs
13 ][
14 .B -n
15 .I msgs
16 ]
17 .I dir
18
19 .B ezmlm-limit
20 is intended to limit traffic to a list in case an outside
21 source sends excessive messages. Traffic is limited by converting the list
22 to a message moderated list, or by deferring messages.
23
24 .B ezmlm-limit
25 reads
26 .IR dir\fB/loopnum .
27 If it does not exist or contains a time stamp more than
28 .I secs
29 seconds old, it is updated.
30 If it exists, contains a time stamp less than
31 .I secs
32 seconds old, and
33 .I msgs
34 messages or more have passed since
35 .I dir\fB/loopnum
36 was created,
37 .B ezmlm-limit
38 creates
39 .IR dir\fB/modpost .
40 For lists set up with
41 .B ezmlm-store(1)
42 this results in future messages being moderated.
43
44 As long as
45 .I dir\fB/modpost
46 does not exist,
47 .B ezmlm-store(1)
48 will simply forward the message to
49 .BR ezmlm-send(1).
50 Once
51 .I dir\fB/modpost
52 exists, messages will be queued for moderation. Thus, in case of error (such
53 as misconfigured auto responders) subscribers are spared
54 messages in excess of the limit. However, no messages are lost, since the
55 moderator(s) can (selectively) approve queued messages.
56
57 If
58 .I dir\fB/modpost
59 already exists,
60 .B ezmlm-limit
61 will not take any action.
62
63 Resetting the list requires manual
64 removal of
65 .IR dir\fB/modpost . Queued messages can be managed with regular moderation
66 or approved in bulk with
67 .BR ezmlm-accept(1) .
68
69 .B ezmlm-limit
70 is not required for normal lists, since qmail and
71 ezmlm loop detection prevent problems caused by regular bounces. However,
72 it affords some protection against malice, and severely misconfigured
73 subscribers.
74
75 .SH OPTIONS
76 .TP
77 .B \-d
78 Defer excess traffic. Excess messages are deferred and qmail will re-deliver. As
79 a consequence, traffic will be throttled to the maximum allowed. Due to qmail
80 delivery back-off, messages may not be disseminated in the order received. If
81 traffic is continuously above or close to the limit, some messages may be
82 delayed for a long time or even bounced.
83 .TP
84 .B \-D
85 (Default.)
86 Make the list moderated once excess traffic is detected. This requires the
87 list to be configured up with
88 .B ezmlm-store(1)
89 rather than
90 .BR ezmlm-send(1) ,
91 which is easiest done by first creating a message moderated list, then removing
92 .IR dir\fB/modpost .
93 .TP
94 .B \-n\fI msgs
95 Trigger after
96 .I msgs
97 messages (default 30).
98 .TP
99 .B \-f\fI file
100 Instead of
101 .I dir\fB/loopnum
102 use
103 .I file
104 as the time stamp. This allows the use of multiple instances of
105 .B ezmlm-limit
106 for the same list. For instance, you may allow 60 messages per hour with one
107 instance and 150 messages per day with another. If
108 .I file
109 is relative, this is relative to
110 .IR dir .
111 .TP
112 .B \-F
113 (Default.)
114 Use
115 .I dir\fB/loopnum
116 as the time stamp.
117 .TP
118 .B \-t\fI secs
119 Check the number of messages within period of
120 .I secs
121 seconds (default 3600 seconds).
122 .SH "SEE ALSO"
123 ezmlm-accept(1),
124 ezmlm-make(1),
125 ezmlm-send(1),
126 ezmlm-store(1),
127 ezmlm(5)