IMAPD.CONF

The list of userids with administrative rights. Separate each userid with a space. Sites using Kerberos authentication may use separate "admin" instances.

The list of realms which are to be treated as local, and thus stripped during identifier canoicalization (for the AFSPTS ptloader module). This is different from loginrealms in that it occurs later in the authorization process (as the user id is canonified for PTS lookup)

Cell to use for AFS PTS lookups. Defaults to the local cell.

Allow subscription to nonexistent mailboxes. This option is typically used on backend servers in a Murder so that users can subscribe to mailboxes that don’t reside on their "home" server. This option can also be used as a workaround for IMAP clients which don’t play well with nonexistent or unselectable mailboxes (eg. Microsoft Outlook).

Permit logins by the user "anonymous" using any password. Also allows use of the SASL ANONYMOUS mechanism.

Allow use of the POP3 APOP authentication command.

Allow use of the NNTP NEWNEWS command.

Allow the use of cleartext passwords on the wire.

Allow moving user accounts (with associated meta-data) via RENAME or XFER.

Use the alternate IMAP namespace, where personal folders reside at the same level in the hierarchy as INBOX.

The cyrusdb backend to use for mailbox annotations.

Allowed values: berkeley, skiplist

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.

Size (in kilobytes) of the shared memory buffer pool (cache) used by the berkeley environment. The minimum allowed value is 20. The maximum allowed value is 4194303 (4GB).

Maximum number of locks to be held or requested in the berkeley environment.

Maximum number of transactions to be supported in the berkeley environment.

Number of seconds to wait before returning a timeout failure when performing a client connection (e.g. in a murder enviornment)

The pathname of the IMAP configuration directory. This field is required.

Debug command to be used by processes started with -D option. The string is a C format string that gets 3 options: the first is the name of the executable (without path). The second is the pid (integer) and the third is the service ID. Example: /usr/local/bin/gdb /usr/cyrus/bin/%s %d

The Access Control List (ACL) placed on a newly-created (non-user) mailbox that does not have a parent mailbox.

The default domain for virtual domain support

The partition name used by default for new mailboxes.

The right that a user needs to delete a mailbox.

The cyrusdb backend to use for the duplicate delivery suppression and sieve.

Allowed values: berkeley, berkeley-nosync, skiplist

If enabled, lmtpd will suppress delivery of a message to a mailbox if a message with the same message-id (or resent-message-id) is recorded as having already been delivered to the mailbox. Records the mailbox and message-id/resent-message-id of all successful deliveries.

