This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.

Pigeonhole Sieve Interpreter

The Pigeonhole project provides Sieve support as a plugin for Dovecot's Local Delivery Agent (LDA) and also for its LMTP service. The plugin implements a Sieve interpreter, which filters incoming messages using a script specified in the Sieve language (RFC 5228). The Sieve script is provided by the user and, using that Sieve script, the user can customize how incoming messages are handled. Messages can be delivered to specific folders, forwarded, rejected, discarded, etc.

Configuration and Use

Supported Features

Sieve language has various extensions. You can find more information about the extensions from the Sieve Mail Filtering Language Charter or the wiki page.

Note that Sieve doesn't support running external programs.

The Pigeonhole Sieve interpreter recognizes the following Sieve extensions:

The following Dovecot-specific Sieve extensions are available for the Pigeonhole Sieve interpreter:

Please note that not all extensions are enabled by default, as shown in the table above. Deprecated extensions, extensions that add the ability to change messages, extensions that require explicit configuration and extensions that are still under development are not enabled without explicit configuration. This means that the sieve_extensions or sieve_global_extensions settings need to be adjusted accordingly. Also, for plugins it is not enough to add the plugin name to the sieve_plugins setting; the extensions introduced by the plugin also need to be enabled explicitly.

ManageSieve server

To give users the ability to upload their own Sieve scripts to your server, i.e. without the need for shell or FTP access, you can use the ManageSieve protocol. This is also provided by the Pigeonhole project. It is available as a separate Dovecot service. Its configuration and use is explained on the Pigeonhole ManageSieve page.

Pigeonhole/Sieve (last edited 2013-07-10 21:57:16 by klara)