Differences

This shows you the differences between two versions of the page.

--- start:howto:dovecot_plus_database_quota [2012/01/09 15:15]
aseques
+++ start:howto:dovecot_plus_database_quota [2013/06/21 07:36] (current)
aseques removed the subdomain part since it didn't work and isn't of much interest
@@ Line 1: / Line 1: @@
-**__ALERT: This document is currently being rewritten, only experienced people should use this__**
+===== Email modifications from default imscp install =====
-===== Dovecot modifications from default imscp install =====
 This is an improved version from the original article in ispcp (http://isp-control.net/documentation/howto:mail:replace_courier_with_dovecot)
-All the parts related to the default install where removed since imscp already takes care of that, and it's focused to add the functionality that is available only on dovecot (instead of courier).
+The default install suits most of the needs, so this document is focused to add some functionality that is available only on dovecot (not always in courier).
+The required dovecot version is now 1.2 (squeeze's default) or newer.
-===== Changes from standard dovecot in imscp =====
+==== Changes from standard mail setup in imscp ====
-  * Quotas are stored on database so they can be shown from the control panel
+  * Alias can be used as a full mail domains
-  * Required dovecot version is now 1.2 (squeeze's default)
+  * Global sieve filtering (already enabled by default but without config)
-  * Filtering is enabled by default (to archive spam)
-===== Reasons to use dovecot =====
+==== Reasons to use dovecot ====
   * You can do server-side filtering with sieve (for example saving spam to junk folder)
@@ Line 18: / Line 16: @@
   * You can block users after they are exceeding their quotas.
   * Dovecot is really fast and reliable
+  * Warning users that are overquota
 Please report any bugs/hints/whatever in the following board thread:
 http://forum.i-mscp.net/showthread.php?tid=61
+==== Replace Courier with Dovecot ====
-**NOTE:** There are currently no means to configure the quota for imscp other than fiddling with the database. The functionality from http://www.isp-control.net/forum/thread-8483.html should be imported.
+You can do it by re-running the installer and changing the default imap server when asked you can choose between courier or dovecot.
-**NOTE:** If you want to edit the quota directly; it is stored in bytes in the table "mail_users" in a field named "quota".
+===== Global sieve filtering =====
-===== Replace Courier with Dovecot =====
+Dovecot will look for the global sieve script located in /etc/dovecot/sieve/dovecot.sieve, it can be edited to suit your needs with more functionality.
+In the sample below, it moves all the mails tagged as spam to the Junk folder of the mail user:
-You can do it by re-running the installer and changing the default imap server when asked you can choose between courier or dovecot.
+<code>require "fileinto";
+if exists "X-Spam-Flag" {
+	if header :contains "X-Spam-Flag" "YES" {
+       	fileinto "INBOX.Junk";
+	stop;
+	}
+}</code>
-===== Optional features =====
+More info about sieve syntax and usage: http://wiki.dovecot.org/LDA/Sieve
-==== Sieve filtering ====
+===== Use domain alias as a mail alias =====
-Create the sieve script to redirect spam to junk folder
+By doing a small change in postfix configuration, we can use the domain alias as a mail ailas.
-**/etc/dovecot/sieve/dovecot.sieve**
+Being example2.com an alias of example1.com, whenever we create a mailbox in example1.com the same mailbox in example2.com becomes a redirection.
-If you have a spam filter such as amavis, it will add the header "X-Spam-Flag = yes", with this little sieve script all this mail will go to Junk folder (can be seen both in webmail or any IMAP client). It's really usefull because all the users can check their own spam without the need of the server admin.
+So creating [email protected] will also receive the mail from [email protected] automatically. That can be used when a customer don't want the hassle of managing two mail domain (and having to set manually every mail address two times).
-  mkdir /etc/dovecot/sieve
-  chown -R vmail:mail /etc/dovecot/sieve/
-  touch /etc/dovecot/sieve/dovecot.sieve
-  require "fileinto";
+==== The changes we have to do in postfix ====
-    if exists "X-Spam-Flag" {
-            if header :contains "X-Spam-Flag" "NO" {
-            } else {
-            fileinto "INBOX.Junk";
-            stop;
-            }
-    }
+In the file main.cf (proposed changes are for the template), from:
+  virtual_mailbox_domains = hash:{MTA_VIRTUAL_DMN_HASH}
+  virtual_alias_maps           = hash:{MTA_VIRTUAL_ALIAS_HASH}
-Set correct permissions for dovecot.conf (the deliver command will access this file too)
+To:
+  #virtual_mailbox_domains = hash:{MTA_VIRTUAL_DMN_HASH}
+  virtual_mailbox_domains      = mysql:/etc/postfix/mysql_virtual_domains.cf
+  #virtual_alias_maps           = hash:{MTA_VIRTUAL_ALIAS_HASH}
+  virtual_alias_maps           = hash:{MTA_VIRTUAL_ALIAS_HASH}, mysql:/etc/postfix/mysql_virtual_forwards.cf
-  chmod 0644 /etc/dovecot/dovecot.conf
-==== Use domain alias as mail alias too ====
-Making a small change in postfix configuration, we can use the domain alias as a mail ailas.
-Being example2.com an alias of example1.com, whenever I create a mailbox in example1.com the same mailbox in example2.com becomes a redirection.
-So creating [email protected] will also receive the mail from [email protected] automatically.
 /etc/postfix/mysql_virtual_domains.cf
 <code>
-user = ispcp_dovecot
+user = DATABASE_USER
-password = PASS_MAILRW
+password = DATABASE_PASSWORD
 hosts = 127.0.0.1
-dbname = ispcp
+dbname = DATABASE_NAME
 query = (SELECT domain_name FROM domain_aliasses
                 INNER JOIN domain  ON domain_aliasses.domain_id=domain.domain_id
                 WHERE domain.domain_status='ok'
+                        AND domain_aliasses.alias_status='ok'
                         AND domain.domain_mailacc_limit > '-1'
                         AND domain_aliasses.alias_name='%s')
@@ Line 83: / Line 85: @@
 /etc/postfix/mysql_virtual_forwards.cf
 <code>
-user = ispcp_dovecot
+user = DATABASE_USER
-password = PASS_MAILRW
+password = DATABASE_PASSWORD
 hosts = 127.0.0.1
-dbname = ispcp
+dbname = DATABASE_NAME
 query =
         SELECT DISTINCT CONCAT(CONCAT(mail_users.mail_acc, "@"), domain.domain_name) from mail_users
@@ Line 94: / Line 96: @@
 </code>
-==== Automatically alert user if his quota exceeds a critical limit ====
+If you want the domains alias to be able to receive mail:
-You can configure Dovecot to execute an external command if an user's quota exceeds a specified limit. In this example the user receives alert emails if his quota exceeds 80% / 95% percent.
+**/etc/dovecot/dovecot-sql-aliasdomain.conf**
+with the following content:\\
+(In the sql for user_query there are uids and gids 'hardcoded'. The uid must be the uid of vmail user and gid the gid of the mail group. Maybe you have to change the defaults (1001/8))
-Append the following in your plugin section in **/etc/dovecot/dovecot.conf**:
-  quota_warning = storage=95%% /usr/local/bin/dovecot-quota-warning.sh 95
-  quota_warning2 = storage=80%% /usr/local/bin/dovecot-quota-warning.sh 80
-If the user's quota reaches the limit the external script dovecot-quota-warning.sh is run. If you define quota warnings make sure that you start with the highest limit because Dovecot only runs the command for the first limit that is exceeded.
-Create **/usr/local/bin/dovecot-quota-warning.sh**
 <code>
-#!/bin/sh
+driver = mysql
-PERCENT=$1
+connect = host=localhost dbname=imscp user=imscp_dovecot password=PASS_MAILRW
-cat << EOF | /usr/lib/dovecot/deliver -d $USER -c /etc/dovecot/dovecot-no-quota-warning.conf
+user_query = SELECT concat('/var/mail/virtual/', domain_aliasses.alias_name, '/',mail_acc) as home, '1001' as uid, '8' as gid FROM (mail_users INNER JOIN domain_aliasses ON mail_users.sub_id = domain_aliasses.alias_id) INNER JOIN domain ON mail_users.domain_id = domain.domain_id WHERE mail_acc='%n' and domain_aliasses.alias_name ='%d';
-From: postmaster@yourdomain.tld
-To: $USER
-Subject: quota warning
-Content-Type: text/plain; charset="UTF-8"
-Attention! The emails in your mailbox are using more than $PERCENT% of your total mail space.
-EOF
 </code>
-Create **/etc/dovecot/dovecot-no-quota-warning.conf** \\
+You have to add in dovecot.conf (section "auth default"):
-This is basically the same file as dovecot.conf but the quota rules are stripped out in order to avoid looping. You can strip the quota lines manually or let it grep do for you:
+  userdb sql {
-  grep -v "quota" dovecot.conf > dovecot-no-quota-warning.conf
+    args = /etc/dovecot/dovecot-sql-subdomain.conf
+  }
+  userdb sql {
+    args = /etc/dovecot/dovecot-sql-aliasdomain.conf
+  }
-At last set correct permissions to dovecot-no-quota-warning.conf
+===== Deprecated documentation (pending to be purged) =====
-  chmod 0644 /etc/dovecot/dovecot-no-quota-warning.conf
-For more information about this have a look at http://wiki.dovecot.org/Quota/1.1
+**NOTE:** In the SQL query for user_query there are uids and gids 'hardcoded'. The uid must be the uid of your vmail user and gid the gid of the mail group. Maybe you have to change the defaults (1001/8))
-===== Frequent issues =====
 ==== Adapt postfix master.cf ====
@@ Line 148: / Line 139: @@
     flags=DROhu user=vmail:mail argv=/usr/libexec/dovecot/deliver -f ${sender} -d ${recipient}
-===== Older documentation (pending to be purged) =====
-**NOTE:** In the SQL query for user_query there are uids and gids 'hardcoded'. The uid must be the uid of your vmail user and gid the gid of the mail group. Maybe you have to change the defaults (1001/8))
-=== Configure Dovecot ===
-If you want the subdomains to be able to receive mail:
-**/etc/dovecot/dovecot-sql-subdomain.conf**
-with the following content:\\
-(In the sql for user_query there are uids and gids 'hardcoded'. The uid must be the uid of vmail user and gid the gid of the mail group. Maybe you have to change the defaults (1001/8))
-<code>
-driver = mysql
-connect = host=localhost dbname=ispcp user=ispcp_dovecot password=PASS_MAILRW
-user_query = SELECT CONCAT('/var/mail/virtual/', subdomain.subdomain_name, ".", domain.domain_name, '/',mail_acc) AS home, '1001' AS uid, '8' AS gid FROM (mail_users INNER JOIN subdomain ON mail_users.sub_id = subdomain.subdomain_id) INNER JOIN domain ON mail_users.domain_id = domain.domain_id WHERE mail_acc='%n' and concat(subdomain.subdomain_name,".",domain.domain_name)='%d';
-</code>
-If you want the domains alias to be able to receive mail:
-**/etc/dovecot/dovecot-sql-aliasdomain.conf**
-with the following content:\\
-(In the sql for user_query there are uids and gids 'hardcoded'. The uid must be the uid of vmail user and gid the gid of the mail group. Maybe you have to change the defaults (1001/8))
-<code>
-driver = mysql
-connect = host=localhost dbname=ispcp user=ispcp_dovecot password=PASS_MAILRW
-user_query = SELECT concat('/var/mail/virtual/', domain_aliasses.alias_name, '/',mail_acc) as home, '1001' as uid, '8' as gid FROM (mail_users INNER JOIN domain_aliasses ON mail_users.sub_id = domain_aliasses.alias_id) INNER JOIN domain ON mail_users.domain_id = domain.domain_id WHERE mail_acc='%n' and domain_aliasses.alias_name ='%d';
-</code>

i-MSCP Documentation

User Tools

Site Tools

Differences

Page Tools