| 1 |
'\" t |
| 2 |
.\"<!-- Copyright 1998 - 2009 Double Precision, Inc. See COPYING for --> |
| 3 |
.\"<!-- distribution information. --> |
| 4 |
.\" Title: maildrop |
| 5 |
.\" Author: Sam Varshavchik |
| 6 |
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> |
| 7 |
.\" Date: 07/13/2024 |
| 8 |
.\" Manual: Double Precision, Inc. |
| 9 |
.\" Source: Courier Mail Server |
| 10 |
.\" Language: English |
| 11 |
.\" |
| 12 |
.TH "MAILDROP" "1" "07/13/2024" "Courier Mail Server" "Double Precision, Inc\&." |
| 13 |
.\" ----------------------------------------------------------------- |
| 14 |
.\" * Define some portability stuff |
| 15 |
.\" ----------------------------------------------------------------- |
| 16 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 17 |
.\" http://bugs.debian.org/507673 |
| 18 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 19 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 20 |
.ie \n(.g .ds Aq \(aq |
| 21 |
.el .ds Aq ' |
| 22 |
.\" ----------------------------------------------------------------- |
| 23 |
.\" * set default formatting |
| 24 |
.\" ----------------------------------------------------------------- |
| 25 |
.\" disable hyphenation |
| 26 |
.nh |
| 27 |
.\" disable justification (adjust text to left margin only) |
| 28 |
.ad l |
| 29 |
.\" ----------------------------------------------------------------- |
| 30 |
.\" * MAIN CONTENT STARTS HERE * |
| 31 |
.\" ----------------------------------------------------------------- |
| 32 |
.SH "NAME" |
| 33 |
maildrop \- mail delivery filter/agent |
| 34 |
.SH "SYNOPSIS" |
| 35 |
.HP \w'\fBmaildrop\fR\ 'u |
| 36 |
\fBmaildrop\fR [option...] [\-d\ \fIuser\fR] [\fIarg\fR...] |
| 37 |
.HP \w'\fBmaildrop\fR\ 'u |
| 38 |
\fBmaildrop\fR [option...] [\fIfilename\fR] [\fIarg\fR...] |
| 39 |
.SH "DESCRIPTION" |
| 40 |
.PP |
| 41 |
\fBmaildrop\fR |
| 42 |
is a replacement local mail delivery agent that includes a mail filtering language\&. The system administrator can either replace the existing mail delivery agent with |
| 43 |
\fBmaildrop\fR, or users may run |
| 44 |
\fBmaildrop\fR |
| 45 |
using the \*(Aqforward to program\*(Aq mechanism of the existing mail delivery agent\&. |
| 46 |
.PP |
| 47 |
\fBmaildrop\fR |
| 48 |
first reads the E\-mail message on standard input\&. Trailing carriage return characters are automatically stripped\&. An E\-mail message consists of header lines, followed by a blank line, followed by the contents of the message\&. |
| 49 |
.PP |
| 50 |
\fBmaildrop\fR |
| 51 |
does not accept an mbox\-style |
| 52 |
From_ |
| 53 |
line before the first header line\&. |
| 54 |
\fBmaildrop\fR |
| 55 |
does not accept leading empty lines before the first non\-blank header line\&. If the message can possibly start with empty lines, and a |
| 56 |
From_ |
| 57 |
line, use |
| 58 |
\fBreformail \-f0\fR |
| 59 |
to remove any initial empty lines, and replace a |
| 60 |
From_ |
| 61 |
line with a proper |
| 62 |
\(lqReturn\-Path:\(rq |
| 63 |
header; then pipe it to |
| 64 |
\fBmaildrop\fR\&. |
| 65 |
.PP |
| 66 |
If the file |
| 67 |
/etc/maildroprc |
| 68 |
exists, mail delivery or mail filtering instructions are read from that file\&. |
| 69 |
\fBmaildrop\fR\*(Aqs delivery/filtering instructions may direct |
| 70 |
\fBmaildrop\fR |
| 71 |
to save the message in specific mailbox, discard it, return it to sender, or forward it to a different E\-mail address\&. |
| 72 |
.PP |
| 73 |
If |
| 74 |
/etc/maildroprc |
| 75 |
does not exist, or its mail delivery instructions do not completely dispose of this message, |
| 76 |
\fBmaildrop\fR |
| 77 |
then reads the mail delivery instructions from |
| 78 |
$HOME/\&.mailfilter\&. If it doesn\*(Aqt exist, or its mail delivery instructions do not completely dispose of the message, |
| 79 |
\fBmaildrop\fR |
| 80 |
then saves the E\-mail message in the default mailbox\&. |
| 81 |
.PP |
| 82 |
\fBmaildrop\fR |
| 83 |
knows how to deliver mail to an standard mailbox files; it also knows how to deliver to maildirs\&. A |
| 84 |
maildir |
| 85 |
is a directory\-based mail format used by the |
| 86 |
\m[blue]\fBCourier\fR\m[]\&\s-2\u[1]\d\s+2 |
| 87 |
and |
| 88 |
Qmail |
| 89 |
mail servers\&. Many other mail servers also know how to read maildirs\&. When delivering to mailbox files, |
| 90 |
\fBmaildrop\fR |
| 91 |
will lock the mailbox for the duration of the delivery\&. |
| 92 |
.PP |
| 93 |
This is the general mail delivery behavior\&. There are minor differences in behavior depending on |
| 94 |
\fBmaildrop\fR |
| 95 |
delivery mode, which is determined based on how |
| 96 |
\fBmaildrop\fR |
| 97 |
was started\&. |
| 98 |
\fBmaildrop\fR |
| 99 |
uses three different primary operating modes: |
| 100 |
.PP |
| 101 |
Manual mode |
| 102 |
.RS 4 |
| 103 |
A file containing filtering instructions \- |
| 104 |
\fIfilename\fR |
| 105 |
is specified as an argument to the |
| 106 |
\fBmaildrop\fR |
| 107 |
command\&. |
| 108 |
\fBmaildrop\fR |
| 109 |
reads this |
| 110 |
\fIfilename\fR |
| 111 |
and follows the instructions in it\&. Unless the message is explicitly forwarded, bounced, deleted, or delivered to a specific mailbox, it will be delivered to the user\*(Aqs system mailbox\&. |
| 112 |
.RE |
| 113 |
.PP |
| 114 |
Delivery mode |
| 115 |
.RS 4 |
| 116 |
\fBmaildrop\fR |
| 117 |
is the mail server\*(Aqs mail delivery agent\&. |
| 118 |
\fBmaildrop\fR |
| 119 |
runs in delivery mode when no |
| 120 |
\fIfilename\fR |
| 121 |
is specified on the command line\&. |
| 122 |
\fBmaildrop\fR |
| 123 |
changes the current directory to the user\*(Aqs home directory, then reads |
| 124 |
/etc/maildroprc, then |
| 125 |
$HOME/\&.mailfilter\&. |
| 126 |
.RE |
| 127 |
.PP |
| 128 |
Embedded mode |
| 129 |
.RS 4 |
| 130 |
\fBmaildrop\fR |
| 131 |
functions as a part of another application\&. The embedded mode is used by the |
| 132 |
\m[blue]\fBCourier\fR\m[]\&\s-2\u[1]\d\s+2 |
| 133 |
mail server to integrate mail filtering directly into the process of receiving mail from a remote mail relay, thus rejecting unwanted mail before it is even accepted for local mail delivery\&. Embedded mode is used when either the \-m, or the \-M, option is specified, and is described below\&. See below for a more extensive description of the embedded mode\&. |
| 134 |
.RE |
| 135 |
.SH "SECURITY" |
| 136 |
.PP |
| 137 |
It is safe to install |
| 138 |
\fBmaildrop\fR |
| 139 |
as a root setuid program\&. |
| 140 |
\m[blue]\fBThe Courier mail server\fR\m[]\&\s-2\u[1]\d\s+2 |
| 141 |
installs |
| 142 |
\fBmaildrop\fR |
| 143 |
as a root setuid program by default, in order to be able to use |
| 144 |
\fBmaildrop\fR |
| 145 |
in embedded mode\&. If root runs |
| 146 |
\fBmaildrop\fR |
| 147 |
(or it is setuided to root) the |
| 148 |
\fB\-d\fR |
| 149 |
option may be used to specify the message\*(Aqs recipient\&. |
| 150 |
\fBmaildrop\fR |
| 151 |
immediately resets its userid to the one specified by the |
| 152 |
\fB\-d\fR |
| 153 |
option\&. The user\*(Aqs |
| 154 |
$HOME/\&.mailfilter |
| 155 |
is read (if it exists), and the message is delivered to the indicated user\&. |
| 156 |
.PP |
| 157 |
The system administrator can configure |
| 158 |
\fBmaildrop\fR |
| 159 |
to restrict the |
| 160 |
\fB\-d\fR |
| 161 |
option for everyone except the mail system itself\&. |
| 162 |
.PP |
| 163 |
If in delivery mode the user\*(Aqs home directory has the sticky bit set, |
| 164 |
\fBmaildrop\fR |
| 165 |
immediately terminates with an exit code of |
| 166 |
\fBEX_TEMPFAIL\fR, without doing anything\&. Mail servers interpret the |
| 167 |
\fBEX_TEMPFAIL\fR |
| 168 |
exit code as a request to reschedule the message for another delivery attempt later\&. Setting the sticky bit allows |
| 169 |
$HOME/\&.mailfilter |
| 170 |
to be edited while temporarily holding all incoming mail\&. |
| 171 |
.PP |
| 172 |
\fBmaildrop\fR |
| 173 |
also terminates with |
| 174 |
\fBEX_TEMPFAIL\fR |
| 175 |
if the user\*(Aqs home directory has world write permissions\&. |
| 176 |
.PP |
| 177 |
\fBmaildrop\fR |
| 178 |
immediately terminates with |
| 179 |
\fBEX_TEMPFAIL\fR |
| 180 |
if the |
| 181 |
filename |
| 182 |
is not owned by the user, or if it has any group or world permissions\&. This includes read permissions\&. The permissions on |
| 183 |
$HOME/\&.mailfilter |
| 184 |
may only include read and write privileges to the user\&. |
| 185 |
.PP |
| 186 |
When using the special embedded mode (see below) |
| 187 |
\fBmaildrop\fR |
| 188 |
immediately terminates with the exit code set to |
| 189 |
\fBEX_TEMPFAIL\fR |
| 190 |
if |
| 191 |
$HOME/\&.mailfilters |
| 192 |
is not owned by the user, or if it has any group or world permissions\&. |
| 193 |
.SH "TEMPORARY FILES" |
| 194 |
.PP |
| 195 |
\fBmaildrop\fR |
| 196 |
is heavily optimized and tries to use as little resources as possible\&. |
| 197 |
\fBmaildrop\fR |
| 198 |
reads small messages into memory, then filters and/or delivers the message directly from memory\&. For larger messages, |
| 199 |
\fBmaildrop\fR |
| 200 |
accesses the message directly from the file\&. If the standard input is not a file, |
| 201 |
\fBmaildrop\fR |
| 202 |
writes the message to a temporary file, then accesses the message from the temporary file\&. The temporary file is automatically removed when the message is delivered\&. |
| 203 |
.SH "OPTIONS" |
| 204 |
.PP |
| 205 |
\-a |
| 206 |
.RS 4 |
| 207 |
Makes the |
| 208 |
Courier |
| 209 |
Authentication Library usage mandatory, i\&.e\&. maildrop will throw a temporary error code if the call to the authlib mechanism fails for some reason, such as authdaemon being inaccessible\&. |
| 210 |
.if n \{\ |
| 211 |
.sp |
| 212 |
.\} |
| 213 |
.RS 4 |
| 214 |
.nr an-no-space-flag 1 |
| 215 |
.nr an-break-flag 1 |
| 216 |
.br |
| 217 |
.ps +1 |
| 218 |
\fBNote\fR |
| 219 |
.ps -1 |
| 220 |
.br |
| 221 |
This setting may already be the default, depending on maildrop\*(Aqs configuration\&. |
| 222 |
.sp .5v |
| 223 |
.RE |
| 224 |
.RE |
| 225 |
.PP |
| 226 |
\-A "\fIHeader: value\fR" |
| 227 |
.RS 4 |
| 228 |
Adds an additional header to the message\&. Specifying |
| 229 |
\fI\-A "Foo: Bar"\fR |
| 230 |
effectively adds this header to the message being delivered\&. |
| 231 |
.sp |
| 232 |
The mail transport agent usually adds additional headers when delivering a message to a local mailbox\&. The way it\*(Aqs usually done is by the mail transport agent sending the message using a pipe to the local delivery agent \- such as |
| 233 |
\fBmaildrop\fR |
| 234 |
\- and adding some additional headers in the process\&. Because |
| 235 |
\fBmaildrop\fR |
| 236 |
receives the message from a pipe, |
| 237 |
\fBmaildrop\fR |
| 238 |
must either save the message in memory or write the message into a temporary file\&. |
| 239 |
.sp |
| 240 |
The |
| 241 |
\fB\-A\fR |
| 242 |
option enables the file containing the message to be provided to |
| 243 |
\fBmaildrop\fR |
| 244 |
directly, as standard input, and the additional headers specified on the command line\&. Because the standard input is a file, |
| 245 |
\fBmaildrop\fR |
| 246 |
will not need a temporary file\&. Multiple |
| 247 |
\fB\-A\fR |
| 248 |
options may be specified\&. |
| 249 |
.RE |
| 250 |
.PP |
| 251 |
\-d \fIuser\fR |
| 252 |
.RS 4 |
| 253 |
Run |
| 254 |
\fBmaildrop\fR |
| 255 |
in delivery mode for this user ID\&. |
| 256 |
.sp |
| 257 |
The system administrator may optionally restrict the |
| 258 |
\fB\-d\fR |
| 259 |
option to be available to the mail system only, so it may not be available to you\&. In all cases, the |
| 260 |
\fB\-d\fR |
| 261 |
option is allowed if |
| 262 |
\fIuser\fR |
| 263 |
is the same user who is running |
| 264 |
\fBmaildrop\fR\&. Also, for the |
| 265 |
\fB\-d\fR |
| 266 |
option to work at all, |
| 267 |
\fBmaildrop\fR |
| 268 |
must be executed by root, or |
| 269 |
\fBmaildrop\fR |
| 270 |
must be a root\-owned program with the setuid bit set\&. Absence of a |
| 271 |
filename |
| 272 |
on |
| 273 |
\fBmaildrop\fR\*(Aqs command line implies the |
| 274 |
\fB\-d\fR |
| 275 |
option for the user running |
| 276 |
\fBmaildrop\fR\&. |
| 277 |
.sp |
| 278 |
If |
| 279 |
\fB\-d\fR |
| 280 |
is not specified, the first argument following all the options is a name of the file containing filtering instructions\&. The remaining arguments, if any, are assigned to the variables |
| 281 |
\fI$1\fR, |
| 282 |
\fI$2\fR, and so on (see |
| 283 |
\m[blue]\fB"Environment"\fR\m[]\&\s-2\u[2]\d\s+2 |
| 284 |
and |
| 285 |
\m[blue]\fB"Variable substitution"\fR\m[]\&\s-2\u[3]\d\s+2)\&. |
| 286 |
.RE |
| 287 |
.PP |
| 288 |
\-f \fIaddress\fR |
| 289 |
.RS 4 |
| 290 |
Sets the FROM variable (message envelope sender) to |
| 291 |
\fIaddress\fR\&. The system administrator may optionally disable the |
| 292 |
\fB\-f\fR |
| 293 |
option for users, so it may not be available to you\&. |
| 294 |
.RE |
| 295 |
.PP |
| 296 |
\-m |
| 297 |
.RS 4 |
| 298 |
Run |
| 299 |
\fBmaildrop\fR |
| 300 |
in embedded mode\&. It\*(Aqs possible to use both the |
| 301 |
\fB\-m\fR, and the |
| 302 |
\fB\-d\fR |
| 303 |
options, but it doesn\*(Aqt make much sense to do so\&. Even if you really wanted to run your message through someone else\*(Aqs |
| 304 |
\&.mailfilter, that |
| 305 |
\&.mailfilter |
| 306 |
probably has at least one instruction which is not allowed in the embedded mode\&. |
| 307 |
.sp |
| 308 |
The |
| 309 |
filename |
| 310 |
argument to |
| 311 |
\fBmaildrop\fR |
| 312 |
should be specified\&. |
| 313 |
filename |
| 314 |
is a file that includes filtering instructions to be processed in embedded mode\&. The |
| 315 |
\-m |
| 316 |
option is used for debugging filter files which are later placed in |
| 317 |
$HOME/\&.mailfilters, and used with the |
| 318 |
\fB\-M\fR |
| 319 |
option\&. |
| 320 |
.RE |
| 321 |
.PP |
| 322 |
\-M \fIfilterfile\fR |
| 323 |
.RS 4 |
| 324 |
Run |
| 325 |
\fBmaildrop\fR |
| 326 |
in a special embedded mode\&. The |
| 327 |
\fB\-d\fR |
| 328 |
option is implied when |
| 329 |
\fB\-M\fR |
| 330 |
is used, and if absent it defaults to the userid running |
| 331 |
\fBmaildrop\fR\&. |
| 332 |
.sp |
| 333 |
All the requirements for the |
| 334 |
\fB\-d\fR |
| 335 |
option apply\&. |
| 336 |
\fBmaildrop\fR |
| 337 |
must either be executed by root, or the |
| 338 |
\fBmaildrop\fR |
| 339 |
program must be owned by root with the setuid bit set\&. |
| 340 |
\fBmaildrop\fR |
| 341 |
immediately gives up root privileges by changing its user ID to the one specified by |
| 342 |
\fB\-d\fR, then reads |
| 343 |
$HOME/\&.mailfilters/\fIfilterfile\fR\&. For security reasons the name of the file may not begin with a slash or include periods\&. |
| 344 |
\fBmaildrop\fR |
| 345 |
is very paranoid: both |
| 346 |
$HOME/\&.mailfilters, and |
| 347 |
$HOME/\&.mailfilters/\fIfilterfile\fR |
| 348 |
must be owned by the user, and may not have any group or world permissions\&. |
| 349 |
.sp |
| 350 |
The |
| 351 |
\fB\-M\fR |
| 352 |
option allows for some friendly cooperation between the user running the application, and the user who provides a filter for the embedded mode\&. The user running the application can use someone else\*(Aqs canned filter and be assured that the filter is not going to run amok and start sending mail or create files all over the place\&. The user who provides the filter can be assured that the environment variables are clean, and that there are no surprises\&. |
| 353 |
.sp |
| 354 |
\fBmaildrop\fR |
| 355 |
supports the concept of "default" filter files\&. If the file specified by the |
| 356 |
\fB\-M\fR |
| 357 |
option cannot be found in |
| 358 |
$HOME/\&.mailfilters, |
| 359 |
\fBmaildrop\fR |
| 360 |
will try to open |
| 361 |
$HOME/\&.mailfilters/\fIfilterfileprefix\fR\-default\&. |
| 362 |
\fIfilterfileprefix\fR |
| 363 |
is the initial part of |
| 364 |
\fIfilterfile\fR |
| 365 |
up until the last \*(Aq\-\*(Aq character in |
| 366 |
\fIfilterfile\fR\&. |
| 367 |
.sp |
| 368 |
If |
| 369 |
$HOME/\&.mailfilters/\fIfilterfileprefix\fR\-default |
| 370 |
does not exist, and there are any other dashes left in |
| 371 |
\fIfilterfileprefix\fR, maildrop removes the last dash and everything following it, then tries again\&. |
| 372 |
.sp |
| 373 |
As a last resort |
| 374 |
\fBmaildrop\fR |
| 375 |
tries to open |
| 376 |
$HOME/\&.mailfilters/default\&. |
| 377 |
.sp |
| 378 |
For example, if the parameter to the |
| 379 |
\fB\-M\fR |
| 380 |
option is |
| 381 |
\fImailfilter\-lists\-maildrop\fR, |
| 382 |
\fBmaildrop\fR |
| 383 |
will try to open the following files, in order: |
| 384 |
.sp .if n \{\ .RS 4 .\} .nf $HOME/\&.mailfilters/mailfilter\-lists\-maildrop $HOME/\&.mailfilters/mailfilter\-lists\-maildrop\-default $HOME/\&.mailfilters/mailfilter\-lists\-default $HOME/\&.mailfilters/mailfilter\-default $HOME/\&.mailfilters/default .fi .if n \{\ .RE .\} |
| 385 |
.sp |
| 386 |
Note that |
| 387 |
\fBmaildrop\fR |
| 388 |
looks for \-default files ONLY if |
| 389 |
\fB\-M\fR |
| 390 |
is used\&. |
| 391 |
.RE |
| 392 |
.PP |
| 393 |
\-D \fIuuu/ggg\fR |
| 394 |
.RS 4 |
| 395 |
This option is reserved for use by the version of |
| 396 |
\fBmaildrop\fR |
| 397 |
that comes integrated with the |
| 398 |
\m[blue]\fBCourier mail server\fR\m[]\&\s-2\u[1]\d\s+2\&. |
| 399 |
.RE |
| 400 |
.PP |
| 401 |
\-V \fIlevel\fR |
| 402 |
.RS 4 |
| 403 |
Initialize the |
| 404 |
\fIVERBOSE\fR |
| 405 |
variable to |
| 406 |
\fIlevel\fR\&. Because |
| 407 |
\fBmaildrop\fR |
| 408 |
parses the entire file before running it, this option is used to produce debugging output in the parsing phase\&. Otherwise, if |
| 409 |
filename |
| 410 |
has syntax errors, then no debugging output is possible because the |
| 411 |
\fIVERBOSE\fR |
| 412 |
variable is not yet set\&. |
| 413 |
.sp |
| 414 |
\fB\-V\fR |
| 415 |
is ignored when |
| 416 |
\fBmaildrop\fR |
| 417 |
runs in delivery mode\&. |
| 418 |
.RE |
| 419 |
.PP |
| 420 |
\-w \fIN\fR |
| 421 |
.RS 4 |
| 422 |
The |
| 423 |
\fB\-w N\fR |
| 424 |
option places a warning message into the maildir if the maildir has a quota setting, and after the message was successfully delivered the maildir was at least |
| 425 |
\fIN\fR |
| 426 |
percent full\&. |
| 427 |
.RE |
| 428 |
.PP |
| 429 |
\-W \fIfilename\fR |
| 430 |
.RS 4 |
| 431 |
Copy the warning message from |
| 432 |
\fIfilename\fR, or from |
| 433 |
/etc/quotawarnmsg |
| 434 |
if this option is not specified, with the addition of the "Date:" and "Message\-Id:" headers\&. The warning is repeated every 24 hours (at least), until the maildir drops below |
| 435 |
\fIN\fR |
| 436 |
percent full\&. |
| 437 |
.RE |
| 438 |
.PP |
| 439 |
\-t \fIsocket\fR |
| 440 |
.RS 4 |
| 441 |
This option is available if maildrop is compiled with optional Dovecot authentication support\&. |
| 442 |
\fIsocket\fR |
| 443 |
specifies the location of Dovecot master authentication socket, for example |
| 444 |
/var/run/dovecot/auth\-master\&. |
| 445 |
.RE |
| 446 |
.SH "DELIVERY MODE" |
| 447 |
.PP |
| 448 |
If a |
| 449 |
filename |
| 450 |
is not specified on the command line, or if the |
| 451 |
\fB\-d\fR |
| 452 |
option is used, |
| 453 |
\fBmaildrop\fR |
| 454 |
will run in delivery mode\&. In delivery mode, |
| 455 |
\fBmaildrop\fR |
| 456 |
changes to the home directory of the user specified by the |
| 457 |
\fB\-d\fR |
| 458 |
option (or the user who is running |
| 459 |
\fBmaildrop\fR |
| 460 |
if the |
| 461 |
\fB\-d\fR |
| 462 |
option was not given) and reads |
| 463 |
$HOME/\&.mailfilter |
| 464 |
for filtering instructions\&. |
| 465 |
$HOME/\&.mailfilter |
| 466 |
must be owned by the user, and have no group or global permissions (\fBmaildrop\fR |
| 467 |
terminates if it does)\&. |
| 468 |
.PP |
| 469 |
If |
| 470 |
$HOME/\&.mailfilter |
| 471 |
does not exist, |
| 472 |
\fBmaildrop\fR |
| 473 |
will simply deliver the message to the user\*(Aqs mailbox\&. |
| 474 |
.PP |
| 475 |
If the file |
| 476 |
/etc/maildroprc |
| 477 |
exists, |
| 478 |
\fBmaildrop\fR |
| 479 |
reads filtering instructions from this file first, before reading |
| 480 |
$HOME/\&.mailfilter\&. This allows the system administrator to provide global filtering instructions for all users\&. |
| 481 |
.if n \{\ |
| 482 |
.sp |
| 483 |
.\} |
| 484 |
.RS 4 |
| 485 |
.nr an-no-space-flag 1 |
| 486 |
.nr an-break-flag 1 |
| 487 |
.br |
| 488 |
.ps +1 |
| 489 |
\fBNote\fR |
| 490 |
.ps -1 |
| 491 |
.br |
| 492 |
.PP |
| 493 |
/etc/maildroprc |
| 494 |
is read only in delivery mode\&. |
| 495 |
.sp .5v |
| 496 |
.RE |
| 497 |
.SH "VIRTUAL ACCOUNTS" |
| 498 |
.PP |
| 499 |
The |
| 500 |
\fB\-d\fR |
| 501 |
option can also specify a name of a virtual account or mailbox\&. See the |
| 502 |
\fBmakeuserdb\fR(1) |
| 503 |
manual page in the |
| 504 |
Courier |
| 505 |
Authentication library\*(Aqs documentation for more information\&. |
| 506 |
.SH "EMBEDDED MODE" |
| 507 |
.PP |
| 508 |
The embedded mode is used when |
| 509 |
\fBmaildrop\fR\*(Aqs filtering abilities are desired, but no actual mail delivery is needed\&. In embedded mode |
| 510 |
\fBmaildrop\fR |
| 511 |
is executed by another application, and |
| 512 |
\m[blue]\fBis passed the \(hym or the \(hyM option\&.\fR\m[]\&\s-2\u[4]\d\s+2 |
| 513 |
\fBmaildrop\fR |
| 514 |
reads the message, then runs the filtering rules specified in |
| 515 |
filename\&. |
| 516 |
.PP |
| 517 |
filename |
| 518 |
may contain any filtering instructions EXCEPT the following: |
| 519 |
.PP |
| 520 |
` \&.\&.\&. ` |
| 521 |
.RS 4 |
| 522 |
Text strings delimited by back\-tick characters (run shell command) are not allowed\&. |
| 523 |
.RE |
| 524 |
.PP |
| 525 |
\m[blue]\fBcc\fR\m[]\&\s-2\u[5]\d\s+2 |
| 526 |
.RS 4 |
| 527 |
The |
| 528 |
\fBcc\fR |
| 529 |
command is not allowed in embedded mode\&. |
| 530 |
.RE |
| 531 |
.PP |
| 532 |
\m[blue]\fBdotlock\fR\m[]\&\s-2\u[6]\d\s+2 |
| 533 |
.RS 4 |
| 534 |
The |
| 535 |
\fBdotlock\fR |
| 536 |
command is not allowed in embedded mode\&. |
| 537 |
.RE |
| 538 |
.PP |
| 539 |
\m[blue]\fBflock\fR\m[]\&\s-2\u[7]\d\s+2 |
| 540 |
.RS 4 |
| 541 |
The |
| 542 |
\fBflock\fR |
| 543 |
command is not allowed in embedded mode\&. |
| 544 |
.RE |
| 545 |
.PP |
| 546 |
\m[blue]\fBgdbmopen\fR\m[]\&\s-2\u[8]\d\s+2 |
| 547 |
.RS 4 |
| 548 |
In embedded mode, GDBM databases may be opened only for reading\&. |
| 549 |
.RE |
| 550 |
.PP |
| 551 |
\m[blue]\fBlog\fR\m[]\&\s-2\u[9]\d\s+2 |
| 552 |
.RS 4 |
| 553 |
The |
| 554 |
\fBlog\fR |
| 555 |
command is not allowed in embedded mode\&. |
| 556 |
.RE |
| 557 |
.PP |
| 558 |
\m[blue]\fBlogfile\fR\m[]\&\s-2\u[9]\d\s+2 |
| 559 |
.RS 4 |
| 560 |
The |
| 561 |
\fBlogfile\fR |
| 562 |
command is not allowed in embedded mode\&. |
| 563 |
.RE |
| 564 |
.PP |
| 565 |
\m[blue]\fBsystem\fR\m[]\&\s-2\u[10]\d\s+2 |
| 566 |
.RS 4 |
| 567 |
The |
| 568 |
\fBsystem\fR |
| 569 |
command is not allowed in embedded mode\&. |
| 570 |
.RE |
| 571 |
.PP |
| 572 |
\m[blue]\fBto\fR\m[]\&\s-2\u[11]\d\s+2 |
| 573 |
.RS 4 |
| 574 |
The |
| 575 |
\fBto\fR |
| 576 |
command is not allowed in embedded mode\&. |
| 577 |
.RE |
| 578 |
.PP |
| 579 |
\m[blue]\fBxfilter\fR\m[]\&\s-2\u[12]\d\s+2 |
| 580 |
.RS 4 |
| 581 |
The |
| 582 |
\fBxfilter\fR |
| 583 |
command is not allowed in embedded mode\&. |
| 584 |
.RE |
| 585 |
.PP |
| 586 |
Normally when the |
| 587 |
filename |
| 588 |
does not explicitly delivers a message, |
| 589 |
\fBmaildrop\fR |
| 590 |
will deliver the message to the user\*(Aqs default mailbox\&. This is also disabled in embedded mode\&. |
| 591 |
.PP |
| 592 |
The |
| 593 |
filename |
| 594 |
may communicate with the parent application by using the |
| 595 |
\m[blue]\fBecho\fR\m[]\&\s-2\u[13]\d\s+2 |
| 596 |
statement and the |
| 597 |
\fIEXITCODE\fR |
| 598 |
environment variable\&. |
| 599 |
.SS "/etc/maildroprcs" |
| 600 |
.PP |
| 601 |
If |
| 602 |
\fBmaildrop\fR |
| 603 |
encounters an |
| 604 |
\m[blue]\fBinclude\fR\m[]\&\s-2\u[14]\d\s+2 |
| 605 |
statement where the filename starts with |
| 606 |
/etc/maildroprcs/, the normal restrictions for the embedded mode are suspended while executing the filter file in the |
| 607 |
/etc/maildroprcs |
| 608 |
directory\&. The restrictions are also suspended for any additional filter files that are included from |
| 609 |
/etc/maildroprcs\&. The restrictions resume once |
| 610 |
\fBmaildrop\fR |
| 611 |
finishes executing the file from |
| 612 |
/etc/maildroprcs\&. |
| 613 |
.PP |
| 614 |
This allows the system administrator to have a controlled environment for running external commands (via the backticks, the |
| 615 |
\m[blue]\fBsystem\fR\m[]\&\s-2\u[10]\d\s+2 |
| 616 |
or the |
| 617 |
\m[blue]\fBxfilter\fR\m[]\&\s-2\u[12]\d\s+2 |
| 618 |
commands)\&. |
| 619 |
.PP |
| 620 |
The name of the file may not contain any periods (so that a creative individual can\*(Aqt write |
| 621 |
\fIinclude "/etc/maildroprcs/\&.\&./\&.\&./home/user/recipe"\fR)\&. |
| 622 |
.PP |
| 623 |
Before executing the commands in the |
| 624 |
/etc/maildroprcs |
| 625 |
file, |
| 626 |
\fBmaildrop\fR |
| 627 |
automatically resets the following variables to their initial values: |
| 628 |
\fIDEFAULT\fR, |
| 629 |
\fIHOME\fR, |
| 630 |
\fILOCKEXT\fR, |
| 631 |
\fILOCKSLEEP\fR, |
| 632 |
\fILOCKTIMEOUT\fR, |
| 633 |
\fILOCKREFRESH\fR, |
| 634 |
\fILOGNAME\fR, |
| 635 |
\fIPATH\fR, |
| 636 |
\fISENDMAIL\fR, and |
| 637 |
\fISHELL\fR\&. Please note that the previous values of these variables (if they were changed) will NOT be restored once |
| 638 |
\fBmaildrop\fR |
| 639 |
finishes executing the commands from |
| 640 |
/etc/maildroprcs\&. |
| 641 |
.SH "WATCHDOG TIMER" |
| 642 |
.PP |
| 643 |
\fBmaildrop\fR |
| 644 |
has a watchdog timer that attempts to abort runaway filtering\&. If filtering is not complete within a predefined time interval (defined by the system administrator, usually five minutes), |
| 645 |
\fBmaildrop\fR |
| 646 |
terminates\&. |
| 647 |
.SH "FILES" |
| 648 |
.PP |
| 649 |
/etc/passwd |
| 650 |
.RS 4 |
| 651 |
Sets user\*(Aqs home directory, and related variables\&. If NIS/YP is install, that will be used as well\&. |
| 652 |
.RE |
| 653 |
.PP |
| 654 |
/etc/maildroprc |
| 655 |
.RS 4 |
| 656 |
Global filtering instructions for delivery mode\&. |
| 657 |
.RE |
| 658 |
.PP |
| 659 |
/var/mail |
| 660 |
.RS 4 |
| 661 |
System mailbox (actual directory defined by the system administrator)\&. |
| 662 |
.RE |
| 663 |
.PP |
| 664 |
/usr/sbin/sendmail |
| 665 |
.RS 4 |
| 666 |
Program to forward mail (exact program defined by the system administrator)\&. |
| 667 |
.RE |
| 668 |
.PP |
| 669 |
$HOME/\&.mailfilter |
| 670 |
.RS 4 |
| 671 |
Filtering instructions in delivery mode\&. |
| 672 |
.RE |
| 673 |
.PP |
| 674 |
$HOME/\&.mailfilters |
| 675 |
.RS 4 |
| 676 |
Directory containing files used in special embedded mode\&. |
| 677 |
.RE |
| 678 |
.SH "SEE ALSO" |
| 679 |
.PP |
| 680 |
\m[blue]\fB\fBlockmail\fR(1)\fR\m[]\&\s-2\u[15]\d\s+2, |
| 681 |
\m[blue]\fB\fBmaildropfilter\fR(7)\fR\m[]\&\s-2\u[16]\d\s+2, |
| 682 |
\m[blue]\fB\fBmakedat\fR(1)\fR\m[]\&\s-2\u[17]\d\s+2, |
| 683 |
\m[blue]\fB\fBmaildropgdbm\fR(7)\fR\m[]\&\s-2\u[8]\d\s+2, |
| 684 |
\m[blue]\fB\fBmaildropex\fR(7)\fR\m[]\&\s-2\u[18]\d\s+2, |
| 685 |
\m[blue]\fB\fBreformail\fR(1)\fR\m[]\&\s-2\u[19]\d\s+2, |
| 686 |
\m[blue]\fB\fBmakemime\fR(1)\fR\m[]\&\s-2\u[20]\d\s+2, |
| 687 |
\m[blue]\fB\fBreformime\fR(1)\fR\m[]\&\s-2\u[21]\d\s+2, |
| 688 |
\fBegrep\fR(1), |
| 689 |
\fBgrep\fR(1), , |
| 690 |
\m[blue]\fB\fBcourier\fR(8)\fR\m[]\&\s-2\u[22]\d\s+2, |
| 691 |
\fBsendmail\fR(8)\&. |
| 692 |
.SH "AUTHOR" |
| 693 |
.PP |
| 694 |
\fBSam Varshavchik\fR |
| 695 |
.RS 4 |
| 696 |
Author |
| 697 |
.RE |
| 698 |
.SH "NOTES" |
| 699 |
.IP " 1." 4 |
| 700 |
Courier |
| 701 |
.RS 4 |
| 702 |
\%https://www.courier-mta.org |
| 703 |
.RE |
| 704 |
.IP " 2." 4 |
| 705 |
"Environment" |
| 706 |
.RS 4 |
| 707 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#environment |
| 708 |
.RE |
| 709 |
.IP " 3." 4 |
| 710 |
"Variable substitution" |
| 711 |
.RS 4 |
| 712 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#varsubst |
| 713 |
.RE |
| 714 |
.IP " 4." 4 |
| 715 |
is passed the \(hym or the \(hyM option. |
| 716 |
.RS 4 |
| 717 |
\%http://www.courier-mta.org/maildrop/#options |
| 718 |
.RE |
| 719 |
.IP " 5." 4 |
| 720 |
cc |
| 721 |
.RS 4 |
| 722 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#cc |
| 723 |
.RE |
| 724 |
.IP " 6." 4 |
| 725 |
dotlock |
| 726 |
.RS 4 |
| 727 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#dotlock |
| 728 |
.RE |
| 729 |
.IP " 7." 4 |
| 730 |
flock |
| 731 |
.RS 4 |
| 732 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#flock |
| 733 |
.RE |
| 734 |
.IP " 8." 4 |
| 735 |
gdbmopen |
| 736 |
.RS 4 |
| 737 |
\%http://www.courier-mta.org/maildrop/maildropgdbm.html |
| 738 |
.RE |
| 739 |
.IP " 9." 4 |
| 740 |
log |
| 741 |
.RS 4 |
| 742 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#log |
| 743 |
.RE |
| 744 |
.IP "10." 4 |
| 745 |
system |
| 746 |
.RS 4 |
| 747 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#system |
| 748 |
.RE |
| 749 |
.IP "11." 4 |
| 750 |
to |
| 751 |
.RS 4 |
| 752 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#to |
| 753 |
.RE |
| 754 |
.IP "12." 4 |
| 755 |
xfilter |
| 756 |
.RS 4 |
| 757 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#xfilter |
| 758 |
.RE |
| 759 |
.IP "13." 4 |
| 760 |
echo |
| 761 |
.RS 4 |
| 762 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#echo |
| 763 |
.RE |
| 764 |
.IP "14." 4 |
| 765 |
include |
| 766 |
.RS 4 |
| 767 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html#include |
| 768 |
.RE |
| 769 |
.IP "15." 4 |
| 770 |
\fBlockmail\fR(1) |
| 771 |
.RS 4 |
| 772 |
\%http://www.courier-mta.org/maildrop/lockmail.html |
| 773 |
.RE |
| 774 |
.IP "16." 4 |
| 775 |
\fBmaildropfilter\fR(7) |
| 776 |
.RS 4 |
| 777 |
\%http://www.courier-mta.org/maildrop/maildropfilter.html |
| 778 |
.RE |
| 779 |
.IP "17." 4 |
| 780 |
\fBmakedat\fR(1) |
| 781 |
.RS 4 |
| 782 |
\%http://www.courier-mta.org/maildrop/makedat.html |
| 783 |
.RE |
| 784 |
.IP "18." 4 |
| 785 |
\fBmaildropex\fR(7) |
| 786 |
.RS 4 |
| 787 |
\%http://www.courier-mta.org/maildrop/maildropex.html |
| 788 |
.RE |
| 789 |
.IP "19." 4 |
| 790 |
\fBreformail\fR(1) |
| 791 |
.RS 4 |
| 792 |
\%http://www.courier-mta.org/maildrop/reformail.html |
| 793 |
.RE |
| 794 |
.IP "20." 4 |
| 795 |
\fBmakemime\fR(1) |
| 796 |
.RS 4 |
| 797 |
\%http://www.courier-mta.org/maildrop/makemime.html |
| 798 |
.RE |
| 799 |
.IP "21." 4 |
| 800 |
\fBreformime\fR(1) |
| 801 |
.RS 4 |
| 802 |
\%http://www.courier-mta.org/maildrop/reformime.html |
| 803 |
.RE |
| 804 |
.IP "22." 4 |
| 805 |
\fBcourier\fR(8) |
| 806 |
.RS 4 |
| 807 |
\%http://www.courier-mta.org/maildrop/courier.html |
| 808 |
.RE |