dovecot-2.0-pigeonhole: Revised documentation.
pigeonhole at rename-it.nl
pigeonhole at rename-it.nl
Sat Jan 7 17:29:30 EET 2012
details: http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/f7cee9f3c8a6
changeset: 1552:f7cee9f3c8a6
user: Stephan Bosch <stephan at rename-it.nl>
date: Sat Jan 07 16:22:20 2012 +0100
description:
Revised documentation.
diffstat:
doc/example-config/conf.d/20-managesieve.conf | 27 ++++----
doc/example-config/conf.d/90-sieve.conf | 50 +++++++++++-----
doc/include.txt | 8 +-
doc/spamtest-virustest.txt | 31 +++++-----
doc/vacation.txt | 94 +++++++++++++++----------------
5 files changed, 113 insertions(+), 97 deletions(-)
diffs (truncated from 358 to 300 lines):
diff -r cc6d38c3f87f -r f7cee9f3c8a6 doc/example-config/conf.d/20-managesieve.conf
--- a/doc/example-config/conf.d/20-managesieve.conf Sat Dec 17 18:58:48 2011 +0100
+++ b/doc/example-config/conf.d/20-managesieve.conf Sat Jan 07 16:22:20 2012 +0100
@@ -37,16 +37,17 @@
protocol sieve {
# Maximum ManageSieve command line length in bytes. ManageSieve usually does
- # not involve overly long command lines, so this setting will not normally need
- # adjustment
+ # not involve overly long command lines, so this setting will not normally
+ # need adjustment
#managesieve_max_line_length = 65536
- # Maximum number of ManageSieve connections allowed for a user from each IP address.
+ # Maximum number of ManageSieve connections allowed for a user from each IP
+ # address.
# NOTE: The username is compared case-sensitively.
#mail_max_userip_connections = 10
- # Space separated list of plugins to load (none known to be useful so far). Do NOT
- # try to load IMAP plugins here.
+ # Space separated list of plugins to load (none known to be useful so far).
+ # Do NOT try to load IMAP plugins here.
#mail_plugins =
# MANAGESIEVE logout format string:
@@ -54,20 +55,20 @@
# %o - total number of bytes sent to client
#managesieve_logout_format = bytes=%i/%o
- # To fool ManageSieve clients that are focused on CMU's timesieved you can specify
- # the IMPLEMENTATION capability that the dovecot reports to clients.
+ # To fool ManageSieve clients that are focused on CMU's timesieved you can
+ # specify the IMPLEMENTATION capability that Dovecot reports to clients.
# For example: 'Cyrus timsieved v2.2.13'
#managesieve_implementation_string = Dovecot Pigeonhole
- # Explicitly specify the SIEVE and NOTIFY capability reported by the server before
- # login. If left unassigned these will be reported dynamically according to what
- # the Sieve interpreter supports by default (after login this may differ depending
- # on the user).
+ # Explicitly specify the SIEVE and NOTIFY capability reported by the server
+ # before login. If left unassigned these will be reported dynamically
+ # according to what the Sieve interpreter supports by default (after login
+ # this may differ depending on the user).
#managesieve_sieve_capability =
#managesieve_notify_capability =
- # The maximum number of compile errors that are returned to the client upon script
- # upload or script verification.
+ # The maximum number of compile errors that are returned to the client upon
+ # script upload or script verification.
#managesieve_max_compile_errors = 5
# Refer to 90-sieve.conf for script quota configuration and configuration of
diff -r cc6d38c3f87f -r f7cee9f3c8a6 doc/example-config/conf.d/90-sieve.conf
--- a/doc/example-config/conf.d/90-sieve.conf Sat Dec 17 18:58:48 2011 +0100
+++ b/doc/example-config/conf.d/90-sieve.conf Sat Jan 07 16:22:20 2012 +0100
@@ -6,32 +6,52 @@
# by adding it to the respective mail_plugins= settings.
plugin {
- # The path to the user's main active script.
+ # The path to the user's main active script. If ManageSieve is used, this the
+ # location of the symbolic link controlled by ManageSieve.
sieve = ~/.dovecot.sieve
- # A path to a global sieve script file, which gets executed ONLY
- # if user's private Sieve script doesn't exist. Be sure to
- # pre-compile this script manually using the sievec command line
- # tool.
+ # The default Sieve script when the user has none. This is a path to a global
+ # sieve script file, which gets executed ONLY if user's private Sieve script
+ # doesn't exist. Be sure to pre-compile this script manually using the sievec
+ # command line tool.
+ # --> See sieve_before fore executing scripts before the user's personal
+ # script.
#sieve_global_path = /var/lib/dovecot/sieve/default.sieve
- # Directory for :personal include scripts for the include extension.
+ # Directory for :personal include scripts for the include extension. This
+ # is also where the ManageSieve service stores the user's scripts.
sieve_dir = ~/sieve
# Directory for :global include scripts for the include extension.
#sieve_global_dir =
- # Which Sieve language extensions are available to users. By default,
- # all supported extensions are available, except for deprecated
- # extensions or those that are still under development. Some system
- # administrators may want to disable certain Sieve extensions or
- # enable those that are not available by default. This setting can
- # use '+' and '-' to specify differences relative to the default.
- # For example `sieve_extensions = +imapflags' will enable the
- # deprecated imapflags extension in addition to all extensions
- # enabled by default.
+ # Path to a script file or a directory containing script files that need to be
+ # executed before the user's script. If the path points to a directory, all
+ # the Sieve scripts contained therein (with the proper .sieve extension) are
+ # executed. The order of execution is determined by the file names, using a
+ # normal 8bit per-character comparison.
+ #sieve_before =
+
+ # Identical to sieve_before, only the specified scripts are executed after the
+ # user's script (only when keep is still in effect!).
+ #sieve_after =
+
+ # Which Sieve language extensions are available to users. By default, all
+ # supported extensions are available, except for deprecated extensions or
+ # those that are still under development. Some system administrators may want
+ # to disable certain Sieve extensions or enable those that are not available
+ # by default. This setting can use '+' and '-' to specify differences relative
+ # to the default. For example `sieve_extensions = +imapflags' will enable the
+ # deprecated imapflags extension in addition to all extensions thatwere
+ # already enabled by default.
#sieve_extensions = +notify +imapflags
+ # The Pigeonhole Sieve interpreter can have plugins of its own. Using this
+ # setting, the used plugins can be specified. Check the Dovecot wiki
+ # (wiki2.dovecot.org) or the pigeonhole website
+ # (http://pigeonhole.dovecot.org) for available plugins.
+ #sieve_plugins =
+
# The separator that is expected between the :user and :detail
# address parts introduced by the subaddress extension. This may
# also be a sequence of characters (e.g. '--'). The current
diff -r cc6d38c3f87f -r f7cee9f3c8a6 doc/include.txt
--- a/doc/include.txt Sat Dec 17 18:58:48 2011 +0100
+++ b/doc/include.txt Sat Jan 07 16:22:20 2012 +0100
@@ -3,7 +3,7 @@
Relevant Specifications
=======================
-draft-ietf-sieve-include-05 - doc/rfc/draft-ietf-sieve-include-05.txt
+ draft-ietf-sieve-include-05 - doc/rfc/draft-ietf-sieve-include-05.txt
Description
===========
@@ -25,8 +25,8 @@
extension (default values are indicated):
sieve_include_max_includes = 255
- The maximum number of scripts that may be included. This is the total number
- of scripts involved in the include tree.
+ The maximum number of scripts that may be included. This is the total number
+ of scripts involved in the include tree.
sieve_include_max_nesting_depth = 10
- The maximum nesting depth for the include tree.
+ The maximum nesting depth for the include tree.
diff -r cc6d38c3f87f -r f7cee9f3c8a6 doc/spamtest-virustest.txt
--- a/doc/spamtest-virustest.txt Sat Dec 17 18:58:48 2011 +0100
+++ b/doc/spamtest-virustest.txt Sat Jan 07 16:22:20 2012 +0100
@@ -3,7 +3,7 @@
Relevant Specifications
=======================
- RFC5235 - doc/rfc/spamvirustest.rfc5235.txt
+ RFC5235 - doc/rfc/spamvirustest.rfc5235.txt
Description
===========
@@ -15,8 +15,8 @@
field value. They only need to know how to use the spamtest (spamtestplus) and
virustest extensions. This also gives GUI-based Sieve editors the means to
provide a portable and easy to install interface for spam and virus filter
-configuration. The burden of specifying which headers need to be checked and
-how the scanner output is represented falls onto the Sieve administrator.
+configuration. The burden of specifying which headers need to be checked and how
+the scanner output is represented falls onto the Sieve administrator.
Configuration
=============
@@ -37,14 +37,14 @@
sieve_spamtest_status_header = <header-field> [ ":" <regexp> ]
This specifies the header field that contains the result information of the
- spam scanner and it may express the syntax of the content of the header. If
- no matching header is found in the message, the spamtest command will match
+ spam scanner and it may express the syntax of the content of the header. If no
+ matching header is found in the message, the spamtest command will match
against "0".
This is a structured setting. The first part specifies the header field name.
- Optionally, a POSIX regular expression follows the header field name,
+ Optionally, a POSIX regular expression follows the header field name,
separated by a colon. Any whitespace directly following the colon is not part
- of the regular expression. If the regular expression is ommitted, any header
+ of the regular expression. If the regular expression is omitted, any header
content is accepted and the full header value is used. When a regular
expression is used, it must specify one match value (inside brackets) that
yields the desired spam scanner result. If the header does not match the
@@ -62,18 +62,17 @@
`sieve_spamtext_status_header' setting.
sieve_spamtest_text_valueX =
- When the `sieve_spamtest_status_type' setting is set to "text", these
- settings specify that the spamtest command will match against "X" when
- the specified string is equal to the text (extracted) from the status
- header. For spamtest, values of X between 0 and 10 are recognized, while
- virustest only uses values between 0 and 5.
+ When the `sieve_spamtest_status_type' setting is set to "text", these settings
+ specify that the spamtest command will match against "X" when the specified
+ string is equal to the text (extracted) from the status header. For spamtest,
+ values of X between 0 and 10 are recognized, while virustest only uses values
+ between 0 and 5.
Examples
========
-This section shows several configuration examples. Each example shows a
-specimen of valid virus/spam test headers that the given configuration will
-work on.
+This section shows several configuration examples. Each example shows a specimen
+of valid virus/spam test headers that the given configuration will work on.
Example 1
---------
@@ -129,7 +128,7 @@
sieve_spamtest_status_header = \
X-Spam-Score: score=(-?[[:digit:]]+\.[[:digit:]]).*
sieve_spamtest_max_header = \
- X-Spam-Score: score=-?[[:digit:]]+\.[[:digit:]] required=([[:digit:]]+\.[[:digit:]])
+ X-Spam-Score: score=-?[[:digit:]]+\.[[:digit:]] required=([[:digit:]]+\.[[:digit:]])
sieve_virustest_status_type = text
sieve_virustest_status_header = X-Virus-Scan: Found to be (.+)\.
diff -r cc6d38c3f87f -r f7cee9f3c8a6 doc/vacation.txt
--- a/doc/vacation.txt Sat Dec 17 18:58:48 2011 +0100
+++ b/doc/vacation.txt Sat Jan 07 16:22:20 2012 +0100
@@ -3,82 +3,78 @@
Relevant specifications
=======================
- RFC5230 - doc/rfc/vacation.rfc5230.txt
- RFC6131 - doc/rfc/vacation-seconds.rfc6131.txt
+ RFC5230 - doc/rfc/vacation.rfc5230.txt
+ RFC6131 - doc/rfc/vacation-seconds.rfc6131.txt
Description
===========
-The Sieve vacation extension [RFC5230] defines a mechanism to generate
-automatic replies to incoming email messages. It takes various
-precautions to make sure replies are only sent when appropriate. Script
-authors specify how often replies are sent to a particular contact.
-In the original vacation extension, this interval is specified in days
-with a minimum of one day. When more granularity is necessary and
-particularly when replies must be sent more frequently than one day,
-the vacation-seconds extension [RFC6131] can be used. This allows
-specifying the minimum reply interval in seconds with a minimum of zero
-(reply is then always sent), depending on administrator configuration.
+The Sieve vacation extension [RFC5230] defines a mechanism to generate automatic
+replies to incoming email messages. It takes various precautions to make sure
+replies are only sent when appropriate. Script authors specify how often replies
+are sent to a particular contact. In the original vacation extension, this
+interval is specified in days with a minimum of one day. When more granularity
+is necessary and particularly when replies must be sent more frequently than one
+day, the vacation-seconds extension [RFC6131] can be used. This allows
+specifying the minimum reply interval in seconds with a minimum of zero (reply
+is then always sent), depending on administrator configuration.
Configuration
=============
The vacation extension is available by default. In contrast, the
-vacation-seconds extension - which implies the vacation extension when
-used - is not available by default and needs to be enabled explicitly by
-adding it to the sieve_extensions setting. The configuration also needs
-to be adjusted accordingly to allow a non-reply period of less than a
-day.
+vacation-seconds extension - which implies the vacation extension when used - is
+not available by default and needs to be enabled explicitly by adding it to the
+sieve_extensions setting. The configuration also needs to be adjusted
+accordingly to allow a non-reply period of less than a day.
-The vacation and vacation-seconds extensions have their own specific
-settings. The settings that specify a period are specified in
-s(econds), unless followed by a d(ay), h(our) or m(inute) specifier
-character.
+The vacation and vacation-seconds extensions have their own specific settings.
+The settings that specify a period are specified in s(econds), unless followed
+by a d(ay), h(our) or m(inute) specifier character.
The following settings can be configured for the vacation extension (default
values are indicated):
sieve_vacation_min_period = 1d
- This specifies the minimum period that can be specified for the :days
- and :seconds tags of the vacation command. A minimum of 0 indicates that
- users are allowed to make the Sieve interpreter send a vacation response
- message for every incoming message that meets the other reply criteria
- (refer to RFC5230). A value of zero is however not recommended.
+ This specifies the minimum period that can be specified for the :days and
+ :seconds tags of the vacation command. A minimum of 0 indicates that users are
+ allowed to make the Sieve interpreter send a vacation response message for
+ every incoming message that meets the other reply criteria (refer to RFC5230).
+ A value of zero is however not recommended.
sieve_vacation_max_period = 0
More information about the dovecot-cvs
mailing list