howto/SetupDovecot: dovecot.conf

File dovecot.conf, 41.8 KB (added by martin.osx@…, 13 years ago)

Dovcot configuration file.

Line 
1## Dovecot configuration file
2
3# If you're in a hurry, see http://wiki.dovecot.org/QuickConfiguration
4
5# "dovecot -n" command gives a clean output of the changed settings. Use it
6# instead of copy&pasting this file when posting to the Dovecot mailing list.
7
8# '#' character and everything after it is treated as comments. Extra spaces
9# and tabs are ignored. If you want to use either of these explicitly, put the
10# value inside quotes, eg.: key = "# char and trailing whitespace  "
11
12# Default values are shown for each setting, it's not required to uncomment
13# any of the lines. Exception to this are paths, they're just examples with
14# the real defaults being based on configure options. The paths listed here
15# are for configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
16# --with-ssldir=/etc/ssl
17
18# Base directory where to store runtime data.
19base_dir = /opt/local/var/run/dovecot/
20
21# Protocols we want to be serving: imap imaps pop3 pop3s
22# If you only want to use dovecot-auth, you can set this to "none".
23#protocols = imap imaps
24
25# IP or host address where to listen in for connections. It's not currently
26# possible to specify multiple addresses. "*" listens in all IPv4 interfaces.
27# "[::]" listens in all IPv6 interfaces, but may also listen in all IPv4
28# interfaces depending on the operating system.
29#
30# If you want to specify ports for each service, you will need to configure
31# these settings inside the protocol imap/pop3 { ... } section, so you can
32# specify different ports for IMAP/POP3. For example:
33#   protocol imap {
34#     listen = *:10143
35#     ssl_listen = *:10943
36#     ..
37#   }
38#   protocol pop3 {
39#     listen = *:10100
40#     ..
41#   }
42listen = *
43
44# Disable LOGIN command and all other plaintext authentications unless
45# SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP
46# matches the local IP (ie. you're connecting from the same computer), the
47# connection is considered secure and plaintext authentication is allowed.
48disable_plaintext_auth = no
49
50# Should all IMAP and POP3 processes be killed when Dovecot master process
51# shuts down. Setting this to "no" means that Dovecot can be upgraded without
52# forcing existing client connections to close (although that could also be
53# a problem if the upgrade is eg. because of a security fix). This however
54# means that after master process has died, the client processes can't write
55# to log files anymore.
56#shutdown_clients = yes
57
58##
59## Logging
60##
61
62# Log file to use for error messages, instead of sending them to syslog.
63# /dev/stderr can be used to log into stderr.
64log_path = /opt/local/var/log/dovecot/error
65
66# Log file to use for informational and debug messages.
67# Default is the same as log_path.
68info_log_path = /opt/local/var/log/dovecot/info
69
70# Prefix for each line written to log file. % codes are in strftime(3)
71# format.
72log_timestamp = "%b %d %H:%M:%S "
73
74# Syslog facility to use if you're logging to syslog. Usually if you don't
75# want to use "mail", you'll use local0..local7. Also other standard
76# facilities are supported.
77#syslog_facility = mail
78
79##
80## SSL settings
81##
82
83# IP or host address where to listen in for SSL connections. Defaults
84# to above if not specified.
85#ssl_listen =
86
87# Disable SSL/TLS support.
88ssl_disable = no
89
90# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
91# dropping root privileges, so keep the key file unreadable by anyone but
92# root. Included doc/mkcert.sh can be used to easily generate self-signed
93# certificate, just make sure to update the domains in dovecot-openssl.cnf
94ssl_cert_file = /opt/local/etc/ssl/certs/dovecot.pem
95ssl_key_file = /opt/local/etc/ssl/private/dovecot.pem
96
97# If key file is password protected, give the password here. Alternatively
98# give it when starting dovecot with -p parameter.
99#ssl_key_password =
100
101# File containing trusted SSL certificate authorities. Usually not needed.
102# The CAfile should contain the CA-certificate(s) followed by the matching
103# CRL(s). CRL checking is new in dovecot .rc1
104#ssl_ca_file =
105
106# Request client to send a certificate. If you also want to require it, set
107# ssl_require_client_cert=yes in auth section.
108#ssl_verify_client_cert = no
109
110# How often to regenerate the SSL parameters file. Generation is quite CPU
111# intensive operation. The value is in hours, 0 disables regeneration
112# entirely.
113#ssl_parameters_regenerate = 168
114
115# SSL ciphers to use
116#ssl_cipher_list = ALL:!LOW
117
118# Show protocol level SSL errors.
119#verbose_ssl = yes
120
121##
122## Login processes
123##
124
125# <doc/wiki/LoginProcess.txt>
126
127# Directory where authentication process places authentication UNIX sockets
128# which login needs to be able to connect to. The sockets are created when
129# running as root, so you don't have to worry about permissions. Note that
130# everything in this directory is deleted when Dovecot is started.
131login_dir = /opt/local/var/run/dovecot/login
132
133# chroot login process to the login_dir. Only reason not to do this is if you
134# wish to run the whole Dovecot without roots. <doc/wiki/Rootless.txt>
135#login_chroot = yes
136
137# User to use for the login process. Create a completely new user for this,
138# and don't use it anywhere else. The user must also belong to a group where
139# only it has access, it's used to control access for authentication process.
140# Note that this user is NOT used to access mails. <doc/wiki/UserIds.txt>
141# login_user = _dovecot
142
143# Set max. process size in megabytes. If you don't use
144# login_process_per_connection you might need to grow this.
145#login_process_size = 32
146
147# Should each login be processed in it's own process (yes), or should one
148# login process be allowed to process multiple connections (no)? Yes is more
149# secure, espcially with SSL/TLS enabled. No is faster since there's no need
150# to create processes all the time.
151#login_process_per_connection = yes
152
153# Number of login processes to keep for listening new connections.
154#login_processes_count = 3
155
156# Maximum number of login processes to create. The listening process count
157# usually stays at login_processes_count, but when multiple users start logging
158# in at the same time more extra processes are created. To prevent fork-bombing
159# we check only once in a second if new processes should be created - if all
160# of them are used at the time, we double their amount until the limit set by
161# this setting is reached.
162#login_max_processes_count = 128
163
164# Maximum number of connections allowed per each login process. This setting
165# is used only if login_process_per_connection=no. Once the limit is reached,
166# the process notifies master so that it can create a new login process.
167# You should make sure that the process has at least
168# 16 + login_max_connections * 2 available file descriptors.
169#login_max_connections = 256
170
171# Greeting message for clients.
172#login_greeting = Dovecot ready.
173
174# Space-separated list of elements we want to log. The elements which have
175# a non-empty variable value are joined together to form a comma-separated
176# string.
177login_log_format_elements = user=<%u> method=%m rip=%r lip=%l %c
178
179# Login log format. %$ contains login_log_format_elements string, %s contains
180# §:the data we want to log.
181login_log_format = %$: %s
182
183##
184## Mailbox locations and namespaces
185##
186
187# Location for users' mailboxes. This is the same as the old default_mail_env
188# setting. The default is empty, which means that Dovecot tries to find the
189# mailboxes automatically. This won't work if the user doesn't have any mail
190# yet, so you should explicitly tell Dovecot the full location.
191#
192# If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u)
193# isn't enough. You'll also need to tell Dovecot where the other mailboxes are
194# kept. This is called the "root mail directory", and it must be the first
195# path given in the mail_location setting.
196#
197# There are a few special variables you can use, eg.:
198#
199#   %u - username
200#   %n - user part in user@domain, same as %u if there's no domain
201#   %d - domain part in user@domain, empty if there's no domain
202#   %h - home directory
203#
204# See doc/wiki/Variables.txt for full list. Some examples:
205#
206#   mail_location = maildir:~/Maildir
207#   mail_location = mbox:~/mail:INBOX=/var/mail/%u
208#   mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n
209#
210# <doc/wiki/MailLocation.txt>
211#
212mail_location = maildir:/private/srv/mail/%u
213
214# If you need to set multiple mailbox locations or want to change default
215# namespace settings, you can do it by defining namespace sections.
216# NOTE: Namespaces currently work ONLY with IMAP! POP3 and LDA currently ignore
217# namespaces completely, they use only the mail_location setting.
218#
219# You can have private, shared and public namespaces. The only difference
220# between them is how Dovecot announces them to client via NAMESPACE
221# extension. Shared namespaces are meant for user-owned mailboxes which are
222# shared to other users, while public namespaces are for more globally
223# accessible mailboxes.
224#
225# REMEMBER: If you add any namespaces, the default namespace must be added
226# explicitly, ie. mail_location does nothing unless you have a namespace
227# without a location setting. Default namespace is simply done by having a
228# namespace with empty prefix.
229#namespace private {
230   # Hierarchy separator to use. You should use the same separator for all
231   # namespaces or some clients get confused. '/' is usually a good one.
232   # The default however depends on the underlying mail storage format.
233   #separator =
234
235   # Prefix required to access this namespace. This needs to be different for
236   # all namespaces. For example "Public/".
237   #prefix =
238
239   # Physical location of the mailbox. This is in same format as
240   # mail_location, which is also the default for it.
241   #location =
242
243   # There can be only one INBOX, and this setting defines which namespace
244   # has it.
245   #inbox = yes
246
247   # If namespace is hidden, it's not advertised to clients via NAMESPACE
248   # extension or shown in LIST replies. This is mostly useful when converting
249   # from another server with different namespaces which you want to depricate
250   # but still keep working. For example you can create hidden namespaces with
251   # prefixes "~/mail/", "~%u/mail/" and "mail/".
252   #hidden = yes
253#}
254
255# Grant access to these extra groups for mail processes. Typical use would be
256# to give "mail" group write access to /var/mail to be able to create dotlocks.
257#mail_extra_groups =
258
259# Allow full filesystem access to clients. There's no access checks other than
260# what the operating system does for the active UID/GID. It works with both
261# maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/
262# or ~user/.
263#mail_full_filesystem_access = no
264
265##
266## Mail processes
267##
268
269# Enable mail process debugging. This can help you figure out why Dovecot
270# isn't finding your mails.
271#mail_debug = yes
272
273# Log prefix for mail processes. See doc/wiki/Variables.txt for list of
274# possible variables you can use.
275mail_log_prefix = "%Us(%u): "
276
277# Max. number of lines a mail process is allowed to log per second before it's
278# throttled. 0 means unlimited. Typically there's no need to change this
279# unless you're using mail_log plugin, which may log a lot.
280#mail_log_max_lines_per_sec = 10
281
282# Don't use mmap() at all. This is required if you store indexes to shared
283# filesystems (NFS or clustered filesystem).
284#mmap_disable = no
285
286# Don't write() to mmaped files. This is required for some operating systems
287# which use separate caches for them, such as OpenBSD.
288#mmap_no_write = no
289
290# Rely on O_EXCL to work when creating dotlock files. The default is to use
291# hard linking. O_EXCL makes the dotlocking faster, but it doesn't always
292# work with NFS.
293#dotlock_use_excl = no
294
295# Don't use fsync() or fdatasync() calls. This makes the performance better
296# at the cost of potential data loss if the server (or the file server)
297# goes down.
298#fsync_disable = no
299
300# Locking method for index files. Alternatives are fcntl, flock and dotlock.
301# Dotlocking uses some tricks which may create more disk I/O than other locking
302# methods. NFS users: flock doesn't work, remember to change mmap_disable.
303#lock_method = fcntl
304
305# Drop all privileges before exec()ing the mail process. This is mostly
306# meant for debugging, otherwise you don't get core dumps. It could be a small
307# security risk if you use single UID for multiple users, as the users could
308# ptrace() each others processes then.
309#mail_drop_priv_before_exec = no
310
311# Show more verbose process titles (in ps). Currently shows user name and
312# IP address. Useful for seeing who are actually using the IMAP processes
313# (eg. shared mailboxes or if same uid is used for multiple accounts).
314#verbose_proctitle = no
315
316# Valid UID range for users, defaults to 500 and above. This is mostly
317# to make sure that users can't log in as daemons or other system users.
318# Note that denying root logins is hardcoded to dovecot binary and can't
319# be done even if first_valid_uid is set to 0.
320#first_valid_uid = 500
321#last_valid_uid = 0
322
323# Valid GID range for users, defaults to non-root/wheel. Users having
324# non-valid GID as primary group ID aren't allowed to log in. If user
325# belongs to supplementary groups with non-valid GIDs, those groups are
326# not set.
327#first_valid_gid = 1
328#last_valid_gid = 0
329
330# Maximum number of running mail processes. When this limit is reached,
331# new users aren't allowed to log in.
332#max_mail_processes = 1024
333
334# Set max. process size in megabytes. Most of the memory goes to mmap()ing
335# files, so it shouldn't harm much even if this limit is set pretty high.
336#mail_process_size = 256
337
338# Maximum allowed length for mail keyword name. It's only forced when trying
339# to create new keywords.
340#mail_max_keyword_length = 50
341
342# ':' separated list of directories under which chrooting is allowed for mail
343# processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too).
344# This setting doesn't affect login_chroot or auth chroot variables.
345# WARNING: Never add directories here which local users can modify, that
346# may lead to root exploit. Usually this should be done only if you don't
347# allow shell access for users. <doc/wiki/Chrooting.txt>
348#valid_chroot_dirs =
349
350# Default chroot directory for mail processes. This can be overridden for
351# specific users in user database by giving /./ in user's home directory
352# (eg. /home/./user chroots into /home). Note that usually there is no real
353# need to do chrooting, Dovecot doesn't allow users to access files outside
354# their mail directory anyway. <doc/wiki/Chrooting.txt>
355#mail_chroot =
356
357##
358## Mailbox handling optimizations
359##
360
361# Space-separated list of fields to initially save into cache file. Currently
362# these fields are allowed:
363#
364#  flags, date.sent, date.received, size.virtual, size.physical
365#  mime.parts, imap.body, imap.bodystructure
366#
367# Different IMAP clients work in different ways, so they benefit from
368# different cached fields. Some do not benefit from them at all. Caching more
369# than necessary generates useless disk I/O, so you don't want to do that
370# either.
371#
372# Dovecot attempts to automatically figure out what client wants and it keeps
373# only that. However the first few times a mailbox is opened, Dovecot hasn't
374# yet figured out what client needs, so it may not perform optimally. If you
375# know what fields the majority of your clients need, it may be useful to set
376# these fields by hand. If client doesn't actually use them, Dovecot will
377# eventually drop them.
378#
379# Usually you should just leave this field alone. The potential benefits are
380# typically unnoticeable.
381#mail_cache_fields =
382
383# Space-separated list of fields that Dovecot should never save to cache file.
384# Useful if you want to save disk space at the cost of more I/O when the fields
385# needed.
386#mail_never_cache_fields =
387
388# The minimum number of mails in a mailbox before updates are done to cache
389# file. This allows optimizing Dovecot's behavior to do less disk writes at
390# the cost of more disk reads.
391#mail_cache_min_mail_count = 0
392
393# When IDLE command is running, mailbox is checked once in a while to see if
394# there are any new mails or other changes. This setting defines the minimum
395# time to wait between those checks. Dovecot is however able to use dnotify
396# and inotify with Linux to reply immediately after the change occurs.
397#mailbox_idle_check_interval = 30
398
399# Save mails with CR+LF instead of plain LF. This makes sending those mails
400# take less CPU, especially with sendfile() syscall with Linux and FreeBSD.
401# But it also creates a bit more disk I/O which may just make it slower.
402# Also note that if other software reads the mboxes/maildirs, they may handle
403# the extra CRs wrong and cause problems.
404#mail_save_crlf = no
405
406##
407## Maildir-specific settings
408##
409
410# By default LIST command returns all entries in maildir beginning with a dot.
411# Enabling this option makes Dovecot return only entries which are directories.
412# This is done by stat()ing each entry, so it causes more disk I/O.
413# (For systems setting struct dirent->d_type, this check is free and it's
414# done always regardless of this setting)
415#maildir_stat_dirs = no
416
417# When copying a message, do it with hard links whenever possible. This makes
418# the performance much better, and it's unlikely to have any side effects.
419#maildir_copy_with_hardlinks = no
420
421# When copying a message, try to preserve the base filename. Only if the
422# destination mailbox already contains the same name (ie. the mail is being
423# copied there twice), a new name is given. The destination filename check is
424# done only by looking at dovecot-uidlist file, so if something outside
425# Dovecot does similar filename preserving copies, you may run into problems.
426# NOTE: This setting requires maildir_copy_with_hardlinks = yes to work.
427#maildir_copy_preserve_filename = no
428
429##
430## mbox-specific settings
431##
432
433# Which locking methods to use for locking mbox. There are four available:
434#  dotlock: Create <mailbox>.lock file. This is the oldest and most NFS-safe
435#           solution. If you want to use /var/mail/ like directory, the users
436#           will need write access to that directory.
437#  fcntl  : Use this if possible. Works with NFS too if lockd is used.
438#  flock  : May not exist in all systems. Doesn't work with NFS.
439#  lockf  : May not exist in all systems. Doesn't work with NFS.
440#
441# You can use multiple locking methods; if you do the order they're declared
442# in is important to avoid deadlocks if other MTAs/MUAs are using multiple
443# locking methods as well. Some operating systems don't allow using some of
444# them simultaneously.
445#mbox_read_locks = fcntl
446#mbox_write_locks = dotlock fcntl
447
448# Maximum time in seconds to wait for lock (all of them) before aborting.
449#mbox_lock_timeout = 300
450
451# If dotlock exists but the mailbox isn't modified in any way, override the
452# lock file after this many seconds.
453#mbox_dotlock_change_timeout = 120
454
455# When mbox changes unexpectedly we have to fully read it to find out what
456# changed. If the mbox is large this can take a long time. Since the change
457# is usually just a newly appended mail, it'd be faster to simply read the
458# new mails. If this setting is enabled, Dovecot does this but still safely
459# fallbacks to re-reading the whole mbox file whenever something in mbox isn't
460# how it's expected to be. The only real downside to this setting is that if
461# some other MUA changes message flags, Dovecot doesn't notice it immediately.
462# Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK
463# commands.
464#mbox_dirty_syncs = yes
465
466# Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE,
467# EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored.
468#mbox_very_dirty_syncs = no
469
470# Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK
471# commands and when closing the mailbox). This is especially useful for POP3
472# where clients often delete all mails. The downside is that our changes
473# aren't immediately visible to other MUAs.
474#mbox_lazy_writes = yes
475
476# If mbox size is smaller than this (in kilobytes), don't write index files.
477# If an index file already exists it's still read, just not updated.
478#mbox_min_index_size = 0
479
480##
481## dbox-specific settings
482##
483
484# Maximum dbox file size in kilobytes until it's rotated.
485#dbox_rotate_size = 2048
486
487# Minimum dbox file size in kilobytes before it's rotated
488# (overrides dbox_rotate_days)
489#dbox_rotate_min_size = 16
490
491# Maximum dbox file age in days until it's rotated. Day always begins from
492# midnight, so 1 = today, 2 = yesterday, etc. 0 = check disabled.
493#dbox_rotate_days = 0
494
495##
496## IMAP specific settings
497##
498
499protocol imap {
500  # Login executable location.
501  login_executable = /opt/local/libexec/dovecot/imap-login
502
503  # IMAP executable location. Changing this allows you to execute other
504  # binaries before the imap process is executed.
505  #
506  # This would write rawlogs into ~/dovecot.rawlog/ directory:
507  #   mail_executable = /usr/libexec/dovecot/rawlog /usr/libexec/dovecot/imap
508  #
509  # This would attach gdb into the imap process and write backtraces into
510  # /tmp/gdbhelper.* files:
511  #   mail_executable = /usr/lib64/dovecot/gdbhelper /usr/lib64/dovecot/imap
512  #
513  mail_executable = /opt/local/libexec/dovecot/imap
514
515  # Maximum IMAP command line length in bytes. Some clients generate very long
516  # command lines with huge mailboxes, so you may need to raise this if you get
517  # "Too long argument" or "IMAP command line too large" errors often.
518  #imap_max_line_length = 65536
519
520  # Support for dynamically loadable plugins. mail_plugins is a space separated
521  # list of plugins to load.
522  # mail_plugins =lib01_acl_plugin
523  mail_plugin_dir = /opt/local/lib/dovecot/imap
524
525  # Send IMAP capabilities in greeting message. This makes it unnecessary for
526  # clients to request it with CAPABILITY command, so it saves one round-trip.
527  # Many clients however don't understand it and ask the CAPABILITY anyway.
528  login_greeting_capability = yes
529
530  # Override the IMAP CAPABILITY response.
531  #imap_capability =
532
533  # Workarounds for various client bugs:
534  #   delay-newmail:
535  #     Send EXISTS/RECENT new mail notifications only when replying to NOOP
536  #     and CHECK commands. Some clients ignore them otherwise, for example OSX
537  #     Mail (<v2.1). Outlook Express breaks more badly though, without this it
538  #     may show user "Message no longer in server" errors. Note that OE6 still
539  #     breaks even with this workaround if synchronization is set to
540  #     "Headers Only".
541  #   outlook-idle:
542  #     Outlook and Outlook Express never abort IDLE command, so if no mail
543  #     arrives in half a hour, Dovecot closes the connection. This is still
544  #     fine, except Outlook doesn't connect back so you don't see if new mail
545  #     arrives.
546  #   netscape-eoh:
547  #     Netscape 4.x breaks if message headers don't end with the empty "end of
548  #     headers" line. Normally all messages have this, but setting this
549  #     workaround makes sure that Netscape never breaks by adding the line if
550  #     it doesn't exist. This is done only for FETCH BODY[HEADER.FIELDS..]
551  #     commands. Note that RFC says this shouldn't be done.
552  #   tb-extra-mailbox-sep:
553  #     With mbox storage a mailbox can contain either mails or submailboxes,
554  #     but not both. Thunderbird separates these two by forcing server to
555  #     accept '/' suffix in mailbox names in subscriptions list.
556  # The list is space-separated.
557  #imap_client_workarounds = outlook-idle
558}
559 
560##
561## POP3 specific settings
562##
563
564protocol pop3 {
565  # Login executable location.
566  login_executable = /opt/local/libexec/dovecot/pop3-login
567
568  # POP3 executable location. See IMAP's mail_executable above for examples
569  # how this could be changed.
570  mail_executable = /opt/local/libexec/dovecot/pop3
571
572  # Don't try to set mails non-recent or seen with POP3 sessions. This is
573  # mostly intended to reduce disk I/O. With maildir it doesn't move files
574  # from new/ to cur/, with mbox it doesn't write Status-header.
575  #pop3_no_flag_updates = no
576
577  # Support LAST command which exists in old POP3 specs, but has been removed
578  # from new ones. Some clients still wish to use this though. Enabling this
579  # makes RSET command clear all \Seen flags from messages.
580  #pop3_enable_last = no
581
582  # If mail has X-UIDL header, use it as the mail's UIDL.
583  #pop3_reuse_xuidl = no
584
585  # Keep the mailbox locked for the entire POP3 session.
586  #pop3_lock_session = no
587
588  # POP3 UIDL (unique mail identifier) format to use. You can use following
589  # variables:
590  #
591  #  %v - Mailbox's IMAP UIDVALIDITY
592  #  %u - Mail's IMAP UID
593  #  %m - MD5 sum of the mailbox headers in hex (mbox only)
594  #  %f - filename (maildir only)
595  #
596  # If you want UIDL compatibility with other POP3 servers, use:
597  #  UW's ipop3d         : %08Xv%08Xu
598  #  Courier version 0   : %f
599  #  Courier version 1   : %u
600  #  Courier version 2   : %v-%u
601  #  Cyrus (<= 2.1.3)    : %u
602  #  Cyrus (>= 2.1.4)    : %v.%u
603  #  Older Dovecots      : %v.%u
604  #  tpop3d              : %Mf
605  #
606  # Note that Outlook 2003 seems to have problems with %v.%u format which was
607  # Dovecot's default, so if you're building a new server it would be a good
608  # idea to change this. %08Xu%08Xv should be pretty fail-safe.
609  #
610  # NOTE: Nowadays this is required to be set explicitly, since the old
611  # default was bad but it couldn't be changed without breaking existing
612  # installations. %08Xu%08Xv will be the new default, so use it for new
613  # installations.
614  #
615  #pop3_uidl_format =
616
617  # POP3 logout format string:
618  #  %t - number of TOP commands
619  #  %p - number of bytes sent to client as a result of TOP command
620  #  %r - number of RETR commands
621  #  %b - number of bytes sent to client as a result of RETR command
622  #  %d - number of deleted messages
623  #  %m - number of messages (before deletion)
624  #  %s - mailbox size in bytes (before deletion)
625  #pop3_logout_format = top=%t/%p, retr=%r/%b, del=%d/%m, size=%s
626
627  # Support for dynamically loadable plugins. mail_plugins is a space separated
628  # list of plugins to load.
629  #mail_plugins =
630  mail_plugin_dir = /opt/local/lib/dovecot/pop3
631
632  # Workarounds for various client bugs:
633  #   outlook-no-nuls:
634  #     Outlook and Outlook Express hang if mails contain NUL characters.
635  #     This setting replaces them with 0x80 character.
636  #   oe-ns-eoh:
637  #     Outlook Express and Netscape Mail breaks if end of headers-line is
638  #     missing. This option simply sends it if it's missing.
639  # The list is space-separated.
640  #pop3_client_workarounds =
641}
642
643##
644## LDA specific settings
645##
646
647protocol lda {
648  # Address to use when sending rejection mails.
649  postmaster_address = postmaster@my_domain.com
650
651  # Hostname to use in various parts of sent mails, eg. in Message-Id.
652  # Default is the system's real hostname.
653  #hostname =
654
655  # Support for dynamically loadable plugins. mail_plugins is a space separated
656  # list of plugins to load.
657  #mail_plugins =
658  mail_plugin_dir = /opt/local/lib/dovecot/lda
659
660  # Binary to use for sending mails.
661  #sendmail_path = /usr/lib/sendmail
662
663  # UNIX socket path to master authentication server to find users.
664  auth_socket_path = /opt/local/var/run/dovecot/auth-master
665}
666
667##
668## Authentication processes
669##
670
671# Executable location
672auth_executable = /opt/local/libexec/dovecot/dovecot-auth
673
674# Set max. process size in megabytes.
675#auth_process_size = 256
676
677# Authentication cache size in kilobytes. 0 means it's disabled.
678# Note that bsdauth, PAM and vpopmail require cache_key to be set for caching
679# to be used.
680#auth_cache_size = 0
681# Time to live in seconds for cached data. After this many seconds the cached
682# record is no longer used, *except* if the main database lookup returns
683# internal failure. We also try to handle password changes automatically: If
684# user's previous authentication was successful, but this one wasn't, the
685# cache isn't used. For now this works only with plaintext authentication.
686#auth_cache_ttl = 3600
687
688# Space separated list of realms for SASL authentication mechanisms that need
689# them. You can leave it empty if you don't want to support multiple realms.
690# Many clients simply use the first one listed here, so keep the default realm
691# first.
692#auth_realms =
693
694# Default realm/domain to use if none was specified. This is used for both
695# SASL realms and appending @domain to username in plaintext logins.
696#auth_default_realm =
697
698# List of allowed characters in username. If the user-given username contains
699# a character not listed in here, the login automatically fails. This is just
700# an extra check to make sure user can't exploit any potential quote escaping
701# vulnerabilities with SQL/LDAP databases. If you want to allow all characters,
702# set this value to empty.
703#auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@
704
705# Username character translations before it's looked up from databases. The
706# value contains series of from -> to characters. For example "#@/@" means
707# that '#' and '/' characters are translated to '@'.
708#auth_username_translation =
709
710# Username formatting before it's looked up from databases. You can use
711# the standard variables here, eg. %Lu would lowercase the username, %n would
712# drop away the domain if it was given, or "%n-AT-%d" would change the '@' into
713# "-AT-". This translation is done after auth_username_translation changes.
714#auth_username_format =
715
716# If you want to allow master users to log in by specifying the master
717# username within the normal username string (ie. not using SASL mechanism's
718# support for it), you can specify the separator character here. The format
719# is then <username><separator><master username>. UW-IMAP uses "*" as the
720# separator, so that could be a good choice.
721#auth_master_user_separator =
722
723# Username to use for users logging in with ANONYMOUS SASL mechanism
724#auth_anonymous_username = anonymous
725
726# More verbose logging. Useful for figuring out why authentication isn't
727# working.
728#auth_verbose = yes
729
730# Even more verbose logging for debugging purposes. Shows for example SQL
731# queries.
732#auth_debug = yes
733
734# In case of password mismatches, log the passwords and used scheme so the
735# problem can be debugged. Requires auth_debug=yes to be set.
736#auth_debug_passwords = yes
737
738# Maximum number of dovecot-auth worker processes. They're used to execute
739# blocking passdb and userdb queries (eg. MySQL and PAM). They're
740# automatically created and destroyed as needed.
741#auth_worker_max_count = 30
742
743# Host name to use in GSSAPI principal names. The default is to use the
744# name returned by gethostname().
745#auth_gssapi_hostname =
746
747# Kerberos keytab to use for the GSSAPI mechanism. Will use the system
748# default (usually /etc/krb5.keytab) if not specified.
749#auth_krb5_keytab =
750
751auth default {
752  # Space separated list of wanted authentication mechanisms:
753  #   plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi
754  # NOTE: See also disable_plaintext_auth setting.
755  mechanisms = plain login digest-md5 cram-md5
756
757  #
758  # Password database is used to verify user's password (and nothing more).
759  # You can have multiple passdbs and userdbs. This is useful if you want to
760  # allow both system users (/etc/passwd) and virtual users to login without
761  # duplicating the system users into virtual database.
762  #
763  # <doc/wiki/PasswordDatabase.txt>
764  #
765  # By adding master=yes setting inside a passdb you make the passdb a list
766  # of "master users", who can log in as anyone else. Unless you're using PAM,
767  # you probably still want the destination user to be looked up from passdb
768  # that it really exists. This can be done by adding pass=yes setting to the
769  # master passdb. <doc/wiki/Authentication.MasterUsers.txt>
770
771  # Users can be temporarily disabled by adding a passdb with deny=yes.
772  # If the user is found from that database, authentication will fail.
773  # The deny passdb should always be specified before others, so it gets
774  # checked first. Here's an example:
775
776  #passdb passwd-file {
777    # File contains a list of usernames, one per line
778    #args = /etc/dovecot.deny
779    #deny = yes
780  #}
781
782  # PAM authentication. Preferred nowadays by most systems.
783  # Note that PAM can only be used to verify if user's password is correct,
784  # so it can't be used as userdb. If you don't want to use a separate user
785  # database (passwd usually), you can use static userdb.
786  # REMEMBER: You'll need /etc/pam.d/dovecot file created for PAM
787  # authentication to actually work. <doc/wiki/PasswordDatabase.PAM.txt>
788  #passdb pam {
789    # [blocking=yes] [session=yes] [setcred=yes]
790    # [cache_key=<key>] [<service name>]
791    #
792    # By default a new process is forked from dovecot-auth for each PAM lookup.
793    # Setting blocking=yes uses the alternative way: dovecot-auth worker
794    # processes do the PAM lookups.
795    #
796    # session=yes makes Dovecot open and immediately close PAM session. Some
797    # PAM plugins need this to work, such as pam_mkhomedir.
798    #
799    # setcred=yes makes Dovecot establish PAM credentials if some PAM plugins
800    # need that. They aren't ever deleted though, so this isn't enabled by
801    # default.
802    #
803    # cache_key can be used to enable authentication caching for PAM
804    # (auth_cache_size also needs to be set). It isn't enabled by default
805    # because PAM modules can do all kinds of checks besides checking password,
806    # such as checking IP address. Dovecot can't know about these checks
807    # without some help. cache_key is simply a list of variables (see
808    # doc/wiki/Variables.txt) which must match for the cached data to be used.
809    # Here are some examples:
810    #   %u - Username must match. Probably sufficient for most uses.
811    #   %u%r - Username and remote IP address must match.
812    #   %u%s - Username and service (ie. IMAP, POP3) must match.
813    #
814    # If service name is "*", it means the authenticating service name
815    # is used, eg. pop3 or imap (/etc/pam.d/pop3, /etc/pam.d/imap).
816    #
817    # Some examples:
818    #   args = session=yes *
819    #   args = cache_key=%u dovecot
820    #args = dovecot
821  #}
822
823  # System users (NSS, /etc/passwd, or similiar)
824  # In many systems nowadays this uses Name Service Switch, which is
825  # configured in /etc/nsswitch.conf. <doc/wiki/AuthDatabase.Passwd.txt>
826  #passdb passwd {
827    # [blocking=yes] - See userdb passwd for explanation
828    #args =
829  #}
830
831  # Shadow passwords for system users (NSS, /etc/shadow or similiar).
832  # Deprecated by PAM nowadays.
833  # <doc/wiki/PasswordDatabase.Shadow.txt>
834  #passdb shadow {
835    # [blocking=yes] - See userdb passwd for explanation
836    #args =
837  #}
838
839  # PAM-like authentication for OpenBSD.
840  # <doc/wiki/PasswordDatabase.BSDAuth.txt>
841  #passdb bsdauth {
842    # [cache_key=<key>] - See cache_key in PAM for explanation.
843    #args =
844  #}
845
846  # passwd-like file with specified location
847  # <doc/wiki/AuthDatabase.PasswdFile.txt>
848  passdb passwd-file {
849    # Path for passwd-file
850    args = /opt/local/etc/dovecot/passwd.dovecot
851  }
852
853  # checkpassword executable authentication
854  # NOTE: You will probably want to use "userdb prefetch" with this.
855  # <doc/wiki/PasswordDatabase.CheckPassword.txt>
856  #passdb checkpassword {
857    # Path for checkpassword binary
858    #args =
859  #}
860
861  # SQL database <doc/wiki/AuthDatabase.SQL.txt>
862  #passdb sql {
863    # Path for SQL configuration file, see doc/dovecot-sql-example.conf
864    #args =
865  #}
866
867  # LDAP database <doc/wiki/AuthDatabase.LDAP.txt>
868  #passdb ldap {
869    # Path for LDAP configuration file, see doc/dovecot-ldap-example.conf
870    #args =
871  #}
872
873  # vpopmail authentication <doc/wiki/AuthDatabase.VPopMail.txt>
874  #passdb vpopmail {
875    # [cache_key=<key>] - See cache_key in PAM for explanation.
876    #args =
877  #}
878
879  #
880  # User database specifies where mails are located and what user/group IDs
881  # own them. For single-UID configuration use "static".
882  #
883  # <doc/wiki/UserDatabase.txt>
884  #
885
886  # System users (NSS, /etc/passwd, or similiar). In many systems nowadays this
887  # uses Name Service Switch, which is configured in /etc/nsswitch.conf.
888  # <doc/wiki/AuthDatabase.Passwd.txt>
889  #userdb passwd {
890    # [blocking=yes] - By default the lookups are done in the main dovecot-auth
891    # process. This setting causes the lookups to be done in auth worker
892    # proceses. Useful with remote NSS lookups that may block.
893    # NOTE: Be sure to use this setting with nss_ldap or users might get
894    # logged in as each others!
895    #args =
896  #}
897
898  # passwd-like file with specified location
899  # <doc/wiki/AuthDatabase.PasswdFile.txt>
900  userdb passwd-file {
901    # Path for passwd-file
902    args = /opt/local/etc/dovecot/userdb.dovecot
903  }
904
905  # static settings generated from template <doc/wiki/UserDatabase.Static.txt>
906  #userdb static {
907    # Template for the fields. Can return anything a userdb could normally
908    # return. For example:
909    #
910    #  args = uid=500 gid=500 home=/var/mail/%u
911    #
912    # If you use deliver, it needs to look up users only from the userdb. This
913    # of course doesn't work with static because there is no list of users.
914    # Normally static userdb handles this by doing a passdb lookup. This works
915    # with most passdbs, with PAM being the most notable exception. If you do
916    # the user verification another way, you can add allow_all_users=yes to
917    # the args in which case the passdb lookup is skipped.
918    #
919    #args =
920  #}
921
922  # SQL database <doc/wiki/AuthDatabase.SQL.txt>
923  #userdb sql {
924    # Path for SQL configuration file, see doc/dovecot-sql-example.conf
925    #args =
926  #}
927
928  # LDAP database <doc/wiki/AuthDatabase.LDAP.txt>
929  #userdb ldap {
930    # Path for LDAP configuration file, see doc/dovecot-ldap-example.conf
931    #args =
932  #}
933
934  # vpopmail <doc/wiki/AuthDatabase.VPopMail.txt>
935  #userdb vpopmail {
936  #}
937
938  # "prefetch" user database means that the passdb already provided the
939  # needed information and there's no need to do a separate userdb lookup.
940  # This can be made to work with SQL and LDAP databases, see their example
941  # configuration files for more information how to do it.
942  # <doc/wiki/UserDatabase.Prefetch.txt>
943  #userdb prefetch {
944  #}
945
946  # User to use for the process. This user needs access to only user and
947  # password databases, nothing else. Only shadow and pam authentication
948  # requires roots, so use something else if possible. Note that passwd
949  # authentication with BSDs internally accesses shadow files, which also
950  # requires roots. Note that this user is NOT used to access mails.
951  # That user is specified by userdb above.
952  user = root
953
954  # Directory where to chroot the process. Most authentication backends don't
955  # work if this is set, and there's no point chrooting if auth_user is root.
956  # Note that valid_chroot_dirs isn't needed to use this setting.
957  #chroot =
958
959  # Number of authentication processes to create
960  #count = 1
961
962  # Require a valid SSL client certificate or the authentication fails.
963  #ssl_require_client_cert = no
964
965  # Take the username from client's SSL certificate, using
966  # X509_NAME_get_text_by_NID() which returns the subject's DN's
967  # CommonName.
968  #ssl_username_from_cert = no
969
970  # It's possible to export the authentication interface to other programs:
971  #socket listen {
972    #master {
973      # Master socket provides access to userdb information. It's typically
974      # used to give Dovecot's local delivery agent access to userdb so it
975      # can find mailbox locations.
976      #path = /var/run/dovecot/auth-master
977      #mode = 0600
978      # Default user/group is the one who started dovecot-auth (root)
979      #user =
980      #group =
981    #}
982    #client {
983      # The client socket is generally safe to export to everyone. Typical use
984      # is to export it to your SMTP server so it can do SMTP AUTH lookups
985      # using it.
986      #path = /var/run/dovecot/auth-client
987      #mode = 0660
988    #}
989  #}
990}
991
992# If you wish to use another authentication server than dovecot-auth, you can
993# use connect sockets. They are assumed to be already running, Dovecot's master
994# process only tries to connect to them. They don't need any other settings
995# than the path for the master socket, as the configuration is done elsewhere.
996# Note that the client sockets must exist in the login_dir.
997#auth external {
998#  socket connect {
999#    master {
1000#      path = /var/run/dovecot/auth-master
1001#    }
1002#  }
1003#}
1004
1005##
1006## Dictionary server settings
1007##
1008
1009# Dictionary can be used by some plugins to store key=value lists.
1010# Currently this is only used by dict quota backend. The dictionary can be
1011# used either directly or though a dictionary server. The following dict block
1012# maps dictionary names to URIs when the server is used. These can then be
1013# referenced using URIs in format "proxy:<name>".
1014
1015dict {
1016  #quota = mysql:/etc/dovecot-dict-quota.conf
1017}
1018
1019##
1020## Plugin settings
1021##
1022
1023plugin {
1024  # Here you can give some extra environment variables to mail processes.
1025  # This is mostly meant for passing parameters to plugins. %variable
1026  # expansion is done for all values.
1027
1028  # Quota plugin. Multiple backends are supported:
1029  #   dirsize: Find and sum all the files found from mail directory.
1030  #            Extremely SLOW with Maildir. It'll eat your CPU and disk I/O.
1031  #   dict: Keep quota stored in dictionary (eg. SQL)
1032  #   maildir: Maildir++ quota
1033  #   fs: Read-only support for filesystem quota
1034  #quota = maildir
1035
1036  # ACL plugin. vfile backend reads ACLs from "dovecot-acl" file from maildir
1037  # directory. You can also optionally give a global ACL directory path where
1038  # ACLs are applied to all users' mailboxes. The global ACL directory contains
1039  # one file for each mailbox, eg. INBOX or sub.mailbox.
1040  #acl = vfile:/etc/dovecot-acls
1041
1042  # Convert plugin. If set, specifies the source storage path which is
1043  # converted to destination storage (mail_location) when the user logs in.
1044  # The existing mail directory is renamed to <dir>-converted.
1045  #convert_mail = mbox:%h/mail
1046  # Skip mailboxes which we can't open successfully instead of aborting.
1047  #convert_skip_broken_mailboxes = no
1048
1049  # Trash plugin. When saving a message would make user go over quota, this
1050  # plugin automatically deletes the oldest mails from configured mailboxes
1051  # until the message can be saved within quota limits. The configuration file
1052  # is a text file where each line is in format: <priority> <mailbox name>
1053  # Mails are first deleted in lowest -> highest priority number order
1054  #trash = /etc/dovecot-trash.conf
1055
1056  # Lazy expunge plugin. Currently works only with maildirs. When a user
1057  # expunges mails, the mails are moved to a mailbox in another namespace
1058  # (1st). When a mailbox is deleted, the mailbox is moved to another namespace
1059  # (2nd) as well. Also if the deleted mailbox had any expunged messages,
1060  # they're moved to a 3rd namespace. The mails won't be counted in quota,
1061  # and they're not deleted automatically (use a cronjob or something).
1062  #lazy_expunge = .EXPUNGED/ .DELETED/ .DELETED/.EXPUNGED/
1063}
1064
1065