Convert quota settings

Author: sirainen

data/settings.js

@@ -55,6 +55,7 @@ export const updates = {
 	process_title_imap_process: '2.4.0',
 	process_title_initializing: '2.4.0',
 	process_title_mail_processes: '2.4.0',
+	quota_maildir_backend_removed: '2.4.0',
 	service_auth_listener_type: '2.4.0',
 	service_dict_expire: '2.4.0',
 	service_listener_type: '2.4.0',

data/updates.js

@@ -393,7 +393,7 @@ other means:
 ```[dovecot.conf]
   fields {
     user = %{ldap:mailRoutingAddress}
-    quota_rule = *:storage=%{ldap:messageQuotaHard}
+    quota_storage_size = %{ldap:messageQuotaHard}B
   }
 ```
 :::
@@ -447,15 +447,15 @@ userdb ldap1 {
   result_success = continue-ok
   fields {
     class = %{ldap:userClass}
-    quota_rule = *:bytes=%{ldap:quotaBytes}
+    quota_storage_size = %{ldap:quotaBytes}B
   }
 }
 
 userdb ldap2 {
   driver = ldap
   skip = notfound
   fields {
-    quota_rule:default = *:bytes=%{ldap:classQuotaBytes}
+    quota_storage_size:default = %{ldap:classQuotaBytes}B
   }
 }
 ```
@@ -561,12 +561,12 @@ You can mix static text with the value returned from LDAP by using
 
 #### Examples
 
-Create a `quota_rule` field with value `*:bytes=<n>` where `<n>` comes
+Create a `quota_storage_size` field with value `<n>B` where `<n>` comes
 from "quotaBytes" LDAP attribute:
 
 ```
 fields {
-  quota_rule = *:bytes=%{ldap:quotaBytes}
+  quota_storage_size = %{ldap:quotaBytes}B
 }
 ```
 
@@ -584,7 +584,7 @@ create a "mail_path" field with value `/var/vmail/%d/%n/Maildir`:
 
 ```
 fields {
-    quota_rule = *:bytes=%{ldap:quotaBytes}
+    quota_storage_size = %{ldap:quotaBytes}B
     mail_path = /var/vmail/%d/%n/Maildir
 }
 ```

docs/core/config/auth/databases/ldap.md

@@ -120,7 +120,7 @@ These fields can be returned the exact same way as `uid`, `gid`, and `home`
 fields.
 
 It's also possible to override settings from `dovecot.conf`. For example the
-[[setting,mail_path]] and [[setting,quota_rule]] settings are commonly
+[[setting,mail_path]] and [[setting,quota_storage_size]] settings are commonly
 overridden to provide per-user mail path or quota limit.
 
 The extra fields are also passed to [[link,post_login_scripting]].
@@ -191,14 +191,12 @@ Import `name=value` to mail user event.
 
 ### Overriding Settings
 
-Most commonly settings are overridden from plugin section.
-
-For example if your plugin section has `quota_rule=*:storage=100M` value
-and the `userdb` lookup returns `quota_rule=*:storage=200M`, the original
+For example if you have `quota_storage_size=100M` in `doveconf.conf` and the
+`userdb` lookup returns `quota_storage_size=200M`, the original
 quota setting gets overridden. In fact, if the lookup always returns a
-`quota_rule` field, there's no point in having [[setting,quota_rule]] in
-the `dovecot.conf` plugin section at all, because it always gets overridden
-anyway.
+`quota_storage_size` field, there's no point in having
+[[setting,quota_storage_size]] in `dovecot.conf` at all, because it always gets
+overridden anyway.
 
 To understand how imap and pop3 processes see their settings, it may be
 helpful to know how Dovecot internally passes them:
@@ -230,7 +228,7 @@ The separator setting can be overridden by returning
 ::: code-group
 ```[dovecot.conf]
 userdb sql {
-  query = SELECT home, uid, gid, CONCAT('*:bytes=', quota_bytes) AS quota_rule, separator AS "namespace/default/separator" \
+  query = SELECT home, uid, gid, CONCAT(quota_bytes, 'B') AS quota_storage_size, separator AS "namespace/default/separator" \
     FROM users \
     WHERE username = '%n' and domain = '%d'
 }
@@ -247,7 +245,7 @@ userdb ldap {
     home       = %{ldap:homeDirectory}
     uid        = %{ldap:uidNumber}
     gid        = %{ldap:gidNumber}
-    quota_rule = *:bytes=%{ldap:quotaBytes}
+    quota_storage_size = %{ldap:quotaBytes}B
     namespace/default/separator = %{ldap:mailSeparator}
   }
 }
