Mercurial > dovecot > original-hg > dovecot-1.2
annotate dovecot-example.conf @ 600:3b44bc64afd4 HEAD
mailbox_check_interval setting: Dovecot can notify client of new mail in
selected mailbox soon after it's received. This setting specifies the
minimum interval in seconds between new mail notifications to client -
internally they may be checked more or less often. Setting this to 0
disables the checking.
| author | Timo Sirainen <tss@iki.fi> |
|---|---|
| date | Tue, 12 Nov 2002 07:27:30 +0200 |
| parents | ab3590c3a7d9 |
| children | 1906116a62ce |
| rev | line source |
|---|---|
| 0 | 1 ## Dovecot 1.0 configuration file |
| 2 | |
| 3 # Default values are shown after each value, it's not required to uncomment | |
| 435 | 4 # any of the lines. Exception to this are paths, they're just examples |
| 5 # with real defaults being based on configure options. The paths listed here | |
| 6 # are for configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var | |
| 0 | 7 |
| 8 # Port to listen in for IMAP connections. This port is used for TLS | |
| 9 # connections as well. Setting it to 0 disables it. | |
| 10 #imap_port = 143 | |
| 11 | |
| 12 # Port to listen in for SSL IMAP connections. Setting it to 0 disables it. | |
| 13 #imaps_port = 993 | |
| 14 | |
| 15 # IP or host address where to listen in for IMAP connections. Empty means to | |
| 16 # listen in all interfaces. It's not possible to specify multiple. | |
| 17 #imap_listen = | |
| 18 | |
| 19 # IP or host address where to listen in for SSL IMAP connections. Defaults | |
| 20 # to imap_listen if not specified. | |
| 21 #imaps_listen = | |
| 22 | |
| 519 | 23 # PEM encoded X.509 SSL/TLS certificate and private key. They're opened before |
|
518
1f9b96080525
Updated SSL certificate comments.
Timo Sirainen <tss@iki.fi>
parents:
472
diff
changeset
|
24 # dropping root privileges, so keep the key file unreadable by anyone but |
|
1f9b96080525
Updated SSL certificate comments.
Timo Sirainen <tss@iki.fi>
parents:
472
diff
changeset
|
25 # root. Note that these default paths here are absolute, configure options |
|
1f9b96080525
Updated SSL certificate comments.
Timo Sirainen <tss@iki.fi>
parents:
472
diff
changeset
|
26 # don't affect them. Use for example OpenSSL to generate these files. |
| 0 | 27 #ssl_cert_file = /etc/ssl/certs/imapd.pem |
| 28 #ssl_key_file = /etc/ssl/private/imapd.pem | |
| 29 | |
| 30 # Disable LOGIN command and all other plaintext authentications unless | |
| 31 # SSL/TLS is used (LOGINDISABLED capability) | |
| 32 #disable_plaintext_auth = no | |
| 33 | |
|
35
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
34 # Use this logfile instead of syslog() |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
35 #log_path = |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
36 |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
37 # Prefix for each line written to log file. % codes are in strftime(3) |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
38 # format. Note the extra space at the end of line. |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
39 #log_timestamp = %b %d %H:%M:%S |
|
b420373f88f6
Added log_path and log_timestamp settings to config file. Removed -l command
Timo Sirainen <tss@iki.fi>
parents:
27
diff
changeset
|
40 |
| 0 | 41 ## |
| 42 ## Login process | |
| 43 ## | |
| 44 | |
| 45 # Executable location | |
| 46 #login_executable = /usr/lib/dovecot/imap-login | |
| 47 | |
| 48 # User to use for imap-login process | |
| 49 #login_user = imapd | |
| 50 | |
| 51 # Directory where imap-auth places authentication UNIX sockets which login | |
| 52 # needs to be able to connect to. The sockets are created when running as | |
| 53 # root, so you don't need to give imap-auth any access for it. | |
| 54 #login_dir = /var/run/dovecot/login | |
| 55 | |
| 435 | 56 # chroot imap-login process to the login_dir. Only reason not to do this |
| 0 | 57 # is if you wish to run the whole imapd without roots. |
| 58 #login_chroot = yes | |
| 59 | |
| 60 # Number of imap-login processes to use, one or two is enough | |
| 61 #login_processes_count = 1 | |
| 62 | |
| 63 # Maximum number of connections allowed in login state. When this limit is | |
| 64 # reached, the oldest connections are dropped. | |
| 65 #max_logging_users = 256 | |
| 66 | |
| 67 ## | |
| 68 ## IMAP process | |
| 69 ## | |
| 70 | |
| 71 # Executable location | |
| 72 #imap_executable = /usr/lib/dovecot/imap | |
| 73 | |
| 74 # Maximum number of running imap processes. When this limit is reached, | |
| 75 # new users aren't allowed to log in. | |
| 76 #max_imap_processes = 1024 | |
| 77 | |
|
596
ab3590c3a7d9
Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents:
519
diff
changeset
|
78 # Show more verbose process titles (in ps). Currently shows user name and |
|
ab3590c3a7d9
Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents:
519
diff
changeset
|
79 # IP address. Useful for seeing who are actually using the IMAP processes |
|
ab3590c3a7d9
Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents:
519
diff
changeset
|
80 # (eg. shared mailboxes or if same uid is used for multiple accounts). |
|
ab3590c3a7d9
Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents:
519
diff
changeset
|
81 #verbose_proctitle = no |
|
ab3590c3a7d9
Added verbose_proctitle setting: Show more verbose process titles (in ps).
Timo Sirainen <tss@iki.fi>
parents:
519
diff
changeset
|
82 |
| 0 | 83 # Valid UID/GID ranges for imap users, defaults to 500 and above. |
| 84 # Note that denying root logins is hardcoded to imap-master binary and | |
| 85 # can't be done even if first_valid_uid is set to 0. | |
| 86 #first_valid_uid = 500 | |
| 87 #last_valid_uid = 0 | |
| 88 | |
| 89 #first_valid_gid = 1 | |
| 90 #last_valid_gid = 0 | |
| 91 | |
| 92 # ':' separated list of directories under which chrooting is allowed for imap | |
| 93 # processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too). | |
| 94 # WARNING: Never add directories here which local users can modify, that | |
| 95 # may lead to root exploit. Usually this should be done only if you don't | |
| 96 # allow shell access for users. | |
| 97 #valid_chroot_dirs = | |
| 98 | |
|
462
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
99 # Space-separated list of fields to cache for all mails. Currently these |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
100 # fields are allowed followed by a list of commands they speed up: |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
101 # |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
102 # Envelope - FETCH ENVELOPE and SEARCH FROM, TO, CC, BCC, SUBJECT, |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
103 # SENTBEFORE, SENTON, SENTSINCE, HEADER MESSAGE-ID, |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
104 # HEADER IN-REPLY-TO |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
105 # Body - FETCH BODY |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
106 # Bodystructure - FETCH BODY, BODYSTRUCTURE |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
107 # MessagePart - FETCH BODY[1.2.3] (ie. body parts), RFC822.SIZE, |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
108 # SEARCH SMALLER, LARGER, also speeds up BODY/BODYSTRUCTURE |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
109 # generation. This is always set with mbox mailboxes, and |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
110 # also default with Maildir. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
111 # |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
112 # Different IMAP clients work in different ways, that's why Dovecot by default |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
113 # only caches MessagePart which speeds up most operations. Whenever client |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
114 # does something where caching could be used, the field is automatically marked |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
115 # to be cached later. For example after FETCH BODY the BODY will be cached |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
116 # for all new messages. Normally you should leave this alone, unless you know |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
117 # what most of your IMAP clients are. Caching more fields than needed makes |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
118 # the index files larger and generate useless I/O. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
119 # |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
120 # With maildir there's one extra optimization - if nothing is cached, indexing |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
121 # the maildir becomes much faster since it's not opening any of the mail files. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
122 # This could be useful if your IMAP clients access only new mails. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
123 |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
124 #mail_cache_fields = MessagePart |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
125 |
|
600
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
126 # Dovecot can notify client of new mail in selected mailbox soon after it's |
|
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
127 # received. This setting specifies the minimum interval in seconds between |
|
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
128 # new mail notifications to client - internally they may be checked more or |
|
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
129 # less often. Setting this to 0 disables the checking. |
|
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
130 #mailbox_check_interval = 30 |
|
3b44bc64afd4
mailbox_check_interval setting: Dovecot can notify client of new mail in
Timo Sirainen <tss@iki.fi>
parents:
596
diff
changeset
|
131 |
|
462
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
132 # Space-separated list of fields that Dovecot should never set to be cached. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
133 # Useful if you want to save disk space at the cost of more I/O when the fields |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
134 # needed. |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
135 #mail_never_cache_fields = |
|
67d22b7b0918
Added mail_cache_fields and mail_never_cache_fields settings, plus settings
Timo Sirainen <tss@iki.fi>
parents:
435
diff
changeset
|
136 |
|
472
2fa0bfb65268
Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents:
462
diff
changeset
|
137 # Save mails with CR+LF instead of plain LF. This makes sending those mails |
|
2fa0bfb65268
Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents:
462
diff
changeset
|
138 # take less CPU, especially with sendfile() syscall with Linux and FreeBSD. |
|
2fa0bfb65268
Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents:
462
diff
changeset
|
139 # But it also creates a bit more disk I/O which may just make it slower. |
|
2fa0bfb65268
Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents:
462
diff
changeset
|
140 #mail_save_crlf = no |
|
2fa0bfb65268
Added setting mail_save_crlf. Few other settings cleanups.
Timo Sirainen <tss@iki.fi>
parents:
462
diff
changeset
|
141 |
| 0 | 142 # Copy mail to another folders using hard links. This is much faster than |
| 143 # actually copying the file. Only problem with it is that if either of the | |
| 144 # mails are modified directly both will change. This isn't a problem with | |
| 145 # IMAP however since it offers no way to modify the existing mails. Also | |
| 146 # at least mutt modifies mails by deleting the old one and inserting a new | |
| 147 # modified mail. So if performance matters at all you should turn this on. | |
| 148 #maildir_copy_with_hardlinks = no | |
| 149 | |
| 150 # Check if mails' content has been changed by external programs. This slows | |
| 151 # down things as extra stat() needs to be called for each file. | |
| 152 #maildir_check_content_changes = no | |
| 153 | |
|
101
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
154 # If main index file is incompatible with us, should we overwrite it or |
|
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
155 # create a new index with another name. Unless you are running Dovecot in |
|
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
156 # multiple computers with different architectures accessing the same |
|
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
157 # mailboxes (eg. via NFS), it's safe to set this "yes". |
|
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
158 #overwrite_incompatible_index = no |
|
edc37d046b08
Added overwrite_incompatible_index setting. Also we now try to use only
Timo Sirainen <tss@iki.fi>
parents:
35
diff
changeset
|
159 |
| 0 | 160 # umask to use for mail files and directories |
| 161 #umask = 0077 | |
| 162 | |
| 163 ## | |
| 164 ## Authentication processes | |
| 165 ## | |
| 166 | |
| 167 # You can have multiple processes; each time "auth = xx" is seen, a new | |
| 168 # process definition is started. The point of multiple processes is to be | |
| 169 # able to set stricter permissions to others. For example, plain/PAM | |
| 170 # authentication requires roots, but if you also use digest-md5 authentication | |
| 171 # for some users, you can authenticate them without any privileges in a | |
| 172 # separate auth process. Just remember that only one auth process is asked | |
| 173 # for the password, so you can't have different passwords with different | |
| 174 # processes (unless they have different auth methods, and you're ok with | |
| 175 # having different password for each method). | |
| 176 | |
| 177 # Authentication process name. | |
| 178 auth = default | |
| 179 | |
| 284 | 180 # Authentication methods this process allows separated with a space. |
| 181 # Currently supported: plain digest-md5 | |
| 0 | 182 auth_methods = plain |
| 183 | |
| 184 # Space separated list of realms with authentication methods that need them. | |
| 185 # This is usually empty or the host name of the server (eg. | |
| 186 # mail.mycompany.com). | |
| 187 # - plain auth checks the password from all realms specified in here | |
| 188 # - digest-md5 must have the password added for each realm separately, and | |
| 189 # many clients simply use the first realm listed here. so if you really | |
| 190 # need to add more realms, add them to end of the list. | |
| 191 #auth_realms = | |
| 192 | |
| 193 # Where the user information and passwords are stored into: | |
| 194 # passwd: /etc/passwd or similiar, using getpwnam() | |
| 195 # shadow: /etc/shadow or similiar, using getspnam() | |
| 196 # pam: PAM authentication | |
| 197 # passwd-file /etc/passwd.imap: /etc/passwd-like file. Supports digest-md5 | |
| 198 # style passwords | |
|
280
fa2d1a1d025e
vpopmail authentication. compiles, not tested if it really works.
Timo Sirainen <tss@iki.fi>
parents:
101
diff
changeset
|
199 # vpopmail: vpopmail authentication |
| 27 | 200 auth_userinfo = pam |
| 0 | 201 |
| 202 # Executable location | |
| 435 | 203 #auth_executable = /usr/lib/dovecot/imap-auth |
| 0 | 204 |
| 205 # User to use for the process. Only shadow and pam authentication requires | |
| 206 # roots, so use something else if possible. | |
| 207 auth_user = root | |
| 208 | |
| 435 | 209 # Directory where to chroot the process. Most authentication backends don't |
| 210 # work if this is set, and there's no point chrooting if auth_user is root. | |
| 0 | 211 #auth_chroot = |
| 212 | |
| 213 # Number of authentication processes to create | |
| 214 #auth_count = 1 | |
| 215 | |
| 216 | |
| 217 # digest-md5 authentication process. It requires special MD5 passwords which | |
| 218 # /etc/shadow and PAM doesn't support, so we never need roots to handle it. | |
| 219 # Note that the passwd-file is opened before chrooting and dropping root | |
| 220 # privileges, so it may be 0600-root owned file. | |
| 221 | |
| 222 #auth = digest_md5 | |
| 223 #auth_methods = digest-md5 | |
| 224 #auth_realms = | |
| 225 #auth_userinfo = passwd-file /etc/passwd.imap | |
| 226 #auth_user = imapauth | |
| 227 #auth_chroot = /var/run/dovecot/auth | |
| 228 | |
| 229 # if you plan to use only passwd-file, you don't need the two auth processes, | |
| 230 # simply set "auth_methods = plain digest-md5" |