10-mail.conf.erb 14 KB

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