^^&&^^

Edit File: Pigeonhole.Sieve.txt

Pigeonhole Sieve Interpreter
============================

The <Pigeonhole project> [Pigeonhole.txt] provides Sieve support as a plugin
for Dovecot's <Local Delivery Agent (LDA)> [LDA.txt] and also for its
<LMTP.txt> service. The plugin implements a Sieve [http://www.sieve.info]
interpreter, which filters incoming messages using a script specified in the
Sieve language (RFC 5228 [http://tools.ietf.org/html/rfc5228/]). 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
---------------------

* <Download and Installation> [Pigeonhole.Installation.txt]
 * <Sieve Interpreter Configuration> [Pigeonhole.Sieve.Configuration.txt]
 * <Sieve Usage Information> [Pigeonhole.Sieve.Usage.txt]
 * <Sieve Script Examples> [Pigeonhole.Sieve.Examples.txt]
 * <Sieve Interpreter Plugins> [Pigeonhole.Sieve.Plugins.txt]
 * <Sieve Troubleshooting> [Pigeonhole.Sieve.Troubleshooting.txt]

Supported Features
------------------

Sieve language has various <extensions> [Pigeonhole.Sieve.Extensions.txt]. You
can find more information about the extensions from the Sieve Mail Filtering
Language Charter [http://www.ietf.org/html.charters/sieve-charter.html] or the
Sieve.info wiki page [http://www.sieve.info/].

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:

*
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| *Extension*                                                                                                    | *Support Status*                           | *Default | *Purpose*                              |
|                                                                                                                |                                            | Enabled* |                                        |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.debug                                                                                              | supported (v0.3.0+)                        | no       | Allows logging debug messages          |
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-debug.txt]               |                                            |          |                                        |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.environment                                                                                        | supported (v0.4.14+)                       | no       | Extends the standard "environment"     |
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-dovecot-environment.txt] |                                            |          | extension with extra items and a       |
|                                                                                                                |                                            |          | variables namespace for direct access  |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.execute                                                                                            | <plugin>                                   | no       | Implements executing a pre-defined set |
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-extprograms.txt]         | [Pigeonhole.Sieve.Plugins.Extprograms.txt] |          | of external programs with the option to|
|                                                                                                                | (v0.3+)                                    |          | process string data through the        |
|                                                                                                                |                                            |          | external program                       |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.extdata                                                                                            | <plugin>                                   | no       | Allows a Sieve script to lookup        |
| [http://hg.rename-it.nl/pigeonhole-0.2-sieve-extdata/raw-file/tip/doc/rfc/spec-bosch-sieve-external-data.txt]  | [Pigeonhole.Sieve.Plugins.Extdata.txt]     |          | information from a datasource external |
|                                                                                                                |                                            |          | to the script                          |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.filter                                                                                             | <plugin>                                   | no       | Implements filtering messages through a|
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-extprograms.txt]         | [Pigeonhole.Sieve.Plugins.Extprograms.txt] |          | pre-defined set of external programs   |
|                                                                                                                | (v0.3+)                                    |          |                                        |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.pipe                                                                                               | <plugin>                                   | no       | Implements piping messages to a        |
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-extprograms.txt]         | [Pigeonhole.Sieve.Plugins.Pipe.txt] (v0.2),|          | pre-defined set of external programs   |
|                                                                                                                | <plugin>                                   |          |                                        |
|                                                                                                                | [Pigeonhole.Sieve.Plugins.Extprograms.txt] |          |                                        |
|                                                                                                                | (v0.3+)                                    |          |                                        |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+
| vnd.dovecot.report                                                                                             | supported (v0.4.14+)                       | no       | Implements sending Messaging Abuse     |
| [https://raw.githubusercontent.com/dovecot/pigeonhole/master/doc/rfc/spec-bosch-sieve-report.txt]              |                                            |          | Reporting Format (MARF) reports (RFC   |
|                                                                                                                |                                            |          | 5965                                   |
|                                                                                                                |                                            |          | [http://tools.ietf.org/html/rfc5965/]) |
+----------------------------------------------------------------------------------------------------------------+--------------------------------------------+----------+----------------------------------------+

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>
[Pigeonhole.Sieve.Configuration.txt]. This means that the 'sieve_extensions' or
'sieve_global_extensions' settings need to be adjusted accordingly. Also, for
<plugins> [Pigeonhole.Sieve.Plugins.txt] 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 Manage ''Sieve
protocol. This is also provided by the <Pigeonhole.txt> project. It is
available as a separate Dovecot service. Its configuration and use is explained
on the <Pigeonhole ManageSieve page> [Pigeonhole.ManageSieve.txt].

(This file was created from the wiki on 2018-02-28 04:42)