From: Timo Sirainen <tss@iki.fi>
Date: Tue, 14 May 2013 13:46:08 +0000 (+0300)
Subject: example-config: Moved imap_* and pop3_* settings outside protocol section.
X-Git-Tag: 2.2.2~29
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cf04ab5212f02ac369fe337c1b80dbcd7b6e2790;p=thirdparty%2Fdovecot%2Fcore.git

example-config: Moved imap_* and pop3_* settings outside protocol section.
There's no need to keep them inside protocol {}, and in case of
pop3_uidl_format=%m setting it's actually harmful.
---

diff --git a/doc/example-config/conf.d/20-imap.conf b/doc/example-config/conf.d/20-imap.conf
index 9de1318e35..689b0ea4b5 100644
--- a/doc/example-config/conf.d/20-imap.conf
+++ b/doc/example-config/conf.d/20-imap.conf
@@ -2,60 +2,60 @@
 ## IMAP specific settings
 ##
 
-protocol imap {
-  # Maximum IMAP command line length. Some clients generate very long command
-  # lines with huge mailboxes, so you may need to raise this if you get
-  # "Too long argument" or "IMAP command line too large" errors often.
-  #imap_max_line_length = 64k
+# Maximum IMAP command line length. Some clients generate very long command
+# lines with huge mailboxes, so you may need to raise this if you get
+# "Too long argument" or "IMAP command line too large" errors often.
+#imap_max_line_length = 64k
+
+# IMAP logout format string:
+#  %i - total number of bytes read from client
+#  %o - total number of bytes sent to client
+#imap_logout_format = in=%i out=%o
+
+# Override the IMAP CAPABILITY response. If the value begins with '+',
+# add the given capabilities on top of the defaults (e.g. +XFOO XBAR).
+#imap_capability = 
+
+# How long to wait between "OK Still here" notifications when client is
+# IDLEing.
+#imap_idle_notify_interval = 2 mins
+
+# ID field names and values to send to clients. Using * as the value makes
+# Dovecot use the default value. The following fields have default values
+# currently: name, version, os, os-version, support-url, support-email.
+#imap_id_send = 
+
+# ID fields sent by client to log. * means everything.
+#imap_id_log =
+
+# Workarounds for various client bugs:
+#   delay-newmail:
+#     Send EXISTS/RECENT new mail notifications only when replying to NOOP
+#     and CHECK commands. Some clients ignore them otherwise, for example OSX
+#     Mail (<v2.1). Outlook Express breaks more badly though, without this it
+#     may show user "Message no longer in server" errors. Note that OE6 still
+#     breaks even with this workaround if synchronization is set to
+#     "Headers Only".
+#   tb-extra-mailbox-sep:
+#     Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and
+#     adds extra '/' suffixes to mailbox names. This option causes Dovecot to
+#     ignore the extra '/' instead of treating it as invalid mailbox name.
+#   tb-lsub-flags:
+#     Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox).
+#     This makes Thunderbird realize they aren't selectable and show them
+#     greyed out, instead of only later giving "not selectable" popup error.
+#
+# The list is space-separated.
+#imap_client_workarounds = 
 
-  # Maximum number of IMAP connections allowed for a user from each IP address.
-  # NOTE: The username is compared case-sensitively.
-  #mail_max_userip_connections = 10
+# Host allowed in URLAUTH URLs sent by client. "*" allows all.
+#imap_urlauth_host =
 
+protocol imap {
   # Space separated list of plugins to load (default is global mail_plugins).
   #mail_plugins = $mail_plugins
 
-  # IMAP logout format string:
-  #  %i - total number of bytes read from client
-  #  %o - total number of bytes sent to client
-  #imap_logout_format = in=%i out=%o
-
-  # Override the IMAP CAPABILITY response. If the value begins with '+',
-  # add the given capabilities on top of the defaults (e.g. +XFOO XBAR).
-  #imap_capability = 
-
-  # How long to wait between "OK Still here" notifications when client is
-  # IDLEing.
-  #imap_idle_notify_interval = 2 mins
-
-  # ID field names and values to send to clients. Using * as the value makes
-  # Dovecot use the default value. The following fields have default values
-  # currently: name, version, os, os-version, support-url, support-email.
-  #imap_id_send = 
-
-  # ID fields sent by client to log. * means everything.
-  #imap_id_log =
-
-  # Workarounds for various client bugs:
-  #   delay-newmail:
-  #     Send EXISTS/RECENT new mail notifications only when replying to NOOP
-  #     and CHECK commands. Some clients ignore them otherwise, for example OSX
-  #     Mail (<v2.1). Outlook Express breaks more badly though, without this it
-  #     may show user "Message no longer in server" errors. Note that OE6 still
-  #     breaks even with this workaround if synchronization is set to
-  #     "Headers Only".
-  #   tb-extra-mailbox-sep:
-  #     Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and
-  #     adds extra '/' suffixes to mailbox names. This option causes Dovecot to
-  #     ignore the extra '/' instead of treating it as invalid mailbox name.
-  #   tb-lsub-flags:
-  #     Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox).
-  #     This makes Thunderbird realize they aren't selectable and show them
-  #     greyed out, instead of only later giving "not selectable" popup error.
-  #
-  # The list is space-separated.
-  #imap_client_workarounds = 
+  # Maximum number of IMAP connections allowed for a user from each IP address.
+  # NOTE: The username is compared case-sensitively.
+  #mail_max_userip_connections = 10
 }
-
-# Host allowed in URLAUTH URLs sent by client. "*" allows all.
-#imap_urlauth_host =
diff --git a/doc/example-config/conf.d/20-pop3.conf b/doc/example-config/conf.d/20-pop3.conf
index ded9fa9c4d..50470e901d 100644
--- a/doc/example-config/conf.d/20-pop3.conf
+++ b/doc/example-config/conf.d/20-pop3.conf
@@ -2,97 +2,97 @@
 ## POP3 specific settings
 ##
 
-protocol pop3 {
-  # Don't try to set mails non-recent or seen with POP3 sessions. This is
-  # mostly intended to reduce disk I/O. With maildir it doesn't move files
-  # from new/ to cur/, with mbox it doesn't write Status-header.
-  #pop3_no_flag_updates = no
+# Don't try to set mails non-recent or seen with POP3 sessions. This is
+# mostly intended to reduce disk I/O. With maildir it doesn't move files
+# from new/ to cur/, with mbox it doesn't write Status-header.
+#pop3_no_flag_updates = no
 
-  # Support LAST command which exists in old POP3 specs, but has been removed
-  # from new ones. Some clients still wish to use this though. Enabling this
-  # makes RSET command clear all \Seen flags from messages.
-  #pop3_enable_last = no
+# Support LAST command which exists in old POP3 specs, but has been removed
+# from new ones. Some clients still wish to use this though. Enabling this
+# makes RSET command clear all \Seen flags from messages.
+#pop3_enable_last = no
 
-  # If mail has X-UIDL header, use it as the mail's UIDL.
-  #pop3_reuse_xuidl = no
+# If mail has X-UIDL header, use it as the mail's UIDL.
+#pop3_reuse_xuidl = no
 
-  # Allow only one POP3 session to run simultaneously for the same user.
-  #pop3_lock_session = no
+# Allow only one POP3 session to run simultaneously for the same user.
+#pop3_lock_session = no
 
-  # POP3 requires message sizes to be listed as if they had CR+LF linefeeds.
-  # Many POP3 servers violate this by returning the sizes with LF linefeeds,
-  # because it's faster to get. When this setting is enabled, Dovecot still
-  # tries to do the right thing first, but if that requires opening the
-  # message, it fallbacks to the easier (but incorrect) size.
-  #pop3_fast_size_lookups = no
+# POP3 requires message sizes to be listed as if they had CR+LF linefeeds.
+# Many POP3 servers violate this by returning the sizes with LF linefeeds,
+# because it's faster to get. When this setting is enabled, Dovecot still
+# tries to do the right thing first, but if that requires opening the
+# message, it fallbacks to the easier (but incorrect) size.
+#pop3_fast_size_lookups = no
 
-  # POP3 UIDL (unique mail identifier) format to use. You can use following
-  # variables, along with the variable modifiers described in
-  # doc/wiki/Variables.txt (e.g. %Uf for the filename in uppercase)
-  #
-  #  %v - Mailbox's IMAP UIDVALIDITY
-  #  %u - Mail's IMAP UID
-  #  %m - MD5 sum of the mailbox headers in hex (mbox only)
-  #  %f - filename (maildir only)
-  #  %g - Mail's GUID
-  #
-  # If you want UIDL compatibility with other POP3 servers, use:
-  #  UW's ipop3d         : %08Xv%08Xu
-  #  Courier             : %f or %v-%u (both might be used simultaneosly)
-  #  Cyrus (<= 2.1.3)    : %u
-  #  Cyrus (>= 2.1.4)    : %v.%u
-  #  Dovecot v0.99.x     : %v.%u
-  #  tpop3d              : %Mf
-  #
-  # Note that Outlook 2003 seems to have problems with %v.%u format which was
-  # Dovecot's default, so if you're building a new server it would be a good
-  # idea to change this. %08Xu%08Xv should be pretty fail-safe.
-  #
-  #pop3_uidl_format = %08Xu%08Xv
+# POP3 UIDL (unique mail identifier) format to use. You can use following
+# variables, along with the variable modifiers described in
+# doc/wiki/Variables.txt (e.g. %Uf for the filename in uppercase)
+#
+#  %v - Mailbox's IMAP UIDVALIDITY
+#  %u - Mail's IMAP UID
+#  %m - MD5 sum of the mailbox headers in hex (mbox only)
+#  %f - filename (maildir only)
+#  %g - Mail's GUID
+#
+# If you want UIDL compatibility with other POP3 servers, use:
+#  UW's ipop3d         : %08Xv%08Xu
+#  Courier             : %f or %v-%u (both might be used simultaneosly)
+#  Cyrus (<= 2.1.3)    : %u
+#  Cyrus (>= 2.1.4)    : %v.%u
+#  Dovecot v0.99.x     : %v.%u
+#  tpop3d              : %Mf
+#
+# Note that Outlook 2003 seems to have problems with %v.%u format which was
+# Dovecot's default, so if you're building a new server it would be a good
+# idea to change this. %08Xu%08Xv should be pretty fail-safe.
+#
+#pop3_uidl_format = %08Xu%08Xv
 
-  # Permanently save UIDLs sent to POP3 clients, so pop3_uidl_format changes
-  # won't change those UIDLs. Currently this works only with Maildir.
-  #pop3_save_uidl = no
+# Permanently save UIDLs sent to POP3 clients, so pop3_uidl_format changes
+# won't change those UIDLs. Currently this works only with Maildir.
+#pop3_save_uidl = no
 
-  # What to do about duplicate UIDLs if they exist?
-  #   allow: Show duplicates to clients.
-  #   rename: Append a temporary -2, -3, etc. counter after the UIDL.
-  #pop3_uidl_duplicates = allow
+# What to do about duplicate UIDLs if they exist?
+#   allow: Show duplicates to clients.
+#   rename: Append a temporary -2, -3, etc. counter after the UIDL.
+#pop3_uidl_duplicates = allow
 
-  # This option changes POP3 behavior so that it's not possible to actually
-  # delete mails via POP3, only hide them from future POP3 sessions. The mails
-  # will still be counted towards user's quota until actually deleted via IMAP.
-  # Use e.g. "$POP3Deleted" as the value (it will be visible as IMAP keyword).
-  # Make sure you can legally archive mails before enabling this setting.
-  #pop3_deleted_flag =
+# This option changes POP3 behavior so that it's not possible to actually
+# delete mails via POP3, only hide them from future POP3 sessions. The mails
+# will still be counted towards user's quota until actually deleted via IMAP.
+# Use e.g. "$POP3Deleted" as the value (it will be visible as IMAP keyword).
+# Make sure you can legally archive mails before enabling this setting.
+#pop3_deleted_flag =
 
-  # POP3 logout format string:
-  #  %i - total number of bytes read from client
-  #  %o - total number of bytes sent to client
-  #  %t - number of TOP commands
-  #  %p - number of bytes sent to client as a result of TOP command
-  #  %r - number of RETR commands
-  #  %b - number of bytes sent to client as a result of RETR command
-  #  %d - number of deleted messages
-  #  %m - number of messages (before deletion)
-  #  %s - mailbox size in bytes (before deletion)
-  #  %u - old/new UIDL hash. may help finding out if UIDLs changed unexpectedly
-  #pop3_logout_format = top=%t/%p, retr=%r/%b, del=%d/%m, size=%s
+# POP3 logout format string:
+#  %i - total number of bytes read from client
+#  %o - total number of bytes sent to client
+#  %t - number of TOP commands
+#  %p - number of bytes sent to client as a result of TOP command
+#  %r - number of RETR commands
+#  %b - number of bytes sent to client as a result of RETR command
+#  %d - number of deleted messages
+#  %m - number of messages (before deletion)
+#  %s - mailbox size in bytes (before deletion)
+#  %u - old/new UIDL hash. may help finding out if UIDLs changed unexpectedly
+#pop3_logout_format = top=%t/%p, retr=%r/%b, del=%d/%m, size=%s
 
-  # Maximum number of POP3 connections allowed for a user from each IP address.
-  # NOTE: The username is compared case-sensitively.
-  #mail_max_userip_connections = 10
+# Workarounds for various client bugs:
+#   outlook-no-nuls:
+#     Outlook and Outlook Express hang if mails contain NUL characters.
+#     This setting replaces them with 0x80 character.
+#   oe-ns-eoh:
+#     Outlook Express and Netscape Mail breaks if end of headers-line is
+#     missing. This option simply sends it if it's missing.
+# The list is space-separated.
+#pop3_client_workarounds = 
 
+protocol pop3 {
   # Space separated list of plugins to load (default is global mail_plugins).
   #mail_plugins = $mail_plugins
 
-  # Workarounds for various client bugs:
-  #   outlook-no-nuls:
-  #     Outlook and Outlook Express hang if mails contain NUL characters.
-  #     This setting replaces them with 0x80 character.
-  #   oe-ns-eoh:
-  #     Outlook Express and Netscape Mail breaks if end of headers-line is
-  #     missing. This option simply sends it if it's missing.
-  # The list is space-separated.
-  #pop3_client_workarounds = 
+  # Maximum number of POP3 connections allowed for a user from each IP address.
+  # NOTE: The username is compared case-sensitively.
+  #mail_max_userip_connections = 10
 }