Skip to content
Snippets Groups Projects
Commit 7358244b authored by Stephan Bosch's avatar Stephan Bosch
Browse files

Updated documentation for upcoming release.

parent cf7807b2
No related merge requests found
......@@ -39,7 +39,7 @@ Pigeonhole build:
external plugins. The default is not to install development headers.
--with-unfinished-features=no
Controls whether unfinished features and extensions are built. Enabling this
Controls whether unfinished features and extensions are built. Enabling this
will enable the compilation of code that is considered unfinished and highly
experimental and may therefore introduce bugs and unexpected behavior.
In fact, it may not compile at all. Enable this only when you are eager to
......@@ -57,7 +57,7 @@ Configuration
The Pigeonhole package provides the following items:
- The LDA Sieve plugin for Dovecot's Local Delivery Agent (LDA): This
facilitates the actual Sieve filtering upon delivery.
facilitates the actual Sieve filtering upon delivery.
- The ManageSieve Service: This implements the ManageSieve protocol through
which users can remotely manage Sieve scripts on the server.
......@@ -121,21 +121,21 @@ For example:
plugin {
...
# The location of the user's active script:
sieve = ~/.dovecot.sieve
# The location of the user's active script:
sieve = ~/.dovecot.sieve
# If the user has no personal active script (i.e. if the file
# indicated in sieve= does not exist), use this one:
sieve_global_path = /var/lib/dovecot/sieve/default.sieve
# If the user has no personal active script (i.e. if the file
# indicated in sieve= does not exist), use this one:
sieve_global_path = /var/lib/dovecot/sieve/default.sieve
# The include extension fetches the :personal scripts from this
# directory. When ManageSieve is used, this is also where scripts
# are uploaded.
sieve_dir = ~/sieve
# The include extension fetches the :personal scripts from this
# directory. When ManageSieve is used, this is also where scripts
# are uploaded.
sieve_dir = ~/sieve
# The include extension fetches the :global scripts from this
# directory.
sieve_global_dir = /var/lib/dovecot/sieve/global/
# The include extension fetches the :global scripts from this
# directory.
sieve_global_dir = /var/lib/dovecot/sieve/global/
}
LDA Sieve Plugin - Configurable Limits
......@@ -158,9 +158,9 @@ A value of 0 for these settings means that the limit is not enforced.
LDA Sieve Plugin - Per-user Sieve script location
-------------------------------------------------
By default, the Pigeonhole LDA Sieve plugin looks for the user's Sieve script file
in the user's home directory (~/.dovecot.sieve). This requires that the home
directory is set for the user.
By default, the Pigeonhole LDA Sieve plugin looks for the user's Sieve script
file in the user's home directory (~/.dovecot.sieve). This requires that the
home directory is set for the user.
If you want to store the script elsewhere, you can override the default using
the sieve setting, which specifies the path to the user's script file. This can
......@@ -209,16 +209,16 @@ sieve_after =
The script execution ends when the currently executing script in the sequence
does not yield a "keep" result: when the script terminates, the next script is
only executed if an implicit or explicit "keep" is in effect. Thus, to end all
script execution, a script must not execute keep and it must cancel the
implicit keep, e.g. by executing "discard; stop;". This means that the command
"keep;" has different semantics when used in a sequence of scripts. For normal
Sieve execution, "keep;" is equivalent to "fileinto "INBOX";", because both
cause the message to be stored in INBOX. However, in sequential script
execution, it only controls whether the next script is executed. Storing the
message into INBOX (the default folder) is not done until the last script in
the sequence executes (implicit) keep. To force storing the message into INBOX
earlier in the sequence, the fileinto command can be used (with ":copy" or
together with "keep;").
script execution, a script must not execute keep and it must cancel the implicit
keep, e.g. by executing "discard; stop;". This means that the command "keep;"
has different semantics when used in a sequence of scripts. For normal Sieve
execution, "keep;" is equivalent to "fileinto "INBOX";", because both cause the
message to be stored in INBOX. However, in sequential script execution, it only
controls whether the next script is executed. Storing the message into INBOX
(the default folder) is not done until the last script in the sequence executes
(implicit) keep. To force storing the message into INBOX earlier in the
sequence, the fileinto command can be used (with ":copy" or together with
"keep;").
Apart from the keep action, all actions triggered in a script in the sequence
are executed before continuing to the next script. This means that when a script
......@@ -378,8 +378,8 @@ A storage location specified by 'sieve_dir' is always generated automatically if
it does not exist (as far as the system permits the user to do so; no root
privileges are used). This is similar to the behavior of the mail daemons.
The following provides an example configuration for Sieve and ManageSieve.
Only sections and settings relevant to ManageSieve are shown. Refer to
The following provides an example configuration for Sieve and ManageSieve. Only
sections and settings relevant to ManageSieve are shown. Refer to
20-managesieve.conf in the doc/example-config/conf.d directory for a full
example with comments, but don't forget to configure Sieve and add sieve to the
'protocols = ...' setting if you use it.
......
This diff is collapsed.
......@@ -7,13 +7,13 @@ Introduction
This package is part of the Pigeonhole project (http://pigeonhole.dovecot.org).
It adds support for the Sieve language (RFC 5228) and the ManageSieve protocol
(RFC 5804) to the Dovecot Secure IMAP Server. 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.
(RFC 5804) to the Dovecot Secure IMAP Server. 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.
......@@ -23,18 +23,18 @@ 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.
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.
ManageSieve server always makes sure that uploaded scripts are valid, preventing
compile failures at mail delivery.
This package provides Sieve support as a plugin to Dovecot's Local Delivery
Agent (LDA). The ManageSieve protocol is provided is an additional service,
next to Dovecot's own POP3 and IMAP services.
Agent (LDA). The ManageSieve protocol is provided is an additional service, next
to Dovecot's own POP3 and IMAP services.
Features
========
......@@ -120,8 +120,8 @@ following list outlines the implementation status of each supported extension:
plugin.
mailbox (RFC 5490; page 2): fully supported (v0.1.10+), but ACL permissions
are not verified for mailboxexists.
include (draft v05): almost fully supported, but interaction with ManageSieve
is not in accordance with specification.
include (draft v05): almost fully supported, but interaction with
ManageSieve is not in accordance with specification.
regex (draft v08; not latest ietf version): almost fully supported, but
UTF-8 is not supported.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.