config_manual: Update namespace_alias_for setting

sirainen · Dec 9, 2023 · 3e94284 · 3e94284
1 parent a1e993c
commit 3e94284
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 14 deletions.
diff --git a/source/configuration_manual/mail_location/Maildir/index.rst b/source/configuration_manual/mail_location/Maildir/index.rst
@@ -153,16 +153,16 @@ For example:
 .. code-block:: none
 
   mail_location = maildir:~/Maildir:LAYOUT=fs
-  namespace {
+  namespace inbox {
     inbox = yes
     prefix = INBOX/
     separator = /
     subscriptions = no
   }
-  namespace {
+  namespace empty {
     prefix =
     separator = /
-    alias_for = INBOX/
+    alias_for = inbox
     location = maildir:~/Maildir:LAYOUT=fs # Alias location
     subscriptions = yes
   }

diff --git a/source/configuration_manual/namespace/index.rst b/source/configuration_manual/namespace/index.rst
@@ -74,7 +74,7 @@ Settings
 .. dovecot_core:setting:: namespace_alias_for
    :values: @string
 
-   Defines the namespace prefix for purposes of alias detection.
+   Refers to an alias namespace's :dovecot_core:ref:`namespace_name`.
 
    If multiple namespaces point to the same location, they should be marked as
    aliases against one primary namespace. This avoids duplicating work for
@@ -89,12 +89,13 @@ Settings
 
    Example::
 
+     namespace inbox {
+       prefix =
+       ...
+     }
      namespace alias {
-       # If primary namespace has empty prefix
-       alias_for =
-
-       # OR if primary namespace has prefix=INBOX/
-       alias_for = INBOX/
+       prefix = INBOX/
+       alias_for = inbox
      }
 
 
@@ -381,21 +382,21 @@ mails using their existing namespace settings in clients.
     prefix = mail/
     hidden = yes
     list = no
-    alias_for =
+    alias_for = inbox
   }
   namespace compat2 {
     separator = /
     prefix = ~/mail/
     hidden = yes
     list = no
-    alias_for =
+    alias_for = inbox
   }
   namespace compat3 {
     separator = /
     prefix = ~%u/mail/
     hidden = yes
     list = no
-    alias_for =
+    alias_for = inbox
   }
 
 Backwards Compatibility: Courier IMAP
@@ -428,7 +429,7 @@ can continue using it while new clients will use the empty prefix namespace:
     inbox = no
     hidden = yes
     list = no
-    alias_for =
+    alias_for = inbox
   }
 
 The ``separator=/`` allows the INBOX to have child mailboxes. Otherwise with

diff --git a/source/configuration_manual/shared_mailboxes/public_shared.rst b/source/configuration_manual/shared_mailboxes/public_shared.rst
@@ -93,7 +93,7 @@ namespace with empty prefix, create one:
           subscriptions = yes
           hidden = yes
           list = no
-          alias_for = INBOX/ # the INBOX namespace's prefix
+          alias_for = inbox # the INBOX namespace's name
           location = <same as mail_location>:SUBSCRIPTIONS=subscriptions-shared
         }