If enabled, only list the personal namespace when a LIST "*" is performed. (it changes the request to a LIST "INBOX*"

Force preference of a given SASL mechanism for client side operations (e.g. murder enviornments). This is separate from (and overridden by) the ability to use the <host shortname>_mechs option to set prefered mechanisms for a specific host

If enabled, uses an improved directory hashing scheme which hashes the entire username instead of using just the first letter. This changes hash algorithm used for quota and user directories and if hashimapspool is enabled, the entire mail spool.

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.

Force a particuar list of SASL mechanisms to be used when authenticating to the backend server hostname (where hostname is the short hostname of the server in question). If it is not specified it will query the server for available mechanisms and pick one to use. - Cyrus Murder

The password to use for authentication to the backend server hostname (where hostname is the short hostname of the server) - Cyrus Murder

Unix domain socket that idled listens on.

For backwards compatibility with Cyrus 1.5.10 and earlier -- ignore the reference argument in LIST or LSUB commands.

The interval (in seconds) for polling the mailbox for changes while running the IDLE command. This option is used when idled can not be contacted or when polling is used exclusively. The minimum value is 1. A value of 0 will disable polling (and disable IDLE if polling is the only method available).

If enabled, the server responds to an ID command with a parameter list containing: version, vendor, support-url, os, os-version, command, arguments, environment. Otherwise the server returns NIL.

Only list a restricted set of mailboxes via IMAP by using userid+namespace syntax as the authentication/authorization id. Using userid+ (with an empty namespace) will list only subscribed mailboxes.

The implicit Access Control List (ACL) for the owner of a mailbox.

Directive which includes the specified file as part of the configuration. If the path to the file is not absolute, CYRUS_PATH is prepended.

SASL authorization ID for the LDAP server

Contains the LDAP base dn for the LDAP ptloader module

Bind DN for the connection to the LDAP server (simple bind). Do not use for anonymous simple binds

Specify how aliases dereferencing is handled during search.

Allowed values: search, find, always, never

Specify a filter that searches user identifiers. The following tokens can be used in the filter string:

%% = % %u = user %U = user portion of %u (%U = test when %u = test@domain.tld) %d = domain portion of %u if available (%d = domain.tld when %u = %test@domain.tld), otherwise same as %r %D = user dn. (use when ldap_member_method: filter) %1-9 = domain tokens (%1 = tld, %2 = domain when %d = domain.tld)

ldap_filter is not used when ldap_sasl is enabled.

LDAP base dn for ldap_group_filter.

Specify a filter that searches for group identifiers. See ldap_filter for more options.

Specify search scope for ldap_group_filter.

Allowed values: sub, one, base

SASL authentication ID for the LDAP server

SASL mechanism for LDAP authentication

See ldap_member_method.

LDAP base dn for ldap_member_filter.

Specify a filter for "ldap_member_method: filter". See ldap_filter for more options.

Specify a group method. The "attribute" method retrieves groups from a multi-valued attributed specified in ldap_member_attribute. The "filter" method uses a filter, ldap_member_filter, to find groups; ldap_member_attribute is a single-value attribute group name.

Allowed values: attribute, filter

Specify search scope for ldap_member_filter.

Allowed values: sub, one, base

Password for the connection to the LDAP server (SASL and simple bind). Do not use for anonymous simple binds

SASL realm for LDAP authentication

Specify whether or not the client should follow referrals.

Specify whether or not LDAP I/O operations are automatically restarted if they abort prematurely.

Use SASL for LDAP binds in the LDAP PTS module.

Depricated. Use ldap_id

Depricated. Use ldap_authz

Depricated. Use ldap_mech

Depricated. User ldap_password

Depricated. Use ldap_realm

Specify search scope.

Allowed values: sub, one, base

Depricated. Use ldap_uri

Specify a number of entries for a search request to return.

Use StartTLS extended operation. Do not use ldaps: ldap_uri when this option is enabled.

Specify a number of seconds for a search request to complete.

Specify a number of seconds a search can take before timing out.

Path to directory with CA (Certificate Authority) certificates.

File containing CA (Certificate Authority) certificate(s).

File containing the client certificate.

Require and verify server certificate. If this option is yes, you must specify ldap_tls_cacert_file or ldap_tls_cacert_dir.

List of SSL/TLS ciphers to allow. The format of the string is described in ciphers(1).

File containing the private client key.

Contains a list of the URLs of all the LDAP servers when using the LDAP PTS module.

Specify the LDAP protocol version. If ldap_start_tls and/or ldap_use_sasl are enabled, ldap_version will be automatiacally set to 3.

If enabled, lmtpd will convert the recipient address to lowercase (up to a ’+’ character, if present).

If enabled, lmtpd returns a permanent failure code when a user’s mailbox is over quota. By default, the failure is temporary, causing the MTA to queue the message and retry later.

Unix domain socket that lmtpd listens on, used by deliver(8). This should match the path specified in cyrus.conf(5).

The list of remote realms whose users may authenticate using cross-realm authentication identifiers. Seperate each realm name by a space. (A cross-realm identity is considered any identity returned by SASL with an "@" in it.).

If enabled, any authentication identity which has a rights on a user’s INBOX may log in as that user.

Include notations in the protocol telemetry logs indicating the number of seconds since the last command or response.

Notifyd(8) method to use for "MAIL" notifications. If not set, "MAIL" notifications are disabled.

Maximum incoming LMTP message size. If non-zero, lmtpd will reject messages larger than maxmessagesize bytes. If set to 0, this will allow messages of any size (the default).

The cyrusdb backend to use for the mailbox list.

Allowed values: flat, berkeley, skiplist

The max number of connections that a mupdate process will allow, this is related to the number of file descriptors in the mupdate process. Beyond this number connections will be immedately issued a BYE response.

The SASL username (Authentication Name) to use when authenticating to the mupdate server (if needed).

The SASL password (if needed) to use when authenticating to the mupdate server.

The port of the mupdate server for the Cyrus Murder

The SASL realm (if needed) to use when authenticating to the mupdate server.

The base time to wait between connection retries to the mupdate server.

The mupdate server for the Cyrus Murder

The number of mupdate worker threads to start

The minimum number of idle mupdate worker threads

The maximum number of idle mupdate worker threads

The maximum number of mupdate worker threads (overall)

The SASL username (Authorization Name) to use when authenticating to the mupdate server

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.

Userid that is used for checking access controls when executing Usenet control messages. For instance, to allow articles to be automatically deleted by cancel messages, give the "news" user the ’d’ right on the desired mailboxes. To allow newsgroups to be automatically created, deleted and renamed by the corresponding control messages, give the "news" user the ’c’ right on the desired mailbox hierarchies.

A list of whitespace-separated news server specifications to which articles should be fed. Each server specification is a string of the form [user[:pass]@]host[:port][/wildmat] where ’host’ is the fully qualified hostname of the server, ’port’ is the port on which the server is listening, ’user’ and ’pass’ are the authentication credentials and ’wildmat’ is a pattern that specifies which groups should be fed. If no ’port’ is specified, port 119 is used. If no ’wildmat’ is specified, all groups are fed. If ’user’ is specified (even if empty), then the NNTP POST command will be used to feed the article to the server, otherwise the IHAVE command will be used.

A ’@’ may be used in place of ’!’ in the wildmat to prevent feeding articles cross-posted to the given group, otherwise cross-posted articles are fed if any part of the wildmat matches. For example, the string "peer.example.com:*,!control.*,@local.*" would feed all groups except control messages and local groups to peer.example.com. In the case of cross-posting to local groups, these articles would not be fed.

Userid used to deliver usenet articles to newsgroup folders (usually via lmtp2nntp). For example, if set to "post", email sent to "post+comp.mail.imap" would be delivered to the "comp.mail.imap" folder.

When set, the Cyrus NNTP server will add a To: header to each incoming usenet article. This To: header will contain email delivery addresses corresponding to each newsgroup in the Newsgroups: header. By default, a To: header is not added to usenet articles.

Prefix to be prepended to newsgroup names to make the corresponding IMAP mailbox names.

Unix domain socket that the new mail notification daemon listens on.

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.

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 affect the use of PLAIN in SASL authentications.)

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.

