README
author Stephan Bosch <stephan@rename-it.nl>
Thu May 19 23:42:37 2011 +0200 (12 months ago)
changeset 224 78d4860e22ce
parent 198 27b2d0dbabc8
permissions -rw-r--r--
Added signature for changeset a71f8b4a4287
     1 ManageSieve implementation for Dovecot v1.2
     2 
     3 For the most up-to-date information you are referred to the Dovecot wiki:
     4 
     5 http://wiki.dovecot.org/ManageSieve
     6 
     7 Introduction
     8 ------------
     9 
    10 By writing Sieve scripts, users can customize how messages are delivered, e.g.
    11 whether they are forwarded or stored in special folders. The Sieve language is
    12 meant to be simple, extensible and system independent. And, unlike most other
    13 mail filtering script languages, it does not allow users to execute arbitrary
    14 programs. This is particularly useful to prevent virtual users from having
    15 full access to the mail store. The intention of the language is to make it 
    16 impossible for users to do anything more complex (and dangerous) than write 
    17 simple mail filters.
    18 
    19 The ManageSieve service is used to manage a user's Sieve script collection. It 
    20 has the following advantages over doing it directly via filesystem:
    21 
    22   * No need to let users log in via FTP/SFTP/etc, which could be difficult 
    23     especially with virtual users.
    24   * ManageSieve is a standard protocol (although still a draft), so users can 
    25     manage their scripts using (hopefully) user-friendly ManageSieve clients. 
    26     Many webmails already include a ManageSieve client.
    27   * Scripts are compiled before they are installed, which guarantees that the
    28     uploaded script is valid. This prevents a user from inadvertently 
    29     installing a broken Sieve script. 
    30 
    31 For Dovecot, ManageSieve support is provided in this separate package. This 
    32 implementation is part of the Pigeonhole project 
    33 (http://pigeonhole.dovecot.org). 
    34 
    35 Compiling and Configuring
    36 -------------------------
    37 
    38 Refer to INSTALL file.
    39  
    40 Known Issues
    41 ------------
    42 
    43 * Although this ManageSieve server should comply with the draft specification of 
    44   the ManageSieve protocol, quite a few clients don't. This is particularly true 
    45   for the TLS support. However, now that Cyrus' Timsieved has changed its 
    46   behavior towards protocol compliance, all those clients will follow 
    47   eventually. 
    48 
    49   Clients known to have TLS issues:
    50 	- Thunderbird Sieve add-on: fixed as per version 0.1.5
    51 	- AvelSieve: patch on the wiki:	http://wiki.dovecot.org/ManageSieve
    52 	- KMail + kio_sieve: TLS broken for old versions. This issue is fixed at 
    53 	  least in kmail 1.9.9 / kde 3.5.9. 
    54 
    55   Unfortunately, there is no reliable way to provide a workaround for this
    56   problem. We will have to wait for the authors of these clients to make the
    57   proper adjustments. 
    58   
    59 * Other client issues:
    60 
    61 	- SmartSieve, WebSieve: 
    62 	  These clients are specifically written for Cyrus timsieved and fail on 
    63 	  multiple stages of the protocol when connected to Dovecot ManageSieve.
    64 	    
    65 * The ANONYMOUS authentication mechanism is currently not supported and 
    66   explicitly denied. 
    67 
    68 Contact Info
    69 ------------
    70 
    71 Stephan Bosch <stephan at rename-it dot nl>
    72 IRC: Freenode, #dovecot, S[r]us
    73 Web: http://pigeonhole.dovecot.org
    74 
    75 Please use the Dovecot mailing list <dovecot at dovecot.org> for questions about 
    76 this package. You can post to the list without subscribing, the mail then waits 
    77 in a moderator queue for a while. See http://dovecot.org/mailinglists.html
    78