From f7548d6d28c313cf80e6f3ef89aed16a19815df1 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 28 Apr 2024 11:51:24 +0200
Subject: Adding upstream version 1:2.3.19.1+dfsg1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 doc/wiki/MailboxSettings.txt | 81 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 doc/wiki/MailboxSettings.txt

(limited to 'doc/wiki/MailboxSettings.txt')

diff --git a/doc/wiki/MailboxSettings.txt b/doc/wiki/MailboxSettings.txt
new file mode 100644
index 0000000..3e94581
--- /dev/null
+++ b/doc/wiki/MailboxSettings.txt
@@ -0,0 +1,81 @@
+Mailbox settings
+================
+
+Since Dovecot v2.1 one can assign SPECIAL-USE RFC 6154
+[http://www.faqs.org/rfcs/rfc6154.html] tags and specify, which mailboxes to
+create and/or subscribe to automatically.
+
+The autocreated mailboxes are created lazily to disk only when accessed for the
+first time. The autosubscribed mailboxes aren't written to subscriptions file,
+unless SUBSCRIBE command is explicitly used for them.
+
+The mailbox section name specifies the mailbox name. If it has spaces, you can
+put it in "quotes". The mailbox settings are:
+
+ * auto: Autocreate/subscribe mailbox?
+    * no: Neither
+    * create: Autocreate, but don't autosubscribe
+    * subscribe: Autocreate and autosubscribe
+ * special_use: Space-separated list of SPECIAL-USE flags to use for the
+   mailbox. There are no validity checks, so you could specify anything you
+   want in here, but it's not a good idea to use other than the standard ones
+   specified in the RFC.
+    * NOTE: Due to a bug in Dovecot v2.2.30+ if special-use flags are used,
+      SPECIAL-USE needs to be added to post-login CAPABILITY response as RFC
+      6154 mandates. You can do this with 'imap_capability = +SPECIAL-USE'
+ * autoexpunge=<time>: (v2.2.20+) Automatically at user deinitialization
+   expunge all mails in this mailbox whose saved-timestamp is older than<time>
+   (e.g. autoexpunge=30d). This removes the need for <expire plugin>
+   [Plugins.Expire.txt] if you don't care that the expunging may not always
+   happen in time.
+    * For IMAP and POP3 this happens after the client is already disconnected.
+    * For LMTP this happens when the user's mail delivery is finished. Note
+      that if there are multiple recipients this may delay delivering the mails
+      to the other recipients.
+    * Also doveadm and other processes verify this, which may be unnecessary.
+      So it may be better to explicitly enable this only inside protocol imap,
+      pop3 and maybe lmtp. You can do this with e.g.:'protocol imap { namespace
+      inbox { mailbox Spam { autoexpunge = 10d } } }'
+    * mailbox_list_index=yes is highly recommended when using this setting, as
+      it avoids actually opening the mailbox to see if anything needs to be
+      expunged.
+ * autoexpunge_max_mails=<number>: (v2.2.25+) Mails are expunged until mail
+   count is at autoexpunge_max_mails or below.  After these messages are
+   removed, autoexpunge will then try to expunge mails based on the
+   'autoexpunge' setting.
+
+---%<-------------------------------------------------------------------------
+namespace inbox {
+  #prefix = INBOX. # the namespace prefix isn't added again to the mailbox
+names.
+  inbox = yes
+  # ...
+
+  mailbox Trash {
+    auto = no
+    special_use = \Trash
+  }
+  mailbox Drafts {
+    auto = no
+    special_use = \Drafts
+  }
+  mailbox Sent {
+    auto = subscribe # autocreate and autosubscribe the Sent mailbox
+    special_use = \Sent
+  }
+  mailbox "Sent Messages" {
+    auto = no
+    special_use = \Sent
+  }
+  mailbox Spam {
+    auto = create # autocreate Spam, but don't autosubscribe
+    special_use = \Junk
+  }
+  mailbox virtual/All { # if you have a virtual "All messages" mailbox
+    auto = no
+    special_use = \All
+  }
+}
+---%<-------------------------------------------------------------------------
+
+(This file was created from the wiki on 2019-06-19 12:42)
-- 
cgit v1.2.3