Set the minimum amount of time the server forces users to wait between successive POP logins, in minutes.

Set the length of the POP server’s inactivity autologout timer, in minutes. The minimum value is 10, the default.

Enforce IMAP ACLs in the pop server. Due to the nature of the POP3 protocol, the only rights which are used by the pop server are ’r’ and ’d’ for the owner of the mailbox. The ’r’ right allows the user to open the mailbox and list/retrieve messages. The ’d’ right allows the user to delete messages.

Username that is used as the ’From’ address in rejection MDNs produced by sieve.

Userid used to deliver messages to shared folders. For example, if set to "bb", email sent to "bb+shared.blah" would be delivered to the "shared.blah" folder. By default, an email address of "+shared.blah" would be used.

The authentication name to use when authenticating to a backend server in the Cyrus Murder.

The default password to use when authenticating to a backend server in the Cyrus Murder. May be overridden on a host-specific basis using the hostname_password option.

The authentication realm to use when authenticating to a backend server in the Cyrus Murder

Set to true to allow proxyd to issue referrals to clients that support it when answering the STATUS command. This is disabled by default since some clients issue many STATUS commands in a row, and do not cache the connections that these referrals would cause, thus resulting in a higher authentication load on the respective backend server.

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.

Unix domain socket that ptloader listens on. (defaults to configdir/ptclient/ptsock)

The cyrusdb backend to use for the pts cache.

Allowed values: berkeley, skiplist

The timeout (in seconds) for the PTS cache database when using the auth_krb_pts authorization method (default: 3 hours).

When using the AFSKRB ptloader module with Kerberos 5 canonicalization, do the final 524 conversion to get a n AFS style name (using ’.’ instead of ’/’, and using short names

When using the AFSKRB ptloader module with Kerberos 5 canonicalization, strip the default realm from the userid (this does not affect the stripping of realms specified by the afspts_localrealms option)

The cyrusdb backend to use for quotas.

Allowed values: flat, berkeley, skiplist, quotalegacy

The percent of quota utilization over which the server generates warnings.

The maximum amount of free space (in kB) in which to give a quota warning (if this value is 0, or if the quota is smaller than this amount, than warnings are always given).

If enabled, lmtpd 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.)

