Import ezmlm-idx 0.40
[ezmlm] / ezmlm-reject.1
1 .TH ezmlm-reject 1
2 .SH NAME
3 ezmlm-reject \- reject messages unsuitable for distribution
4 .SH SYNOPSIS
5 .B ezmlm-reject
6 [
7 .B \-bBcChHqQsStT
8 ][
9 .I dir
10 ]
11 .SH DESCRIPTION
12 .B ezmlm-reject
13 reads a mail message from its standard input.
14 It rejects the message if it sees something it doesn't like.
15
16 If the message has a ``Precedence: junk'' header,
17 .B ezmlm-reject
18 exits 99 causing the message to be ignored. This causes replies from (some)
19 vacation programs to be ignored.
20
21 If
22 .I dir
23 is specified,
24 .B ezmlm-reject
25 reads
26 .I dir\fB/msgsize
27 for a maximum:minimum message body size in bytes. Either number will be ignored
28 if 0 or omitted.
29 .B ezmlm-reject
30 will also look for
31 .I dir\fB/mimereject
32 and
33 .IR dir\fB/mimeremove .
34 if
35 .IR dir\fB/mimereject
36 exists,
37 Messages of the Content-Types specified or with MIME parts of these
38 types will be rejected.
39 If
40 .I dir\fB/mimeremove
41 exists,
42 .B ezmlm-reject
43 will reject messages of the Content-Types specified. These content-types will
44 be accepted as parts of a composite MIME message. They will be
45 stripped out later by
46 .BR ezmlm-send(1) .
47
48 .B ezmlm-reject
49 will exit 100 (permanent error) for rejections. If the list address is not in
50 the message ``To:'' or ``Cc:'' headers and the
51 .B \-t
52 switch is active, the exit code is 100 or 99, depending on the
53 .B \-q
54 switch (see below).
55 If you would like to forward messages instead of rejecting them, you can
56 into the appropriate .qmail file put:
57
58 .EX
59 |condredirect newaddress except /path/ezmlm-reject DIR
60 .EE
61
62 Now rejected posts will
63 go to this address, and the recipient can take appropriate action.
64 .SH OPTIONS
65 .TP
66 .B \-b
67 Reject the message if the message body starts ``subscribe''
68 or ``unsubscribe''. If the
69 .B \-c
70 switch is specified, messages will also be rejected if the subject starts
71 with these words.
72 .B \-B
73 (Default.)
74 Do not reject messages starting ``subscribe'' or ``unsubscribe''.
75 .TP
76 .B \-c
77 (Default.)
78 Commands are not permitted in the Subject line.
79 A Subject line consisting solely of HELP, REMOVE, SUBSCRIBE, or UNSUBSCRIBE
80 is rejected.
81 .TP
82 .B \-C
83 Commands are permitted in the subject line.
84 .TP
85 .B \-h
86 Reject message if any of the headers in
87 .I dir\fB/headerreject
88 occur in the header. Mailing-List headers of other mailing list managers
89 can be put into this file, one per line, to prevent processing of messages
90 from other mailing lists.
91 .I dir
92 must be specified.
93
94 A reasonable set of headers would be: ``Mailing-List'', ``X-ml-name'',
95 \``ml-name'',``X-loop'',``X-listprocessor-version'',``X-mailing-list''. Case
96 is not important.
97 .TP
98 .B \-H
99 (Default.)
100 Ignore
101 .IR dir\fB/headerreject .
102 .B \-q
103 Quiet. If the message due to the lack of the list address (see
104 .BR \-t )
105 is not accepted, this is logged but no error message is sent to the sender.
106 .TP
107 .B \-q
108 Quiet. If a message due to the lack of the list address (see
109 .BR \-t )
110 is not accepted,
111 the message is silently ignored.
112 .TP
113 .B \-Q
114 (Default.)
115 Not quiet. If a message due to the lack of the list address (see
116 .BR \-t )
117 is not accepted,
118 the sender is notified by an error message.
119 .TP
120 .B \-s
121 (Default.)
122 A nonempty Subject line is required.
123 .TP
124 .B \-S
125 A Subject line is not required.
126 .TP
127 .B \-t
128 (Default.)
129 Reject messages that do not have the list address in the ``To:'' or ``Cc:''
130 header(s).
131 .B ezmlm-reject
132 needs access to
133 .I dir\fB/outhost
134 and
135 .I dir\fB/outlocal
136 to check this. This check is silently omitted if
137 .I dir
138 is not specified, to assure backwards compatibility with existing ezmlm lists.
139 .TP
140 .B \-T
141 Do not require the list address in the ``To:'' or ``Cc:'' header(s).
142 .SH BUGS
143 .B ezmlm-reject
144 does not handle rfc822 comments in ``Content-Type:'' lines if present
145 before the type or boundary.
146 This could be used to defeat the
147 MIME rejection function.
148 OTOH, this function is intended to reduce garbage, not guarantee
149 its elimination.
150 .SH "SEE ALSO"
151 ezmlm-send(1),
152 qmail-command(8)