@@ -263,8 +261,8 @@ Note that all `userdb` extra fields must be prefixed with `userdb_`,
 otherwise they're treated as [[link,passdb_extra_fields]].
 
 ```
-user:{plain}pass:1000:1000::/home/user::userdb_mail_driver=mbox userdb_mail_path=~/mail userdb_quota_rule=*:storage=100M userdb_namespace/default/separator=/
-user2:{plain}pass2:1001:1001::/home/user2::userdb_mail_driver=maildir userdb_mail_path=~/Maildir userdb_quota_rule=*:storage=200M
+user:{plain}pass:1000:1000::/home/user::userdb_mail_driver=mbox userdb_mail_path=~/mail userdb_quota_storage_size=100M userdb_namespace/default/separator=/
+user2:{plain}pass2:1001:1001::/home/user2::userdb_mail_driver=maildir userdb_mail_path=~/Maildir userdb_quota_storage_size=200M
 ```
 
 ## See Also

docs/core/config/auth/userdb.md

@@ -3,6 +3,9 @@ layout: doc
 title: imapc
 dovecotlinks:
   imapc: imapc
+  imapc_quota:
+    hash: quota
+    text: "Imapc: Quota"
 ---
 
 # Imapc Mailbox Format
@@ -42,13 +45,12 @@ IMAP server. By default it uses `GETQUOTAROOT INBOX` to retrieve the quota.
 There are two parameters that can be used to control how the quota is looked
 up:
 
-* `box = <mailbox>`: Use `GETQUOTAROOT <mailbox>`
-* `root = <name>`: Use `GETQUOTA <name>`
+<SettingsComponent tag="quota-imapc" />
 
-Example:
+### Example
 
 ```
-plugin {
-  quota = imapc:root=User Quota
+quota "User Quota" {
+  driver = imapc
 }
 ```

docs/core/config/mailbox/formats/imapc.md

@@ -78,7 +78,7 @@ userdb: jane
   home      : /home/jane
   mail_path : ~/sdbox
   plugins   : sieve
-  quota_rule: \*:storage=150M
+  quota_storage_size: 150M
 
 userdb: [email protected]
   home      : /srv/mail/8/70312/79832

docs/core/man/doveadm-user.1.md

@@ -74,8 +74,12 @@ acl_driver = vfile
 lazy_expunge_mailbox = .EXPUNGED
 
 plugin {
+  # Define ACL so that user cannot list the .EXPUNGED mailbox
+  acl = vfile:/etc/dovecot/dovecot.acl
+}
+mailbox .EXPUNGED {
   # Expunged messages most likely don't want to be included in quota:
-  quota_rule = .EXPUNGED:ignore
+  quota_ignore = yes
 }
 ```
 
@@ -113,11 +117,12 @@ is hidden from users via ACL).
 Example to exclude expunged storage from the quota:
 
 ```[dovecot.conf]
-plugin {
-   quota = count:User quota
-   quota_rule = *:storage=1GB
-   # Exclude .EXPUNGED mailbox from the quota
-   quota_rule2 = .EXPUNGED:ignore
+quota "User quota" {
+  quota_storage_size = 1GB
+}
+mailbox .EXPUNGED {
+  # Exclude .EXPUNGED mailbox from the quota
+  quota_ignore = yes
 }
 ```