 |
Index for
Section 5 |
|
 |
Alphabetical
listing for I |
|
 |
Bottom of
page |
|
IMAPD.CONF(5)
NAME
imapd.conf - IMAP configuration file
DESCRIPTION
/etc/imapd.conf is the configuration file for the Cyrus IMAP server. It
defines local parameters for IMAP.
Each line of the /etc/imapd.conf file has the form
option: value
where option is the name of the configuration option being set and value is
the value that the configuration option is being set to.
Blank lines and lines beginning with ``#'' are ignored.
For boolean options, the values ``yes'', ``on'', ``t'', and ``1'' turn the
option on, the values ``no'', ``off'', ``f'', and ``0'' turn the option
off.
FIELD DESCRIPTIONS
The sections below detail options that can be placed in the /etc/imapd.conf
file, and show each option's default value. Some options have no default
value, these are listed with ``<no default>''. Some options default to the
empty string, these are listed with ``<none>''.
configdirectory: <no default>
The pathname of the IMAP configuration directory. This field is
required.
defaultpartition: default
The partition name used by default for new mailboxes.
partition-name: <no default>
The pathname of the partition name. At least one field, for the
partition named in the defaultpartition option, is required. For
example, if the value of the defaultpartion option is default, then
the partition-default field is required.
umask: 077
The umask value used by various Cyrus IMAP programs.
allowanonymouslogin: no
Permit logins by the user "anonymous" using any password. Also allows
use of the SASL ANONYMOUS mechanism.
quotawarn: 90
The percent of quota utilization over which the server generates
warnings.
timeout: 30
The length of the IMAP server's inactivity autologout timer, in
minutes. The minimum value is 30, the default.
poptimeout: 10
Set the length of the POP server's inactivity autologout timer, in
minutes. The minimum value is 10, the default.
popminpoll: 0
Set the minimum amount of time the server forces users to wait between
successive POP logins, in minutes. The default is 0.
popexpiretime: 0
The number of days advertised as being the minimum a message may be
left on the POP server before it is deleted (via the CAPA command,
defined in the POP3 Extension Mechanism, which some clients may
support). "NEVER", the default, may be specified with a negative
number. The Cyrus POP3 server never deletes mail, no matter what the
value of this parameter is. However, if a site implements a less
liberal policy, it needs to change this parameter accordingly.
admins: <none>
The list of userids with administrative rights. Separate each userid
with a space. Sites using Kerberos authentication may use separate
"admin" instances.
Note that accounts used by users should not be administrators.
Administrative accounts should not receive mail. That is, if user "jbRo"
is a user reading mail, he should not also be in the admins line. Some
problems may occur otherwise, most notably the ability of administrators
to create top-level mailboxes visible to users, but not writable by users.
proxyservers: <none>
A list of users and groups that are allowed to proxy for other users,
seperated by spaces. Any user listed in this will be allowed to login
for any other user: use with caution.
defaultacl: anyone lrs
The Access Control List (ACL) placed on a newly-created (non-user)
mailbox that does not have a parent mailbox.
newsspool: <no default>
The pathname of the news spool directory. Only used if the
partition-news configuration option is set.
newsprefix: <none>
Prefix to be prepended to newsgroup names to make the corresponding
IMAP mailbox names.
autocreatequota: 0
If nonzero, normal users may create their own IMAP accounts by
creating the mailbox INBOX. The user's quota is set to the value if
it is positive, otherwise the user has unlimited quota.
logtimestamps: no
Include notations in the protocol telemetry logs indicating the number
of seconds since the last command or response.
plaintextloginpause: 0
Number of seconds to pause after a successful plaintext login. For
systems that support strong authentication, this permits users to
perceive a cost of using plaintext passwords. (This does not effect
the use of PLAIN in SASL authentications.)
srvtab: /etc/srvtab
The pathname of srvtab file containing the server's private key. This
option is passed to the SASL library and overrides its default
setting.
loginrealms: <none>
The list of remote realms whose users may log in using cross-realm
authentications. Seperate each realm name by a space. (A cross-realm
identity is considered any identity returned by SASL with an "@" in
it.)
loginuseacl: no
If enabled, any authentication identity which has a rights on a user's
INBOX may log in as that user.
reject8bit: no
If enabled, deliver rejects messages with 8-bit characters in the
headers. Otherwise, 8-bit characters are changed to `X'. (A proper
soultion to non-ASCII characters in headers is offered by RFC 2047 and
its predecessors.)
netscapeurl: http://andrew2.andrew.cmu.edu/cyrus/imapd/netscape-admin.html
If enabled at compile time, this specifies a URL to reply when
Netscape asks the server where the mail administration HTTP server is.
The default is a site at CMU with a hopefully informative message;
administrators should set this to a local resource with some
information of greater use.
hashimapspool: false
If enabled, the partitions will also be hashed, in addition to the
hashing done on configuration directories. This is recommended if one
partition has a very bushy mailbox tree.
sasl_maximum_layer: 256
Maximum SSF (security strength factor) that the server will allow a
client to negotiate.
sasl_minimum_layer: 0
The minimum SSF that the server will allow a client to negotiate. A
value of 1 requires integrity protection; any higher value requires
some amount of encryption.
sasl_pwcheck_method: PAM
The mechanism used by the server to verify plaintext passwords.
Possible values also include "kerberos_v4", "passwd", and "shadow".
sasl_auto_transition: no
If enabled, the SASL library will automatically create authentication
secrets when given a plaintext password. See the SASL documentation.
sasl_option
Any other SASL option can be set by preceding it with "sasl_". This
file overrides the SASL configuration file.
SEE ALSO
imapd(8), deliver(8)
|
Index for
Section 5 |
|
|
Alphabetical
listing for I |
|
 |
Top of
page |
|