dovecot-2.1-pigeonhole: Updated installation documentation for v...

[pigeonhole at rename-it.nl]

details:   http://hg.rename-it.nl/dovecot-2.1-pigeonhole/rev/0dc8453e07c4
changeset: 1666:0dc8453e07c4
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Wed Oct 17 22:11:16 2012 +0200
description:
Updated installation documentation for vnd.dovecot.duplicate extension.

diffstat:

 doc/extensions/vnd.dovecot.duplicate.txt |  28 +++++++++++++++-------------
 1 files changed, 15 insertions(+), 13 deletions(-)

diffs (53 lines):

diff -r c3b14a8784dc -r 0dc8453e07c4 doc/extensions/vnd.dovecot.duplicate.txt
--- a/doc/extensions/vnd.dovecot.duplicate.txt	Wed Oct 17 22:10:50 2012 +0200
+++ b/doc/extensions/vnd.dovecot.duplicate.txt	Wed Oct 17 22:11:16 2012 +0200
@@ -8,13 +8,11 @@
 Description
 ===========
 
-Sieve (RFC 5228) is a highly extensible machine language specifically tailored
-for internet message filtering. For the Dovecot Secure IMAP server, Sieve
-support is provided by the Pigeonhole Sieve plugin. The vnd.dovecot.duplicate
-extension augments the Sieve filtering implementation with a test to verify
-whether a message was received earlier already based on its Message-ID. This can
-be used to prevent duplicate deliveries, e.g. caused by mailinglists when people
-reply both to the mailinglist and the user directly.
+The vnd.dovecot.duplicate extension augments the Sieve filtering implementation
+with a test to verify whether the evaluated string value was seen before in an
+earlier execution of the Sieve script. The main application for this new test is
+detecting and handling duplicate message deliveries, e.g. as caused by
+mailinglists when people reply both to the mailinglist and the user directly.
 
 This extension is specific to the Pigeonhole Sieve implementation for the
 Dovecot Secure IMAP server. It will therefore most likely not be supported by
@@ -35,14 +33,17 @@
 =============
 
 The "vnd.dovecot.duplicate" extension is not enabled by default and thus it
-needs to be enabled explicitly.
+needs to be enabled explicitly by adding it to the `sieve_extensions' or the
+`sieve_global_extensions' setting. 
 
 The following configuration settings are used:
 
-sieve_duplicate_period = 1d
-  This option specifies after what period of time Message-IDs are purged from
-  the duplicate database. The period is specified in s(econds), unless followed
-  by a d(ay), h(our) or m(inute) specifier character.
+sieve_duplicate_default_period = 12h
+sieve_duplicate_max_period = 2d
+  These options respectively specify the default and the maximum value for the
+  period after which tracked values are purged from the duplicate tracking
+  database. The period is specified in s(econds), unless followed by a d(ay),
+  h(our) or m(inute) specifier character.
 
 Example
 =======
@@ -52,5 +53,6 @@
 
   sieve_extensions = +vnd.dovecot.duplicate
 
-  sieve_duplicate_period = 6h
+  sieve_duplicate_default_period = 1h
+	sieve_duplicate_max_period = 1d
 }