Procmail is a program for filtering, sorting and storing email. It can be used both on mail clients and mail servers. It can be used to filter out spam, checking for viruses, to send automatic replies, etc.
The goal of this article is to teach the configuration of procmail. This article asumes you already have either a email client (mutt, nmh, etc) or a mail server (sendmail, postfix, etc) working, that can use (or requires) procmail. It also assumes you have at least basic knowleadge on regular expressions. This article will give only a minimal explanation, for a complete manual, check the
Install the package official repositories.from the
The configuration is going to be saved on
~/.procmailrc if this is the configuration for an email client, or on
/etc/procmailrc if is going to be used by an email server.
The configuration is composed of two sections; assignments and recipes.
The assignments section provides variables for procmail
PATH=/bin:/usr/bin MAILDIR=$HOME/Mail DEFAULT=$HOME/Mail/inbox LOGFILE=/dev/null SHELL=/bin/sh
Recipes have the following format:
:0 [flags] [ : [locallockfile] ] <zero or more conditions (one per line)> <exactly one action line>
The conditions are extended regular expressions, with some few extra options. Conditions always start with an asterisk.
The action can be only a mailbox name, or an external program.
Flags and lockfile
For basic recipes, you don't need any flags. But they can be necessary if your script calls an external command. Here is a list of some of the most used flags:
- f Consider the pipe as a filter.
- w Wait for the filter or program to finish and check its exitcode (normally ignored); if the filter is unsuccessful, then the text will not have been filtered.
A condition is an extended regexp, starting with an asterisk, like this one:
* ^From.* someperson@\w+.com
An action can be something as simple as
in that case, the mail that complies with the condition will be saved on the
It could also start with a pipe, which means the message is going to be passed to the standard input of the command following the pipe. A line like that could be something like this:
By default, once a recipe's action is used, the processing is over.
If the f flag was used, the command can alter the message and keep reading recipes. In this example, the spamassassin command will add headers to the mail, with its spam status level, which later can be used by another recipe to block it, or store it on a different mailbox.
Tips and tricks
Here is an example using spamassassin to block spam. You should already have spamassassin installed and working.
# By using the f and w flags and no condition, spamassassin is going add the X-Spam headers to every single mail. # No lockfile is used. :0fw | /usr/bin/vendor_perl/spamc # Messages with a 5 stars or higher spam level are going to be deleted right away # And since we never touch any inbox, no lockfile is needed. :0 * ^X-Spam-Level: \*\*\*\*\* /dev/null # If a mail with spam-status:yes wasn't deleted by previous line, it could be a false positive. So its going to be sent to an spam mailbox instead. # Since we don't want the possibility of one procmail instance messing with another procmail instance, we use a lockfile :0: * ^X-Spam-Status: Yes $HOME/mail/Spam