Provided by: dovecot-common_2.0.13-1ubuntu3_i386
pigeonhole - Overview of the Pigeonhole project's Sieve support for the
Dovecot secure IMAP and POP3 server
The Pigeonhole project <http://pigeonhole.dovecot.org> adds support for
the Sieve language (RFC 5228) and the ManageSieve protocol (RFC 5804)
to the Dovecot Secure IMAP and POP3 Server (dovecot(1)). In the literal
sense, a pigeonhole is a a hole or recess inside a dovecot for pigeons
to nest in. It is, however, also the name for one of a series of
small, open compartments in a cabinet used for filing or sorting mail.
As a verb, it describes the act of putting an item into one of those
pigeonholes. The name "Pigeonhole" therefore well describes an
important part of the functionality that this project adds to Dovecot:
sorting and filing e-mail messages.
The Sieve language is used to specify how e-mail needs to be processed.
By writing Sieve scripts, users can customize how messages are
delivered, e.g. whether they are forwarded or stored in special
folders. Unwanted messages can be discarded or rejected, and, when the
user is not available, the Sieve interpreter can send an automated
reply. Above all, the Sieve language is meant to be simple, extensible
and system independent. And, unlike most other mail filtering script
languages, it does not allow users to execute arbitrary programs. This
is particularly useful to prevent virtual users from having full access
to the mail store. The intention of the language is to make it
impossible for users to do anything more complex (and dangerous) than
write simple mail filters.
Using the ManageSieve protocol, users can upload their Sieve scripts
remotely, without needing direct filesystem access through FTP or SCP.
Additionally, a ManageSieve server always makes sure that uploaded
scripts are valid, preventing compile failures at mail delivery.
The Pigeonhole project provides the following items:
o The LDA Sieve plugin for Dovecot's Local Delivery Agent (LDA)
(dovecot-lda(1)) that facilitates the actual Sieve filtering upon
o The ManageSieve Service that implements the ManageSieve protocol
through which users can remotely manage Sieve scripts on the
o Command line tools that provide the means to manually compile,
analyse and test Sieve scripts.
The functionality and configuration of the LDA Sieve plugin and the
ManageSieve service is described in detail in the README and INSTALL
files contained in the Pigeonhole package and in the Dovecot Wiki
The following command line tools are available:
Compiles Sieve scripts into a binary representation for later
The universal Sieve test tool for testing the effect of a Sieve
script on a particular message.
Dumps the content of a Sieve binary file for (development)
Report bugs, including doveconf -n output, to the Dovecot Mailing List
<email@example.com>. Information about reporting Dovecot and
Pigeonhole bugs is available at: http://dovecot.org/bugreport.html
Pigeonhole <http://pigeonhole.dovecot.org> and its manual pages were
written by the Pigeonhole authors
<http://pigeonhole.dovecot.org/doc/AUTHORS>, mainly Stephan Bosch
<stephan at rename-it.nl>, and are licensed under the terms of the
LGPLv2.1 license, which is the same license as Dovecot, see
<http://dovecot.org/doc/COPYING> for details.
dovecot(1), dovecot-lda(1), sieve-dump(1), sieve-test(1), sievec(1)
Dovecot v2.0 Wiki