If enabled, imapd will be strict (per RFC 2046) when matching MIME boundary strings. This means that boundaries containing other boundaries as substrings will be treated as identical. Since enabling this option will break some messages created by Eudora 5.1 (and earlier), it is recommended that it be left disabled unless there is good reason to do otherwise.

If enabled, Sieve will be strict (per RFC 3028) with regards to which headers are allowed to be used in address and envelope tests. This means that only those headers which are defined to contain addresses will be allowed in address tests and only "to" and "from" will be allowed in envelope tests. When disabled, ANY grammatically correct header will be allowed.

If enabled, the SASL library will automatically create authentication secrets when given a plaintext password. See the SASL documentation.

Maximum SSF (security strength factor) that the server will allow a client to negotiate.

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.

Any SASL option can be set by preceeding it with "sasl_". This file overrides the SASL configuration file.

The mechanism used by the server to verify plaintext passwords. Possible values include "auxprop", "saslauthd", and "pwcheck".

The cyrusdb backend to use for the seen state.

Allowed values: flat, berkeley, skiplist

The pathname of the sendmail executable. Sieve invokes sendmail for sending rejections, redirects and vacation responses.

This is the hostname visible in the greeting messages of the POP, IMAP and LMTP daemons. If it is unset, then the result returned from gethostname(2) is used.

If using the alternate IMAP namespace, the prefix for the shared namespace. The hierarchy delimiter will be automatically appended.

Maximum size (in kilobytes) any sieve script can be, enforced at submission by timsieved(8).

Maximum number of sieve scripts any user may have, enforced at submission by timsieved(8).

If sieveusehomedir is false, this directory is searched for Sieve scripts.

Notifyd(8) method to use for "SIEVE" notifications. If not set, "SIEVE" notifications are disabled.

If enabled, lmtpd will look for Sieve scripts in user’s home directories: ~user/.sieve.

If enabled, lmtpd and nntpd attempt to only write one copy of a message per partition and create hard links, resulting in a potentially large disk savings.

If enabled, this option forces the skiplist cyrusdb backend to not sync writes to the disk. Enabling this option is NOT RECOMMENDED.

If enabled, lmtpd returns temporary failures if the client does not successfully authenticate. Otherwise lmtpd returns permanant failures (causing the mail to bounce immediately).

The pathname of srvtab file containing the server’s private key. This option is passed to the SASL library and overrides its default setting.

The cyrusdb backend to use for the subscriptions list.

Allowed values: flat, berkeley, skiplist

String to be appended to the process name in syslog entries.

The pathname to store temporary files in

The length of the IMAP server’s inactivity autologout timer, in minutes. The minimum value is 30, the default.

File containing one or more Certificate Authority (CA) certificates.

Path to directory with certificates of CAs. This directory must have filenames with the hashed value of the certificate (see openssl(XXX)).

The cyrusdb backend to use for the TLS cache.

Allowed values: berkeley, berkeley-nosync, skiplist

File containing the certificate presented for server authentication during STARTTLS. A value of "disabled" will disable SSL/TLS.

The list of SSL/TLS ciphers to allow. The format of the string is described in ciphers(1).

File containing the private key belonging to the server certificate. A value of "disabled" will disable SSL/TLS.

Require a client certificate for ALL services (imap, pop3, lmtp, sieve).

The length of time (in minutes) that a TLS session will be cached for later reuse. The maximum value is 1440 (24 hours), the default. A value of 0 will disable session caching.

The umask value used by various Cyrus IMAP programs.

Convert usernames to all lowercase before login/authenticate. This is useful with authentication backends which ignore case during username lookups (such as LDAP).

If using the alternate IMAP namespace, the prefix for the other users namespace. The hierarchy delimiter will be automatically appended.

Should we look up groups when using auth_unix (disable this if you are not using groups in ACLs for your IMAP server, and you are using auth_unix with a backend (such as LDAP) that can make getgrent() calls very slow)

Use the UNIX separator character ’/’ for delimiting levels of mailbox hierarchy. The default is to use the netnews separator character ’.’.

Enable virtual domain support. If enabled, the user’s domain will be determined by splitting a fully qualified userid at the last ’@’ or ’%’ symbol. If the userid is unqualified, and the virtdomains option is set to "on", then the domain will be determined by doing a reverse lookup on the IP address of the incoming network interface, otherwise the user is assumed to be in the default domain (if set).

Allowed values: off, userid, on