2 ## Mailbox locations and namespaces
5 # Location for users' mailboxes. The default is empty, which means that Dovecot
6 # tries to find the mailboxes automatically. This won't work if the user
7 # doesn't yet have any mail, so you should explicitly tell Dovecot the full
10 # If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u)
11 # isn't enough. You'll also need to tell Dovecot where the other mailboxes are
12 # kept. This is called the "root mail directory", and it must be the first
13 # path given in the mail_location setting.
15 # There are a few special variables you can use, eg.:
18 # %n - user part in user@domain, same as %u if there's no domain
19 # %d - domain part in user@domain, empty if there's no domain
22 # See doc/wiki/Variables.txt for full list. Some examples:
24 # mail_location = maildir:~/Maildir
25 # mail_location = mbox:~/mail:INBOX=/var/mail/%u
26 # mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n
28 # <doc/wiki/MailLocation.txt>
31 mail_location = maildir:~/.maildir
33 # If you need to set multiple mailbox locations or want to change default
34 # namespace settings, you can do it by defining namespace sections.
36 # You can have private, shared and public namespaces. Private namespaces
37 # are for user's personal mails. Shared namespaces are for accessing other
38 # users' mailboxes that have been shared. Public namespaces are for shared
39 # mailboxes that are managed by sysadmin. If you create any shared or public
40 # namespaces you'll typically want to enable ACL plugin also, otherwise all
41 # users can access all the shared mailboxes, assuming they have permissions
42 # on filesystem level to do so.
44 # Namespace type: private, shared or public
47 # Hierarchy separator to use. You should use the same separator for all
48 # namespaces or some clients get confused. '/' is usually a good one.
49 # The default however depends on the underlying mail storage format.
52 # Prefix required to access this namespace. This needs to be different for
53 # all namespaces. For example "Public/".
56 # Physical location of the mailbox. This is in same format as
57 # mail_location, which is also the default for it.
60 # There can be only one INBOX, and this setting defines which namespace
64 # If namespace is hidden, it's not advertised to clients via NAMESPACE
65 # extension. You'll most likely also want to set list=no. This is mostly
66 # useful when converting from another server with different namespaces which
67 # you want to deprecate but still keep working. For example you can create
68 # hidden namespaces with prefixes "~/mail/", "~%u/mail/" and "mail/".
71 # Show the mailboxes under this namespace with LIST command. This makes the
72 # namespace visible for clients that don't support NAMESPACE extension.
73 # "children" value lists child mailboxes, but hides the namespace prefix.
76 # Namespace handles its own subscriptions. If set to "no", the parent
77 # namespace handles them (empty prefix should always have this as "yes")
80 # See 15-mailboxes.conf for definitions of special mailboxes.
83 # Example shared namespace configuration
88 # Mailboxes are visible under "shared/user@domain/"
89 # %%n, %%d and %%u are expanded to the destination user.
92 # Mail location for other users' mailboxes. Note that %variables and ~/
93 # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the
94 # destination user's data.
95 #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u
97 # Use the default namespace for saving subscriptions.
100 # List the shared/ namespace only if there are visible shared mailboxes.
103 # Should shared INBOX be visible as "shared/user" or "shared/user/INBOX"?
104 #mail_shared_explicit_inbox = no
106 # System user and group used to access mails. If you use multiple, userdb
107 # can override these by returning uid or gid fields. You can use either numbers
108 # or names. <doc/wiki/UserIds.txt>
112 # Group to enable temporarily for privileged operations. Currently this is
113 # used only with INBOX when either its initial creation or dotlocking fails.
114 # Typically this is set to "mail" to give access to /var/mail.
115 #mail_privileged_group =
117 # TODO: AWD: We used to include this. Do we still need it?
118 #mail_privileged_group = mail
120 # Grant access to these supplementary groups for mail processes. Typically
121 # these are used to set up access to shared mailboxes. Note that it may be
122 # dangerous to set these if users can create symlinks (e.g. if "mail" group is
123 # set here, ln -s /var/mail ~/mail/var could allow a user to delete others'
124 # mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it).
125 #mail_access_groups =
127 # Allow full filesystem access to clients. There's no access checks other than
128 # what the operating system does for the active UID/GID. It works with both
129 # maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
131 #mail_full_filesystem_access = no
133 # Dictionary for key=value mailbox attributes. This is used for example by
134 # URLAUTH and METADATA extensions.
135 #mail_attribute_dict =
136 mail_attribute_dict = file:%h/.maildir/dovecot-attributes
138 # A comment or note that is associated with the server. This value is
139 # accessible for authenticated users through the IMAP METADATA server
140 # entry "/shared/comment".
141 #mail_server_comment = ""
143 # Indicates a method for contacting the server administrator. According to
144 # RFC 5464, this value MUST be a URI (e.g., a mailto: or tel: URL), but that
145 # is currently not enforced. Use for example mailto:admin@example.com. This
146 # value is accessible for authenticated users through the IMAP METADATA server
147 # entry "/shared/admin".
154 # Don't use mmap() at all. This is required if you store indexes to shared
155 # filesystems (NFS or clustered filesystem).
158 # Rely on O_EXCL to work when creating dotlock files. NFS supports O_EXCL
159 # since version 3, so this should be safe to use nowadays by default.
160 #dotlock_use_excl = yes
162 # When to use fsync() or fdatasync() calls:
163 # optimized (default): Whenever necessary to avoid losing important data
164 # always: Useful with e.g. NFS when write()s are delayed
165 # never: Never use it (best performance, but crashes can lose data)
166 #mail_fsync = optimized
168 # Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS caches
169 # whenever needed. If you're using only a single mail server this isn't needed.
170 #mail_nfs_storage = no
171 # Mail index files also exist in NFS. Setting this to yes requires
172 # mmap_disable=yes and fsync_disable=no.
175 # Locking method for index files. Alternatives are fcntl, flock and dotlock.
176 # Dotlocking uses some tricks which may create more disk I/O than other locking
177 # methods. NFS users: flock doesn't work, remember to change mmap_disable.
180 # Directory in which LDA/LMTP temporarily stores incoming mails >128 kB.
181 #mail_temp_dir = /tmp
183 # Valid UID range for users, defaults to 500 and above. This is mostly
184 # to make sure that users can't log in as daemons or other system users.
185 # Note that denying root logins is hardcoded to dovecot binary and can't
186 # be done even if first_valid_uid is set to 0.
187 #first_valid_uid = 500
190 # Valid GID range for users, defaults to non-root/wheel. Users having
191 # non-valid GID as primary group ID aren't allowed to log in. If user
192 # belongs to supplementary groups with non-valid GIDs, those groups are
197 # Maximum allowed length for mail keyword name. It's only forced when trying
198 # to create new keywords.
199 #mail_max_keyword_length = 50
201 # ':' separated list of directories under which chrooting is allowed for mail
202 # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
203 # This setting doesn't affect login_chroot, mail_chroot or auth chroot
204 # settings. If this setting is empty, "/./" in home dirs are ignored.
205 # WARNING: Never add directories here which local users can modify, that
206 # may lead to root exploit. Usually this should be done only if you don't
207 # allow shell access for users. <doc/wiki/Chrooting.txt>
210 # Default chroot directory for mail processes. This can be overridden for
211 # specific users in user database by giving /./ in user's home directory
212 # (eg. /home/./user chroots into /home). Note that usually there is no real
213 # need to do chrooting, Dovecot doesn't allow users to access files outside
214 # their mail directory anyway. If your home directories are prefixed with
215 # the chroot directory, append "/." to mail_chroot. <doc/wiki/Chrooting.txt>
218 # UNIX socket path to master authentication server to find users.
219 # This is used by imap (for shared users) and lda.
220 #auth_socket_path = /var/run/dovecot/auth-userdb
222 # Directory where to look up mail plugins.
223 #mail_plugin_dir = /usr/lib/dovecot/modules
225 # Space separated list of plugins to load for all services. Plugins specific to
226 # IMAP, LDA, etc. are added to this list in their own .conf files.
230 ## Mailbox handling optimizations
233 # Mailbox list indexes can be used to optimize IMAP STATUS commands. They are
234 # also required for IMAP NOTIFY extension to be enabled.
235 #mailbox_list_index = no
237 # Trust mailbox list index to be up-to-date. This reduces disk I/O at the cost
238 # of potentially returning out-of-date results after e.g. server crashes.
239 # The results will be automatically fixed once the folders are opened.
240 #mailbox_list_index_very_dirty_syncs = yes
242 # Should INBOX be kept up-to-date in the mailbox list index? By default it's
243 # not, because most of the mailbox accesses will open INBOX anyway.
244 #mailbox_list_index_include_inbox = no
246 # The minimum number of mails in a mailbox before updates are done to cache
247 # file. This allows optimizing Dovecot's behavior to do less disk writes at
248 # the cost of more disk reads.
249 #mail_cache_min_mail_count = 0
251 # When IDLE command is running, mailbox is checked once in a while to see if
252 # there are any new mails or other changes. This setting defines the minimum
253 # time to wait between those checks. Dovecot can also use inotify and
254 # kqueue to find out immediately when changes occur.
255 #mailbox_idle_check_interval = 30 secs
257 # Save mails with CR+LF instead of plain LF. This makes sending those mails
258 # take less CPU, especially with sendfile() syscall with Linux and FreeBSD.
259 # But it also creates a bit more disk I/O which may just make it slower.
260 # Also note that if other software reads the mboxes/maildirs, they may handle
261 # the extra CRs wrong and cause problems.
264 # Max number of mails to keep open and prefetch to memory. This only works with
265 # some mailbox formats and/or operating systems.
266 #mail_prefetch_count = 0
268 # How often to scan for stale temporary files and delete them (0 = never).
269 # These should exist only after Dovecot dies in the middle of saving mails.
270 #mail_temp_scan_interval = 1w
272 # How many slow mail accesses sorting can perform before it returns failure.
273 # With IMAP the reply is: NO [LIMIT] Requested sort would have taken too long.
274 # The untagged SORT reply is still returned, but it's likely not correct.
275 #mail_sort_max_read_count = 0
277 protocol !indexer-worker {
278 # If folder vsize calculation requires opening more than this many mails from
279 # disk (i.e. mail sizes aren't in cache already), return failure and finish
280 # the calculation via indexer process. Disabled by default. This setting must
281 # be 0 for indexer-worker processes.
282 #mail_vsize_bg_after_count = 0
286 ## Maildir-specific settings
289 # By default LIST command returns all entries in maildir beginning with a dot.
290 # Enabling this option makes Dovecot return only entries which are directories.
291 # This is done by stat()ing each entry, so it causes more disk I/O.
292 # (For systems setting struct dirent->d_type, this check is free and it's
293 # done always regardless of this setting)
294 #maildir_stat_dirs = no
296 # When copying a message, do it with hard links whenever possible. This makes
297 # the performance much better, and it's unlikely to have any side effects.
298 #maildir_copy_with_hardlinks = yes
300 # Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only
301 # when its mtime changes unexpectedly or when we can't find the mail otherwise.
302 #maildir_very_dirty_syncs = no
304 # If enabled, Dovecot doesn't use the S=<size> in the Maildir filenames for
305 # getting the mail's physical size, except when recalculating Maildir++ quota.
306 # This can be useful in systems where a lot of the Maildir filenames have a
307 # broken size. The performance hit for enabling this is very small.
308 #maildir_broken_filename_sizes = no
310 # Always move mails from new/ directory to cur/, even when the \Recent flags
311 # aren't being reset.
312 #maildir_empty_new = no
315 ## mbox-specific settings
318 # Which locking methods to use for locking mbox. There are four available:
319 # dotlock: Create <mailbox>.lock file. This is the oldest and most NFS-safe
320 # solution. If you want to use /var/mail/ like directory, the users
321 # will need write access to that directory.
322 # dotlock_try: Same as dotlock, but if it fails because of permissions or
323 # because there isn't enough disk space, just skip it.
324 # fcntl : Use this if possible. Works with NFS too if lockd is used.
325 # flock : May not exist in all systems. Doesn't work with NFS.
326 # lockf : May not exist in all systems. Doesn't work with NFS.
328 # You can use multiple locking methods; if you do the order they're declared
329 # in is important to avoid deadlocks if other MTAs/MUAs are using multiple
330 # locking methods as well. Some operating systems don't allow using some of
331 # them simultaneously.
333 # The Debian value for mbox_write_locks differs from upstream Dovecot. It is
334 # changed to be compliant with Debian Policy (section 11.6) for NFS safety.
335 # Dovecot: mbox_write_locks = dotlock fcntl
336 # Debian: mbox_write_locks = fcntl dotlock
338 #mbox_read_locks = fcntl
339 #mbox_write_locks = fcntl dotlock
341 # Maximum time to wait for lock (all of them) before aborting.
342 #mbox_lock_timeout = 5 mins
344 # If dotlock exists but the mailbox isn't modified in any way, override the
345 # lock file after this much time.
346 #mbox_dotlock_change_timeout = 2 mins
348 # When mbox changes unexpectedly we have to fully read it to find out what
349 # changed. If the mbox is large this can take a long time. Since the change
350 # is usually just a newly appended mail, it'd be faster to simply read the
351 # new mails. If this setting is enabled, Dovecot does this but still safely
352 # fallbacks to re-reading the whole mbox file whenever something in mbox isn't
353 # how it's expected to be. The only real downside to this setting is that if
354 # some other MUA changes message flags, Dovecot doesn't notice it immediately.
355 # Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK
357 #mbox_dirty_syncs = yes
359 # Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE,
360 # EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored.
361 #mbox_very_dirty_syncs = no
363 # Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK
364 # commands and when closing the mailbox). This is especially useful for POP3
365 # where clients often delete all mails. The downside is that our changes
366 # aren't immediately visible to other MUAs.
367 #mbox_lazy_writes = yes
369 # If mbox size is smaller than this (e.g. 100k), don't write index files.
370 # If an index file already exists it's still read, just not updated.
371 #mbox_min_index_size = 0
373 # Mail header selection algorithm to use for MD5 POP3 UIDLs when
374 # pop3_uidl_format=%m. For backwards compatibility we use apop3d inspired
375 # algorithm, but it fails if the first Received: header isn't unique in all
376 # mails. An alternative algorithm is "all" that selects all headers.
380 ## mdbox-specific settings
383 # Maximum dbox file size until it's rotated.
384 #mdbox_rotate_size = 2M
386 # Maximum dbox file age until it's rotated. Typically in days. Day begins
387 # from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled.
388 #mdbox_rotate_interval = 0
390 # When creating new mdbox files, immediately preallocate their size to
391 # mdbox_rotate_size. This setting currently works only in Linux with some
392 # filesystems (ext4, xfs).
393 #mdbox_preallocate_space = no
399 # sdbox and mdbox support saving mail attachments to external files, which
400 # also allows single instance storage for them. Other backends don't support
403 # Directory root where to store mail attachments. Disabled, if empty.
404 #mail_attachment_dir =
406 # Attachments smaller than this aren't saved externally. It's also possible to
407 # write a plugin to disable saving specific attachments externally.
408 #mail_attachment_min_size = 128k
410 # Filesystem backend to use for saving attachments:
411 # posix : No SiS done by Dovecot (but this might help FS's own deduplication)
412 # sis posix : SiS with immediate byte-by-byte comparison during saving
413 # sis-queue posix : SiS with delayed comparison and deduplication
414 #mail_attachment_fs = sis posix
416 # Hash format to use in attachment filenames. You can add any text and
417 # variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}.
418 # Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits
419 #mail_attachment_hash = %{sha1}