Merge pull request #101 from PajamaSoft/roundcube_managesieve

Roundcube managesieve plugin and automatic folder creation

roles/mailserver/files/etc_dovecot_conf.d_20-imap.conf

@@ -13,7 +13,7 @@ protocol imap {
   #mail_max_userip_connections = 10
 
   # Space separated list of plugins to load (default is global mail_plugins).
-  mail_plugins = $mail_plugins antispam fts fts_solr
+  mail_plugins = $mail_plugins antispam fts fts_solr autocreate
 
   # IMAP logout format string:
   #  %i - total number of bytes read from client

roles/mailserver/files/etc_dovecot_conf.d_90-plugin.conf

@@ -23,4 +23,16 @@ plugin {
   # FTS (full text search with Solr)
   fts = solr
   fts_solr = break-imap-search url=http://localhost:8080/solr/
+  
+  # Autocreate (specify mailboxes that must always exist for all users)
+  autocreate = Drafts
+  autocreate2 = Sent
+  autocreate3 = Junk
+  autocreate4 = Trash
+  autocreate5 = Archive
+  autosubscribe = Drafts
+  autosubscribe2 = Sent
+  autosubscribe3 = Junk
+  autosubscribe4 = Trash
+  autosubscribe5 = Archive
 }

roles/mailserver/files/etc_dovecot_dovecot.conf

@@ -96,4 +96,4 @@ dict {
 # A config file can also tried to be included without giving an error if
 # it's not found:
 !include_try /usr/share/dovecot/protocols.d/*.protocol
-protocols = imap lmtp
+protocols = imap lmtp sieve

roles/mailserver/files/etc_postfix_master.cf

@@ -128,4 +128,4 @@ mailman   unix  -       n       n       -       -       pipe
 dspam     unix  -       n       n       -       10      pipe
   flags=Ru user=dspam argv=/usr/bin/dspam --deliver=innocent,spam --user $recipient -i -f $sender -- $recipient
 dovecot   unix  -       n       n       -       -       pipe
-  flags=DRhu user=vmail:vmail argv=/usr/lib/dovecot/deliver -f ${sender} -d ${recipient}
+  flags=DRhu user=vmail:vmail argv=/usr/lib/dovecot/dovecot-lda -f ${sender} -d ${recipient}

roles/mailserver/tasks/dovecot.yml

@@ -6,6 +6,7 @@
     - mysql-server
     - dovecot-mysql
     - dovecot-lmtpd
+    - dovecot-managesieved
 
 - name: Create vmail group
   group: name=vmail state=present gid=5000

roles/mailserver/templates/etc_dovecot_conf.d_15-lda.conf.j2

@@ -44,5 +44,5 @@ hostname = {{ mail_server_hostname }}
 
 protocol lda {
   # Space separated list of plugins to load (default is global mail_plugins).
-  #mail_plugins = $mail_plugins
+  mail_plugins = $mail_plugins sieve
 }

roles/mailserver/templates/etc_postfix_main.cf.j2

@@ -82,7 +82,8 @@ recipient_delimiter = +
 inet_interfaces = all
 
 # dovecot mysql
-virtual_transport = lmtp:unix:private/dovecot-lmtp
+virtual_transport = dovecot
+dovecot_destination_recipient_limit = 1
 virtual_mailbox_domains = mysql:/etc/postfix/mysql-virtual-mailbox-domains.cf
 virtual_mailbox_maps = mysql:/etc/postfix/mysql-virtual-mailbox-maps.cf
 virtual_alias_maps = mysql:/etc/postfix/mysql-virtual-alias-maps.cf

roles/webmail/files/etc_roundcube_main.inc.php

@@ -190,7 +190,7 @@ $rcmail_config['message_cache_lifetime'] = '10d';
 // enforce connections over https
 // with this option enabled, all non-secure connections will be redirected.
 // set the port for the ssl connection as value of this option if it differs from the default 443
-$rcmail_config['force_https'] = false;
+$rcmail_config['force_https'] = true;
 
 // tell PHP that it should work as under secure connection
 // even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set)
@@ -362,7 +362,7 @@ $rcmail_config['email_dns_check'] = false;
 // ----------------------------------
 
 // List of active plugins (in plugins/ directory)
-$rcmail_config['plugins'] = array();
+$rcmail_config['plugins'] = array('managesieve');
 
 // ----------------------------------
 // USER INTERFACE

roles/webmail/files/usr_share_roundcube_plugins_managesieve_config.inc.php

@@ -0,0 +1,67 @@
+<?php
+
+// managesieve server port
+$rcmail_config['managesieve_port'] = 4190;
+
+// managesieve server address, default is localhost.
+// Replacement variables supported in host name:
+// %h - user's IMAP hostname
+// %n - http hostname ($_SERVER['SERVER_NAME'])
+// %d - domain (http hostname without the first part)
+// For example %n = mail.domain.tld, %d = domain.tld
+$rcmail_config['managesieve_host'] = 'localhost';
+
+// authentication method. Can be CRAM-MD5, DIGEST-MD5, PLAIN, LOGIN, EXTERNAL
+// or none. Optional, defaults to best method supported by server.
+$rcmail_config['managesieve_auth_type'] = null;
+
+// Optional managesieve authentication identifier to be used as authorization proxy.
+// Authenticate as a different user but act on behalf of the logged in user.
+// Works with PLAIN and DIGEST-MD5 auth.
+$rcmail_config['managesieve_auth_cid'] = null;
+
+// Optional managesieve authentication password to be used for imap_auth_cid
+$rcmail_config['managesieve_auth_pw'] = null;
+
+// use or not TLS for managesieve server connection
+// it's because I've problems with TLS and dovecot's managesieve plugin
+// and it's not needed on localhost
+$rcmail_config['managesieve_usetls'] = false;
+
+// default contents of filters script (eg. default spam filter)
+$rcmail_config['managesieve_default'] = '/etc/dovecot/sieve/global';
+
+// The name of the script which will be used when there's no user script
+$rcmail_config['managesieve_script_name'] = 'managesieve';
+
+// Sieve RFC says that we should use UTF-8 endcoding for mailbox names,
+// but some implementations does not covert UTF-8 to modified UTF-7.
+// Defaults to UTF7-IMAP
+$rcmail_config['managesieve_mbox_encoding'] = 'UTF-8';
+
+// I need this because my dovecot (with listescape plugin) uses
+// ':' delimiter, but creates folders with dot delimiter
+$rcmail_config['managesieve_replace_delimiter'] = '';
+
+// disabled sieve extensions (body, copy, date, editheader, encoded-character,
+// envelope, environment, ereject, fileinto, ihave, imap4flags, index,
+// mailbox, mboxmetadata, regex, reject, relational, servermetadata,
+// spamtest, spamtestplus, subaddress, vacation, variables, virustest, etc.
+// Note: not all extensions are implemented
+$rcmail_config['managesieve_disabled_extensions'] = array();
+
+// Enables debugging of conversation with sieve server. Logs it into <log_dir>/sieve
+$rcmail_config['managesieve_debug'] = false;
+
+// Enables features described in http://wiki.kolab.org/KEP:14
+$rcmail_config['managesieve_kolab_master'] = false;
+
+// Script name extension used for scripts including. Dovecot uses '.sieve',
+// Cyrus uses '.siv'. Doesn't matter if you have managesieve_kolab_master disabled.
+$rcmail_config['managesieve_filename_extension'] = '.sieve';
+
+// List of reserved script names (without extension).
+// Scripts listed here will be not presented to the user.
+$rcmail_config['managesieve_filename_exceptions'] = array();
+
+?>

roles/webmail/tasks/roundcube.yml

@@ -1,5 +1,8 @@
 - name: Install Roundcube
-  apt: pkg=roundcube state=latest
+  apt: pkg=$item state=latest
+  with_items:
+    - roundcube
+    - roundcube-plugins
 
 - name: Configure the Apache HTTP server for roundcube
   template: src=etc_apache2_sites-available_roundcube.j2 dest=/etc/apache2/sites-available/roundcube group=www-data owner=www-data force=yes
@@ -7,6 +10,9 @@
 - name: Configure roundcube
   copy: src=etc_roundcube_main.inc.php dest=/etc/roundcube/main.inc.php group=www-data owner=root mode=640 force=yes
 
+- name: Configure roundcube's managesieve plugin
+  copy: src=usr_share_roundcube_plugins_managesieve_config.inc.php dest=/usr/share/roundcube/plugins/managesieve/config.inc.php group=www-data owner=root mode=640 force=yes
+
 - name: Enable roundcube site
   command: a2ensite roundcube creates=/etc/apache2/sites-enabled/roundcube
   notify: restart apache