10-mail.conf.erb 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. ##
  2. ## Mailbox locations and namespaces
  3. ##
  4. # Location for users' mailboxes. The default is empty, which means that Dovecot
  5. # tries to find the mailboxes automatically. This won't work if the user
  6. # doesn't yet have any mail, so you should explicitly tell Dovecot the full
  7. # location.
  8. #
  9. # If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u)
  10. # isn't enough. You'll also need to tell Dovecot where the other mailboxes are
  11. # kept. This is called the "root mail directory", and it must be the first
  12. # path given in the mail_location setting.
  13. #
  14. # There are a few special variables you can use, eg.:
  15. #
  16. # %u - username
  17. # %n - user part in user@domain, same as %u if there's no domain
  18. # %d - domain part in user@domain, empty if there's no domain
  19. # %h - home directory
  20. #
  21. # See doc/wiki/Variables.txt for full list. Some examples:
  22. #
  23. # mail_location = maildir:~/Maildir
  24. # mail_location = mbox:~/mail:INBOX=/var/mail/%u
  25. # mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n
  26. #
  27. # <doc/wiki/MailLocation.txt>
  28. #
  29. <%= Dovecot::Conf.attribute(@conf, 'mail_location') %>
  30. # If you need to set multiple mailbox locations or want to change default
  31. # namespace settings, you can do it by defining namespace sections.
  32. #
  33. # You can have private, shared and public namespaces. Private namespaces
  34. # are for user's personal mails. Shared namespaces are for accessing other
  35. # users' mailboxes that have been shared. Public namespaces are for shared
  36. # mailboxes that are managed by sysadmin. If you create any shared or public
  37. # namespaces you'll typically want to enable ACL plugin also, otherwise all
  38. # users can access all the shared mailboxes, assuming they have permissions
  39. # on filesystem level to do so.
  40. #
  41. # REMEMBER: If you add any namespaces, the default namespace must be added
  42. # explicitly, ie. mail_location does nothing unless you have a namespace
  43. # without a location setting. Default namespace is simply done by having a
  44. # namespace with empty prefix.
  45. <% if @namespaces.kind_of?(Array) and @namespaces.length > 0 -%>
  46. <% @namespaces.each do |ns| -%>
  47. <%= Dovecot::Conf.namespace(ns) %>
  48. <% end -%>
  49. <% else -%>
  50. #namespace {
  51. # Namespace type: private, shared or public
  52. #type = private
  53. # Hierarchy separator to use. You should use the same separator for all
  54. # namespaces or some clients get confused. '/' is usually a good one.
  55. # The default however depends on the underlying mail storage format.
  56. #separator =
  57. # Prefix required to access this namespace. This needs to be different for
  58. # all namespaces. For example "Public/".
  59. #prefix =
  60. # Physical location of the mailbox. This is in same format as
  61. # mail_location, which is also the default for it.
  62. #location =
  63. # There can be only one INBOX, and this setting defines which namespace
  64. # has it.
  65. #inbox = no
  66. # If namespace is hidden, it's not advertised to clients via NAMESPACE
  67. # extension. You'll most likely also want to set list=no. This is mostly
  68. # useful when converting from another server with different namespaces which
  69. # you want to deprecate but still keep working. For example you can create
  70. # hidden namespaces with prefixes "~/mail/", "~%u/mail/" and "mail/".
  71. #hidden = no
  72. # Show the mailboxes under this namespace with LIST command. This makes the
  73. # namespace visible for clients that don't support NAMESPACE extension.
  74. # "children" value lists child mailboxes, but hides the namespace prefix.
  75. #list = yes
  76. # Namespace handles its own subscriptions. If set to "no", the parent
  77. # namespace handles them (empty prefix should always have this as "yes")
  78. #subscriptions = yes
  79. #}
  80. <% end -%>
  81. # Example shared namespace configuration
  82. #namespace {
  83. #type = shared
  84. #separator = /
  85. # Mailboxes are visible under "shared/user@domain/"
  86. # %%n, %%d and %%u are expanded to the destination user.
  87. #prefix = shared/%%u/
  88. # Mail location for other users' mailboxes. Note that %variables and ~/
  89. # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the
  90. # destination user's data.
  91. #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u
  92. # Use the default namespace for saving subscriptions.
  93. #subscriptions = no
  94. # List the shared/ namespace only if there are visible shared mailboxes.
  95. #list = children
  96. #}
  97. # System user and group used to access mails. If you use multiple, userdb
  98. # can override these by returning uid or gid fields. You can use either numbers
  99. # or names. <doc/wiki/UserIds.txt>
  100. <%= Dovecot::Conf.attribute(@conf, 'mail_uid') %>
  101. <%= Dovecot::Conf.attribute(@conf, 'mail_gid') %>
  102. # Group to enable temporarily for privileged operations. Currently this is
  103. # used only with INBOX when either its initial creation or dotlocking fails.
  104. # Typically this is set to "mail" to give access to /var/mail.
  105. <%= Dovecot::Conf.attribute(@conf, 'mail_privileged_group') %>
  106. # Grant access to these supplementary groups for mail processes. Typically
  107. # these are used to set up access to shared mailboxes. Note that it may be
  108. # dangerous to set these if users can create symlinks (e.g. if "mail" group is
  109. # set here, ln -s /var/mail ~/mail/var could allow a user to delete others'
  110. # mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it).
  111. <%= Dovecot::Conf.attribute(@conf, 'mail_access_groups') %>
  112. # Allow full filesystem access to clients. There's no access checks other than
  113. # what the operating system does for the active UID/GID. It works with both
  114. # maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
  115. # or ~user/.
  116. <%= Dovecot::Conf.attribute(@conf, 'mail_full_filesystem_access', false) %>
  117. ##
  118. ## Mail processes
  119. ##
  120. # Don't use mmap() at all. This is required if you store indexes to shared
  121. # filesystems (NFS or clustered filesystem).
  122. <%= Dovecot::Conf.attribute(@conf, 'mmap_disable', false) %>
  123. # Rely on O_EXCL to work when creating dotlock files. NFS supports O_EXCL
  124. # since version 3, so this should be safe to use nowadays by default.
  125. <%= Dovecot::Conf.attribute(@conf, 'dotlock_use_excl', true) %>
  126. # When to use fsync() or fdatasync() calls:
  127. # optimized (default): Whenever necessary to avoid losing important data
  128. # always: Useful with e.g. NFS when write()s are delayed
  129. # never: Never use it (best performance, but crashes can lose data)
  130. <%= Dovecot::Conf.attribute(@conf, 'mail_fsync', 'optimized') %>
  131. # Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS caches
  132. # whenever needed. If you're using only a single mail server this isn't needed.
  133. <%= Dovecot::Conf.attribute(@conf, 'mail_nfs_storage', false) %>
  134. # Mail index files also exist in NFS. Setting this to yes requires
  135. # mmap_disable=yes and fsync_disable=no.
  136. <%= Dovecot::Conf.attribute(@conf, 'mail_nfs_index', false) %>
  137. # Locking method for index files. Alternatives are fcntl, flock and dotlock.
  138. # Dotlocking uses some tricks which may create more disk I/O than other locking
  139. # methods. NFS users: flock doesn't work, remember to change mmap_disable.
  140. <%= Dovecot::Conf.attribute(@conf, 'lock_method', 'fcntl') %>
  141. # Directory in which LDA/LMTP temporarily stores incoming mails >128 kB.
  142. <%= Dovecot::Conf.attribute(@conf, 'mail_temp_dir', '/tmp') %>
  143. # Valid UID range for users, defaults to 500 and above. This is mostly
  144. # to make sure that users can't log in as daemons or other system users.
  145. # Note that denying root logins is hardcoded to dovecot binary and can't
  146. # be done even if first_valid_uid is set to 0.
  147. <%= Dovecot::Conf.attribute(@conf, 'first_valid_uid', 500) %>
  148. <%= Dovecot::Conf.attribute(@conf, 'last_valid_uid', 0) %>
  149. # Valid GID range for users, defaults to non-root/wheel. Users having
  150. # non-valid GID as primary group ID aren't allowed to log in. If user
  151. # belongs to supplementary groups with non-valid GIDs, those groups are
  152. # not set.
  153. <%= Dovecot::Conf.attribute(@conf, 'first_valid_gid', 1) %>
  154. <%= Dovecot::Conf.attribute(@conf, 'last_valid_gid', 0) %>
  155. # Maximum allowed length for mail keyword name. It's only forced when trying
  156. # to create new keywords.
  157. <%= Dovecot::Conf.attribute(@conf, 'mail_max_keyword_length', 50) %>
  158. # ':' separated list of directories under which chrooting is allowed for mail
  159. # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
  160. # This setting doesn't affect login_chroot, mail_chroot or auth chroot
  161. # settings. If this setting is empty, "/./" in home dirs are ignored.
  162. # WARNING: Never add directories here which local users can modify, that
  163. # may lead to root exploit. Usually this should be done only if you don't
  164. # allow shell access for users. <doc/wiki/Chrooting.txt>
  165. <%= Dovecot::Conf.attribute(@conf, 'valid_chroot_dirs') %>
  166. # Default chroot directory for mail processes. This can be overridden for
  167. # specific users in user database by giving /./ in user's home directory
  168. # (eg. /home/./user chroots into /home). Note that usually there is no real
  169. # need to do chrooting, Dovecot doesn't allow users to access files outside
  170. # their mail directory anyway. If your home directories are prefixed with
  171. # the chroot directory, append "/." to mail_chroot. <doc/wiki/Chrooting.txt>
  172. <%= Dovecot::Conf.attribute(@conf, 'mail_chroot') %>
  173. # UNIX socket path to master authentication server to find users.
  174. # This is used by imap (for shared users) and lda.
  175. <%= Dovecot::Conf.attribute(@conf, 'auth_socket_path', '/var/run/dovecot/auth-userdb') %>
  176. # Directory where to look up mail plugins.
  177. <%= Dovecot::Conf.attribute(@conf, 'mail_plugin_dir', '/usr/lib/dovecot/modules') %>
  178. # Space separated list of plugins to load for all services. Plugins specific to
  179. # IMAP, LDA, etc. are added to this list in their own .conf files.
  180. <%= Dovecot::Conf.attribute(@conf, 'mail_plugins') %>
  181. ##
  182. ## Mailbox handling optimizations
  183. ##
  184. # The minimum number of mails in a mailbox before updates are done to cache
  185. # file. This allows optimizing Dovecot's behavior to do less disk writes at
  186. # the cost of more disk reads.
  187. <%= Dovecot::Conf.attribute(@conf, 'mail_cache_min_mail_count', 0) %>
  188. # When IDLE command is running, mailbox is checked once in a while to see if
  189. # there are any new mails or other changes. This setting defines the minimum
  190. # time to wait between those checks. Dovecot can also use dnotify, inotify and
  191. # kqueue to find out immediately when changes occur.
  192. <%= Dovecot::Conf.attribute(@conf, 'mailbox_idle_check_interval', '30 secs') %>
  193. # Save mails with CR+LF instead of plain LF. This makes sending those mails
  194. # take less CPU, especially with sendfile() syscall with Linux and FreeBSD.
  195. # But it also creates a bit more disk I/O which may just make it slower.
  196. # Also note that if other software reads the mboxes/maildirs, they may handle
  197. # the extra CRs wrong and cause problems.
  198. <%= Dovecot::Conf.attribute(@conf, 'mail_save_crlf', false) %>
  199. ##
  200. ## Maildir-specific settings
  201. ##
  202. # By default LIST command returns all entries in maildir beginning with a dot.
  203. # Enabling this option makes Dovecot return only entries which are directories.
  204. # This is done by stat()ing each entry, so it causes more disk I/O.
  205. # (For systems setting struct dirent->d_type, this check is free and it's
  206. # done always regardless of this setting)
  207. <%= Dovecot::Conf.attribute(@conf, 'maildir_stat_dirs', false) %>
  208. # When copying a message, do it with hard links whenever possible. This makes
  209. # the performance much better, and it's unlikely to have any side effects.
  210. <%= Dovecot::Conf.attribute(@conf, 'maildir_copy_with_hardlinks', true) %>
  211. # Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only
  212. # when its mtime changes unexpectedly or when we can't find the mail otherwise.
  213. <%= Dovecot::Conf.attribute(@conf, 'maildir_very_dirty_syncs', false) %>
  214. ##
  215. ## mbox-specific settings
  216. ##
  217. # Which locking methods to use for locking mbox. There are four available:
  218. # dotlock: Create <mailbox>.lock file. This is the oldest and most NFS-safe
  219. # solution. If you want to use /var/mail/ like directory, the users
  220. # will need write access to that directory.
  221. # dotlock_try: Same as dotlock, but if it fails because of permissions or
  222. # because there isn't enough disk space, just skip it.
  223. # fcntl : Use this if possible. Works with NFS too if lockd is used.
  224. # flock : May not exist in all systems. Doesn't work with NFS.
  225. # lockf : May not exist in all systems. Doesn't work with NFS.
  226. #
  227. # You can use multiple locking methods; if you do the order they're declared
  228. # in is important to avoid deadlocks if other MTAs/MUAs are using multiple
  229. # locking methods as well. Some operating systems don't allow using some of
  230. # them simultaneously.
  231. <%= Dovecot::Conf.attribute(@conf, 'mbox_read_locks', 'fcntl') %>
  232. <%= Dovecot::Conf.attribute(@conf, 'mbox_write_locks', 'dotlock fcntl') %>
  233. # Maximum time to wait for lock (all of them) before aborting.
  234. <%= Dovecot::Conf.attribute(@conf, 'mbox_lock_timeout', '5 mins') %>
  235. # If dotlock exists but the mailbox isn't modified in any way, override the
  236. # lock file after this much time.
  237. <%= Dovecot::Conf.attribute(@conf, 'mbox_dotlock_change_timeout', '2 mins') %>
  238. # When mbox changes unexpectedly we have to fully read it to find out what
  239. # changed. If the mbox is large this can take a long time. Since the change
  240. # is usually just a newly appended mail, it'd be faster to simply read the
  241. # new mails. If this setting is enabled, Dovecot does this but still safely
  242. # fallbacks to re-reading the whole mbox file whenever something in mbox isn't
  243. # how it's expected to be. The only real downside to this setting is that if
  244. # some other MUA changes message flags, Dovecot doesn't notice it immediately.
  245. # Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK
  246. # commands.
  247. <%= Dovecot::Conf.attribute(@conf, 'mbox_dirty_syncs', true) %>
  248. # Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE,
  249. # EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored.
  250. <%= Dovecot::Conf.attribute(@conf, 'mbox_very_dirty_syncs', false) %>
  251. # Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK
  252. # commands and when closing the mailbox). This is especially useful for POP3
  253. # where clients often delete all mails. The downside is that our changes
  254. # aren't immediately visible to other MUAs.
  255. <%= Dovecot::Conf.attribute(@conf, 'mbox_lazy_writes', true) %>
  256. # If mbox size is smaller than this (e.g. 100k), don't write index files.
  257. # If an index file already exists it's still read, just not updated.
  258. <%= Dovecot::Conf.attribute(@conf, 'mbox_min_index_size', 0) %>
  259. ##
  260. ## mdbox-specific settings
  261. ##
  262. # Maximum dbox file size until it's rotated.
  263. <%= Dovecot::Conf.attribute(@conf, 'mdbox_rotate_size', '2M') %>
  264. # Maximum dbox file age until it's rotated. Typically in days. Day begins
  265. # from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled.
  266. <%= Dovecot::Conf.attribute(@conf, 'mdbox_rotate_interval', 0) %>
  267. # When creating new mdbox files, immediately preallocate their size to
  268. # mdbox_rotate_size. This setting currently works only in Linux with some
  269. # filesystems (ext4, xfs).
  270. <%= Dovecot::Conf.attribute(@conf, 'mdbox_preallocate_space', false) %>
  271. ##
  272. ## Mail attachments
  273. ##
  274. # sdbox and mdbox support saving mail attachments to external files, which
  275. # also allows single instance storage for them. Other backends don't support
  276. # this for now.
  277. # WARNING: This feature hasn't been tested much yet. Use at your own risk.
  278. # Directory root where to store mail attachments. Disabled, if empty.
  279. #mail_attachment_dir =
  280. # Attachments smaller than this aren't saved externally. It's also possible to
  281. # write a plugin to disable saving specific attachments externally.
  282. <%= Dovecot::Conf.attribute(@conf, 'mail_attachment_min_size', '128k') %>
  283. # Filesystem backend to use for saving attachments:
  284. # posix : No SiS done by Dovecot (but this might help FS's own deduplication)
  285. # sis posix : SiS with immediate byte-by-byte comparison during saving
  286. # sis-queue posix : SiS with delayed comparison and deduplication
  287. <%= Dovecot::Conf.attribute(@conf, 'mail_attachment_fs', 'sis posix') %>
  288. # Hash format to use in attachment filenames. You can add any text and
  289. # variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}.
  290. # Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits
  291. <%= Dovecot::Conf.attribute(@conf, 'mail_attachment_hash', '%{sha1}') %>