Sophie

Sophie

distrib > Mageia > 5 > i586 > by-pkgid > ed1936cf5c8a302844ce8f133ea87612 > files > 137

cyrus-imapd-2.4.18-1.2.mga5.i586.rpm

<!-- Creator     : groff version 1.22.2 -->
<!-- CreationDate: Tue Jan 12 19:05:02 2016 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title>IMAPD.CONF</title>

</head>
<body>

<h1 align="center">IMAPD.CONF</h1>

<a href="#NAME">NAME</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#FIELD DESCRIPTIONS">FIELD DESCRIPTIONS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>


<p>*</p>

<h2>NAME
<a name="NAME"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">imapd.conf
&minus; IMAP configuration file</p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>/etc/imapd.conf</b>
is the configuration file for the Cyrus IMAP server. It
defines local parameters for IMAP.</p>

<p style="margin-left:11%; margin-top: 1em">Each line of
the <b>/etc/imapd.conf</b> file has the form</p>

<p style="margin-left:22%; margin-top: 1em"><i>option</i>:
<i>value</i></p>

<p style="margin-left:11%; margin-top: 1em">where
<i>option</i> is the name of the configuration option being
set and <i>value</i> is the value that the configuration
option is being set to.</p>

<p style="margin-left:11%; margin-top: 1em">Although there
is no limit to the length of a line, a
&lsquo;&lsquo;\&rsquo;&rsquo; (backslash) character may be
used as the last character on a line to force it to continue
on the next one. No additional whitespace is inserted before
or after the &lsquo;&lsquo;\&rsquo;&rsquo;. Note that a line
that is split using &lsquo;&lsquo;\&rsquo;&rsquo;
character(s) is still considered a single line. For
example</p>


<p style="margin-left:22%; margin-top: 1em"><i>option</i>:\</p>

<p style="margin-left:23%;"><i>value</i>1 <i>value</i>2
\</p>

<p style="margin-left:25%;"><i>value</i>3</p>

<p style="margin-left:11%; margin-top: 1em">is equivalent
to</p>

<p style="margin-left:22%; margin-top: 1em"><i>option</i>:
<i>value</i>1 <i>value</i>2 <i>value</i>3</p>

<p style="margin-left:11%; margin-top: 1em">Blank lines and
lines beginning with &lsquo;&lsquo;#&rsquo;&rsquo; are
ignored.</p>

<p style="margin-left:11%; margin-top: 1em">For boolean and
enumerated options, the values
&lsquo;&lsquo;yes&rsquo;&rsquo;,
&lsquo;&lsquo;on&rsquo;&rsquo;,
&lsquo;&lsquo;t&rsquo;&rsquo;,
&lsquo;&lsquo;true&rsquo;&rsquo; and
&lsquo;&lsquo;1&rsquo;&rsquo; turn the option on, the values
&lsquo;&lsquo;no&rsquo;&rsquo;,
&lsquo;&lsquo;off&rsquo;&rsquo;,
&lsquo;&lsquo;f&rsquo;&rsquo;,
&lsquo;&lsquo;false&rsquo;&rsquo; and
&lsquo;&lsquo;0&rsquo;&rsquo; turn the option off.</p>

<h2>FIELD DESCRIPTIONS
<a name="FIELD DESCRIPTIONS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The sections
below detail options that can be placed in the
<b>/etc/imapd.conf</b> file, and show each option&rsquo;s
default value. Some options have no default value, these are
listed with &lsquo;&lsquo;&lt;no default&gt;&rsquo;&rsquo;.
Some options default to the empty string, these are listed
with &lsquo;&lsquo;&lt;none&gt;&rsquo;&rsquo;. <b><br>
admins:</b> &lt;empty string&gt;</p>

<p style="margin-left:18%;">The list of userids with
administrative rights. Separate each userid with a space.
Sites using Kerberos authentication may use separate
&quot;admin&quot; instances.</p>

<p style="margin-left:11%; margin-top: 1em">Note that
accounts used by users should not be administrators.
Administrative accounts should not receive mail. That is, if
user &quot;jbRo&quot; 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. <b><br>
afspts_localrealms:</b> &lt;none&gt;</p>

<p style="margin-left:18%;">The list of realms which are to
be treated as local, and thus stripped during identifier
canonicalization (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)</p>

<p style="margin-left:11%;"><b>afspts_mycell:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Cell to use for AFS PTS
lookups. Defaults to the local cell.</p>

<p style="margin-left:11%;"><b>allowallsubscribe:</b> 0</p>

<p style="margin-left:18%;">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&rsquo;t reside on their &quot;home&quot;
server. This option can also be used as a workaround for
IMAP clients which don&rsquo;t play well with nonexistent or
unselectable mailboxes (e.g., Microsoft Outlook).</p>

<p style="margin-left:11%;"><b>allowanonymouslogin:</b>
0</p>

<p style="margin-left:18%;">Permit logins by the user
&quot;anonymous&quot; using any password. Also allows use of
the SASL ANONYMOUS mechanism.</p>

<p style="margin-left:11%;"><b>allowapop:</b> 1</p>

<p style="margin-left:18%;">Allow use of the POP3 APOP
authentication command.</p>

<p style="margin-left:11%; margin-top: 1em">Note that this
command requires that SASL is compiled with APOP support,
that the plaintext passwords are available in a SASL auxprop
backend (e.g., sasldb), and that the system can provide
enough entropy (e.g., from /dev/urandom) to create a
challenge in the banner. <b><br>
allownewnews:</b> 0</p>

<p style="margin-left:18%;">Allow use of the NNTP NEWNEWS
command.</p>

<p style="margin-left:11%; margin-top: 1em">Note that this
is a very expensive command and should only be enabled when
absolutely necessary. <b><br>
allowplaintext:</b> 0</p>

<p style="margin-left:18%;">Allow the use of cleartext
passwords on the wire.</p>

<p style="margin-left:11%;"><b>allowusermoves:</b> 0</p>

<p style="margin-left:18%;">Allow moving user accounts
(with associated meta-data) via RENAME or XFER.</p>

<p style="margin-left:11%; margin-top: 1em">Note that
measures should be taken to make sure that the user being
moved is not logged in, and cannot login during the move.
Failure to do so may result in the user&rsquo;s meta-data
(seen state, subscriptions, etc) being corrupted or out of
date. <b><br>
altnamespace:</b> 0</p>

<p style="margin-left:18%;">Use the alternate IMAP
namespace, where personal folders reside at the same level
in the hierarchy as INBOX.</p>

<p style="margin-left:11%; margin-top: 1em">This option
ONLY applies where interaction takes place with the
client/user. Currently this is limited to the IMAP protocol
(imapd) and Sieve scripts (lmtpd). This option does NOT
apply to admin tools such as cyradm (admins ONLY),
reconstruct, quota, etc., NOR does it affect LMTP delivery
of messages directly to mailboxes via plus-addressing.
<b><br>
annotation_db:</b> skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
mailbox annotations.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>berkeley-hash</i>, <i>skiplist</i></p>

<p style="margin-left:11%;"><b>annotation_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
annotations db file. If not specified, will be
confdir/annotations.db</p>

<p style="margin-left:11%;"><b>anyoneuseracl:</b> 1</p>

<p style="margin-left:18%;">Should non-admin users be
allowed to set ACLs for the &rsquo;anyone&rsquo; user on
their mailboxes? In a large organization this can cause
support problems, but it&rsquo;s enabled by default.</p>

<p style="margin-left:11%;"><b>annotation_definitions:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing external
(third-party) annotation definitions.</p>

<p style="margin-left:11%; margin-top: 1em">Each line of
the file specifies the properties of an annotation and has
the following form:</p>

<p style="margin-left:22%; margin-top: 1em"><i>name</i>,
<i>scope</i>, <i>attrib-type</i>, <i>proxy-type</i>,
<i>attrib-names</i>, <i>acl</i></p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">


<p><i>name</i></p></td>
<td width="1%"></td>
<td width="82%">


<p>is the hierarchical name as in the draft standard,
typically of the form /vendor/acme/blurdybloop</p></td></tr>
</table>

<p style="margin-left:11%;"><i>scope</i></p>

<p style="margin-left:18%;">specifies whether the
annotation is for the <b>server</b> or a <b>mailbox</b></p>

<p style="margin-left:11%;"><i>attrib-type</i></p>

<p style="margin-left:18%;">specifies the attribute data
type which is one of: <b>string</b>, <b>boolean</b>,
<b>int</b>, <b>uint</b>, or <b>content-type</b></p>

<p style="margin-left:11%;"><i>proxy-type</i></p>

<p style="margin-left:18%;">specifies whether this
attribute is for the <b>backend</b> or <b>proxy</b> servers
or both (<b>proxy_and_backend</b>)</p>

<p style="margin-left:11%;"><i>attrib-names</i></p>

<p style="margin-left:18%;">is the space-separated list of
available attributes for the annotation. Possible attribute
names are (where the suffixless <b>foo</b> permits both
<b>foo.priv</b> and <b>foo.shared</b>): <b>alue</b>,
<b>value.shared</b>, <b>value.priv</b>, <b>size</b>,
<b>size.shared</b>, <b>size.priv</b>, <b>modifiedsince</b>,
<b>modifiedsince.shared</b>, <b>modifiedsince.priv</b>,
<b>content-type</b>, <b>content-type.shared</b>,
<b>content-type.priv</b></p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">


<p><i>acl</i></p></td>
<td width="3%"></td>
<td width="82%">


<p>is the extra ACL requirements for setting annotations.
This is the standard IMAP ACL permission bit string format.
Particularly useful is the <b>a</b> right to require admin
privileges. Note that some ACL requirements (read and write
on the mailbox) are hard-wired in the server</p></td></tr>
</table>

<p style="margin-left:11%; margin-top: 1em">Blank lines and
lines beginning with &lsquo;&lsquo;#&rsquo;&rsquo; are
ignored. <b><br>
auditlog:</b> 0</p>

<p style="margin-left:18%;">Should cyrus output log entries
for every action taken on a message file or mailboxes list
entry? It&rsquo;s noisy so disabled by default, but can be
very useful for tracking down what happened if things look
strange</p>

<p style="margin-left:11%;"><b>auth_mech:</b> unix</p>

<p style="margin-left:18%;">The authorization mechanism to
use.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>unix</i>, <i>pts</i>, <i>krb</i>, <i>krb5</i></p>

<p style="margin-left:11%;"><b>autocreatequota:</b> 0</p>

<p style="margin-left:18%;">If nonzero, normal users may
create their own IMAP accounts by creating the mailbox
INBOX. The user&rsquo;s quota is set to the value if it is
positive, otherwise the user has unlimited quota.</p>

<p style="margin-left:11%;"><b>berkeley_cachesize:</b>
512</p>

<p style="margin-left:18%;">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).</p>

<p style="margin-left:11%;"><b>berkeley_locks_max:</b>
50000</p>

<p style="margin-left:18%;">Maximum number of locks to be
held or requested in the berkeley environment.</p>

<p style="margin-left:11%;"><b>berkeley_txns_max:</b>
100</p>

<p style="margin-left:18%;">Maximum number of transactions
to be supported in the berkeley environment.</p>

<p style="margin-left:11%;"><b>boundary_limit:</b> 1000</p>

<p style="margin-left:18%;">messages are parsed recursively
and a deep enough MIME structure can cause a stack overflow.
Do not parse deeper than this many layers of MIME structure.
The default of 1000 is much higher than any sane message
should have.</p>

<p style="margin-left:11%;"><b>client_timeout:</b> 10</p>

<p style="margin-left:18%;">Number of seconds to wait
before returning a timeout failure when performing a client
connection (e.g., in a murder environment)</p>

<p style="margin-left:11%;"><b>commandmintimer:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Time in seconds. Any imap
command that takes longer than this time is logged.</p>

<p style="margin-left:11%;"><b>configdirectory:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The pathname of the IMAP
configuration directory. This field is required.</p>

<p style="margin-left:11%;"><b>debug_command:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">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</p>

<p style="margin-left:11%;"><b>defaultacl:</b> anyone
lrs</p>

<p style="margin-left:18%;">The Access Control List (ACL)
placed on a newly-created (non-user) mailbox that does not
have a parent mailbox.</p>

<p style="margin-left:11%;"><b>defaultdomain:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The default domain for virtual
domain support</p>

<p style="margin-left:11%;"><b>defaultpartition:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The partition name used by
default for new mailboxes. If not specified, the partition
with the most free space will be used for new mailboxes.</p>

<p style="margin-left:11%;"><b>defaultserver:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The backend server name used by
default for new mailboxes. If not specified, the server with
the most free space will be used for new mailboxes.</p>

<p style="margin-left:11%;"><b>deletedprefix:</b>
DELETED</p>

<p style="margin-left:18%;">If &quot;delete_mode&quot; set
to be &quot;delayed&quot;, the prefix for the deleted
mailboxes hierarchy. The hierarchy delimiter will be
automatically appended.</p>

<p style="margin-left:11%;"><b>delete_mode:</b>
immediate</p>

<p style="margin-left:18%;">The manner in which mailboxes
are deleted. &quot;immediate&quot; mode is the default
behavior in which mailboxes are removed immediately. In
&quot;delayed&quot; mode, mailboxes are renamed to a special
hiearchy defined by the &quot;deletedprefix&quot; option to
be removed later by cyr_expire.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>immediate</i>, <i>delayed</i></p>

<p style="margin-left:11%;"><b>deleteright:</b> c</p>

<p style="margin-left:18%;">Deprecated - only used for
backwards compatibility with existing installations. Lists
the old RFC 2086 right which was used to grant the user the
ability to delete a mailbox. If a user has this right, they
will automatically be given the new &rsquo;x&rsquo;
right.</p>

<p style="margin-left:11%;"><b>disable_user_namespace:</b>
0</p>

<p style="margin-left:18%;">Preclude list command on user
namespace. If set to &rsquo;yes&rsquo;, the LIST response
will never include any other user&rsquo;s mailbox. Admin
users will always see all mailboxes. The default is
&rsquo;no&rsquo;</p>


<p style="margin-left:11%;"><b>disable_shared_namespace:</b>
0</p>

<p style="margin-left:18%;">Preclude list command on user
namespace. If set to &rsquo;yes&rsquo;, the LIST response
will never include any non-user mailboxes. Admin users will
always see all mailboxes. The default is
&rsquo;no&rsquo;</p>


<p style="margin-left:11%;"><b>disconnect_on_vanished_mailbox:</b>
0</p>

<p style="margin-left:18%;">If enabled, IMAP/POP3/NNTP
clients will be disconnected by the server if the currently
selected mailbox is (re)moved by another session. Otherwise,
the missing mailbox is treated as empty while in use by the
client.</p>

<p style="margin-left:11%;"><b>duplicate_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the duplicate delivery suppression and sieve.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>berkeley-nosync</i>,
<i>berkeley-hash</i>, <i>berkeley-hash-nosync</i>,
<i>skiplist</i>, <i>sql</i></p>

<p style="margin-left:11%;"><b>duplicate_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
duplicate db file. If not specified, will be
confdir/deliver.db</p>

<p style="margin-left:11%;"><b>duplicatesuppression:</b>
1</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>expunge_mode:</b>
default</p>

<p style="margin-left:18%;">The mode in which messages (and
their corresponding cache entries) are expunged.
&quot;default&quot; mode is the default behavior in which
the message files are purged at the time of the EXPUNGE, but
index and cache records are retained to facilitate QRESYNC.
In &quot;delayed&quot; mode, the message files are also
retained, allowing unexpunge to rescue them. In
&quot;immediate&quot; mode, both the message files and the
index records are removed as soon as possible. In all cases,
nothing will be finally purged until all other processes
have closed the mailbox to ensure they never see data
disappear under them. In &quot;default&quot; or
&quot;delayed&quot; mode, a later run of
&quot;cyr_expire&quot; will clean out the retained records
(and possibly message files). This reduces the amount of I/O
that takes place at the time of EXPUNGE and should result in
greater responsiveness for the client, especially when
expunging a large number of messages.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>default</i>, <i>immediate</i>, <i>delayed</i></p>

<p style="margin-left:11%;"><b>expunge_days:</b> 7</p>

<p style="margin-left:18%;">Number of days to retain
expunged messages before cleaning up their index records.
The default is 7. This is necessary for QRESYNC to work
correctly. If combined with delayed expunge (above) you will
also be able to unexpunge messages during this time.</p>

<p style="margin-left:11%;"><b>failedloginpause:</b> 3</p>

<p style="margin-left:18%;">Number of seconds to pause
after a failed login.</p>

<p style="margin-left:11%;"><b>flushseenstate:</b> 0</p>

<p style="margin-left:18%;">If enabled, changes to the seen
state will be flushed to disk immediately, otherwise changes
will be cached and flushed when the mailbox is closed. This
option may be used to fix the problem of previously read
messages being marked as unread in Microsoft Outlook, at the
expense of a loss of performance/scalability.</p>

<p style="margin-left:11%;"><b>foolstupidclients:</b> 0</p>

<p style="margin-left:18%;">If enabled, only list the
personal namespace when a LIST &quot;*&quot; is performed
(it changes the request to a LIST &quot;INBOX*&quot;).</p>

<p style="margin-left:11%;"><b>force_sasl_client_mech:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Force preference of a given
SASL mechanism for client side operations (e.g., murder
environments). This is separate from (and overridden by) the
ability to use the &lt;host shortname&gt;_mechs option to
set preferred mechanisms for a specific host</p>

<p style="margin-left:11%;"><b>fulldirhash:</b> 0</p>

<p style="margin-left:18%;">If enabled, uses an improved
directory hashing scheme which hashes on the entire username
instead of using just the first letter as the hash. This
changes hash algorithm used for quota and user directories
and if <i>hashimapspool</i> is enabled, the entire mail
spool.</p>

<p style="margin-left:11%; margin-top: 1em">Note that this
option CANNOT be changed on a live system. The server must
be quiesced and then the directories moved with the
<b>rehash</b> utility. <b><br>
hashimapspool:</b> 0</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>hostname_mechs:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Force a particular 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</p>

<p style="margin-left:11%;"><b>hostname_password:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The password to use for
authentication to the backend server hostname (where
hostname is the short hostname of the server) - Cyrus
Murder</p>

<p style="margin-left:11%;"><b>idlesocket:</b>
{configdirectory}/socket/idle</p>

<p style="margin-left:18%;">Unix domain socket that idled
listens on.</p>

<p style="margin-left:11%;"><b>ignorereference:</b> 0</p>

<p style="margin-left:18%;">For backwards compatibility
with Cyrus 1.5.10 and earlier -- ignore the reference
argument in LIST or LSUB commands.</p>

<p style="margin-left:11%;"><b>imapidlepoll:</b> 60</p>

<p style="margin-left:18%;">The interval (in seconds) for
polling for mailbox changes and ALERTs while running the
IDLE command. This option is used when idled is not enabled
or cannot be contacted. The minimum value is 1. A value of 0
will disable IDLE.</p>

<p style="margin-left:11%;"><b>imapidresponse:</b> 1</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>imapmagicplus:</b> 0</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>implicit_owner_rights:</b>
lkxa</p>

<p style="margin-left:18%;">The implicit Access Control
List (ACL) for the owner of a mailbox.</p>

<p style="margin-left:11%;"><b>@include:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Directive which includes the
specified file as part of the configuration. If the path to
the file is not absolute, CYRUS_PATH is prepended.</p>

<p style="margin-left:11%;"><b>improved_mboxlist_sort:</b>
0</p>

<p style="margin-left:18%;">If enabled, a special
comparator will be used which will correctly sort mailbox
names that contain characters such as &rsquo; &rsquo; and
&rsquo;-&rsquo;.</p>

<p style="margin-left:11%; margin-top: 1em">Note that this
option SHOULD NOT be changed on a live system. The mailboxes
database should be dumped (ctl_mboxlist) before the option
is changed, removed, and then undumped after changing the
option. When not using flat files for the subscriptions
databases the same has to be done (cyr_dbtool) for each
subscription database See improved_mboxlist_sort.html.
<b><br>
internaldate_heuristic:</b> standard</p>

<p style="margin-left:18%;">Mechanism to determine email
internaldates on delivery/reconstruct. &quot;standard&quot;
uses time() when delivering a message, mtime on reconstruct.
&quot;receivedheader&quot; looks at the top most Received
header or time/mtime otherwise</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>standard</i>, <i>receivedheader</i></p>

<p style="margin-left:11%;"><b>ldap_authz:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">SASL authorization ID for the
LDAP server</p>

<p style="margin-left:11%;"><b>ldap_base:</b> &lt;empty
string&gt;</p>

<p style="margin-left:18%;">Contains the LDAP base dn for
the LDAP ptloader module</p>

<p style="margin-left:11%;"><b>ldap_bind_dn:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Bind DN for the connection to
the LDAP server (simple bind). Do not use for anonymous
simple binds</p>

<p style="margin-left:11%;"><b>ldap_deref:</b> never</p>

<p style="margin-left:18%;">Specify how aliases
dereferencing is handled during search.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>search</i>, <i>find</i>, <i>always</i>, <i>never</i></p>

<p style="margin-left:11%;"><b>ldap_filter:</b>
(uid=%u)</p>

<p style="margin-left:18%;">Specify a filter that searches
user identifiers. The following tokens can be used in the
filter string:</p>

<p style="margin-left:18%; margin-top: 1em">%% = % %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)</p>

<p style="margin-left:18%; margin-top: 1em">ldap_filter is
not used when ldap_sasl is enabled.</p>

<p style="margin-left:11%;"><b>ldap_group_base:</b>
&lt;empty string&gt;</p>

<p style="margin-left:18%;">LDAP base dn for
ldap_group_filter.</p>

<p style="margin-left:11%;"><b>ldap_group_filter:</b>
(cn=%u)</p>

<p style="margin-left:18%;">Specify a filter that searches
for group identifiers. See ldap_filter for more options.</p>

<p style="margin-left:11%;"><b>ldap_group_scope:</b>
sub</p>

<p style="margin-left:18%;">Specify search scope for
ldap_group_filter.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>sub</i>, <i>one</i>, <i>base</i></p>

<p style="margin-left:11%;"><b>ldap_id:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">SASL authentication ID for the
LDAP server</p>

<p style="margin-left:11%;"><b>ldap_mech:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">SASL mechanism for LDAP
authentication</p>

<p style="margin-left:11%;"><b>ldap_member_attribute:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">See ldap_member_method.</p>

<p style="margin-left:11%;"><b>ldap_member_base:</b>
&lt;empty string&gt;</p>

<p style="margin-left:18%;">LDAP base dn for
ldap_member_filter.</p>

<p style="margin-left:11%;"><b>ldap_member_filter:</b>
(member=%D)</p>

<p style="margin-left:18%;">Specify a filter for
&quot;ldap_member_method: filter&quot;. See ldap_filter for
more options.</p>

<p style="margin-left:11%;"><b>ldap_member_method:</b>
attribute</p>

<p style="margin-left:18%;">Specify a group method. The
&quot;attribute&quot; method retrieves groups from a
multi-valued attribute specified in
ldap_member_attribute.</p>

<p style="margin-left:18%; margin-top: 1em">The
&quot;filter&quot; method uses a filter, specified by
ldap_member_filter, to find groups; ldap_member_attribute is
a single-value attribute group name.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>attribute</i>, <i>filter</i></p>

<p style="margin-left:11%;"><b>ldap_member_scope:</b>
sub</p>

<p style="margin-left:18%;">Specify search scope for
ldap_member_filter.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>sub</i>, <i>one</i>, <i>base</i></p>

<p style="margin-left:11%;"><b>ldap_password:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Password for the connection to
the LDAP server (SASL and simple bind). Do not use for
anonymous simple binds</p>

<p style="margin-left:11%;"><b>ldap_realm:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">SASL realm for LDAP
authentication</p>

<p style="margin-left:11%;"><b>ldap_referrals:</b> 0</p>

<p style="margin-left:18%;">Specify whether or not the
client should follow referrals.</p>

<p style="margin-left:11%;"><b>ldap_restart:</b> 1</p>

<p style="margin-left:18%;">Specify whether or not LDAP I/O
operations are automatically restarted if they abort
prematurely.</p>

<p style="margin-left:11%;"><b>ldap_sasl:</b> 1</p>

<p style="margin-left:18%;">Use SASL for LDAP binds in the
LDAP PTS module.</p>

<p style="margin-left:11%;"><b>ldap_sasl_authc:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Deprecated. Use ldap_id</p>

<p style="margin-left:11%;"><b>ldap_sasl_authz:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Deprecated. Use ldap_authz</p>

<p style="margin-left:11%;"><b>ldap_sasl_mech:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Deprecated. Use ldap_mech</p>

<p style="margin-left:11%;"><b>ldap_sasl_password:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Deprecated. User
ldap_password</p>

<p style="margin-left:11%;"><b>ldap_sasl_realm:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Deprecated. Use ldap_realm</p>

<p style="margin-left:11%;"><b>ldap_scope:</b> sub</p>

<p style="margin-left:18%;">Specify search scope.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>sub</i>, <i>one</i>, <i>base</i></p>

<p style="margin-left:11%;"><b>ldap_servers:</b>
ldap://localhost/</p>

<p style="margin-left:18%;">Deprecated. Use ldap_uri</p>

<p style="margin-left:11%;"><b>ldap_size_limit:</b> 1</p>

<p style="margin-left:18%;">Specify a number of entries for
a search request to return.</p>

<p style="margin-left:11%;"><b>ldap_start_tls:</b> 0</p>

<p style="margin-left:18%;">Use StartTLS extended
operation. Do not use ldaps: ldap_uri when this option is
enabled.</p>

<p style="margin-left:11%;"><b>ldap_time_limit:</b> 5</p>

<p style="margin-left:18%;">Specify a number of seconds for
a search request to complete.</p>

<p style="margin-left:11%;"><b>ldap_timeout:</b> 5</p>

<p style="margin-left:18%;">Specify a number of seconds a
search can take before timing out.</p>

<p style="margin-left:11%;"><b>ldap_tls_cacert_dir:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Path to directory with CA
(Certificate Authority) certificates.</p>

<p style="margin-left:11%;"><b>ldap_tls_cacert_file:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing CA (Certificate
Authority) certificate(s).</p>

<p style="margin-left:11%;"><b>ldap_tls_cert:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing the client
certificate.</p>

<p style="margin-left:11%;"><b>ldap_tls_check_peer:</b>
0</p>

<p style="margin-left:18%;">Require and verify server
certificate. If this option is yes, you must specify
ldap_tls_cacert_file or ldap_tls_cacert_dir.</p>

<p style="margin-left:11%;"><b>ldap_tls_ciphers:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">List of SSL/TLS ciphers to
allow. The format of the string is described in
ciphers(1).</p>

<p style="margin-left:11%;"><b>ldap_tls_key:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing the private
client key.</p>

<p style="margin-left:11%;"><b>ldap_uri:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Contains a list of the URLs of
all the LDAP servers when using the LDAP PTS module.</p>

<p style="margin-left:11%;"><b>ldap_version:</b> 3</p>

<p style="margin-left:18%;">Specify the LDAP protocol
version. If ldap_start_tls and/or ldap_use_sasl are enabled,
ldap_version will be automatically set to 3.</p>

<p style="margin-left:11%;"><b>lmtp_downcase_rcpt:</b>
0</p>

<p style="margin-left:18%;">If enabled, lmtpd will convert
the recipient addresses to lowercase (up to a
&rsquo;+&rsquo; character, if present).</p>


<p style="margin-left:11%;"><b>lmtp_fuzzy_mailbox_match:</b>
0</p>

<p style="margin-left:18%;">If enabled, and the mailbox
specified in the detail part of the recipient (everything
after the &rsquo;+&rsquo;) does not exist, lmtpd will try to
find the closest match (ignoring case, ignoring whitespace,
falling back to parent) to the specified mailbox name.</p>


<p style="margin-left:11%;"><b>lmtp_over_quota_perm_failure:</b>
0</p>

<p style="margin-left:18%;">If enabled, lmtpd returns a
permanent failure code when a user&rsquo;s mailbox is over
quota. By default, the failure is temporary, causing the MTA
to queue the message and retry later.</p>

<p style="margin-left:11%;"><b>lmtp_strict_quota:</b> 0</p>

<p style="margin-left:18%;">If enabled, lmtpd returns a
failure code when the incoming message will cause the
user&rsquo;s mailbox to exceed its quota. By default, the
failure won&rsquo;t occur until the mailbox is already over
quota.</p>

<p style="margin-left:11%;"><b>lmtp_strict_rfc2821:</b>
1</p>

<p style="margin-left:18%;">By default, lmtpd will be
strict (per RFC 2821) with regards to which envelope
addresses are allowed. If this option is set to false, 8bit
characters in the local-part of envelope addresses are
changed to &rsquo;X&rsquo; instead. This is useful to avoid
generating backscatter with certain MTAs like Postfix or
Exim which accept such messages.</p>

<p style="margin-left:11%;"><b>lmtpsocket:</b>
{configdirectory}/socket/lmtp</p>

<p style="margin-left:18%;">Unix domain socket that lmtpd
listens on, used by deliver(8). This should match the path
specified in cyrus.conf(5).</p>

<p style="margin-left:11%;"><b>lmtptxn_timeout:</b> 300</p>

<p style="margin-left:18%;">Timeout (in seconds) used
during a lmtp transaction to a remote backend (e.g. in a
murder environment). Can be used to prevent hung lmtpds on
proxy hosts when a backend server becomes unresponsive
during a lmtp transaction. The default is 300 - change to
zero for infinite.</p>

<p style="margin-left:11%;"><b>loginrealms:</b> &lt;empty
string&gt;</p>

<p style="margin-left:18%;">The list of remote realms whose
users may authenticate using cross-realm authentication
identifiers. Separate each realm name by a space. (A
cross-realm identity is considered any identity returned by
SASL with an &quot;@&quot; in it.).</p>

<p style="margin-left:11%;"><b>loginuseacl:</b> 0</p>

<p style="margin-left:18%;">If enabled, any authentication
identity which has <b>a</b> rights on a user&rsquo;s INBOX
may log in as that user.</p>

<p style="margin-left:11%;"><b>logtimestamps:</b> 0</p>

<p style="margin-left:18%;">Include notations in the
protocol telemetry logs indicating the number of seconds
since the last command or response.</p>


<p style="margin-left:11%;"><b>mailbox_default_options:</b>
0</p>

<p style="margin-left:18%;">Default &quot;options&quot;
field for the mailbox on create. You&rsquo;ll want to know
what you&rsquo;re doing before setting this, but it can
apply some default annotations like duplicate supression</p>

<p style="margin-left:11%;"><b>mailnotifier:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Notifyd(8) method to use for
&quot;MAIL&quot; notifications. If not set, &quot;MAIL&quot;
notifications are disabled.</p>

<p style="margin-left:11%;"><b>maxheaderlines:</b> 1000</p>

<p style="margin-left:18%;">Maximum number of lines of
header that will be processed into cache records. Default
1000. If set to zero, it is unlimited. If a message hits the
limit, an error will be logged and the rest of the lines in
the header will be skipped. This is to avoid malformed
messages causing giant cache records</p>

<p style="margin-left:11%;"><b>maxmessagesize:</b> 0</p>

<p style="margin-left:18%;">Maximum incoming LMTP message
size. If non-zero, lmtpd will reject messages larger than
<i>maxmessagesize</i> bytes. If set to 0, this will allow
messages of any size (the default).</p>

<p style="margin-left:11%;"><b>maxquoted:</b> 131072</p>

<p style="margin-left:18%;">Maximum size of a single quoted
string for the parser. Default 128k</p>

<p style="margin-left:11%;"><b>maxword:</b> 131072</p>

<p style="margin-left:18%;">Maximum size of a single word
for the parser. Default 128k</p>

<p style="margin-left:11%;"><b>mboxkey_db:</b> skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
mailbox keys.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>skiplist</i></p>

<p style="margin-left:11%;"><b>mboxlist_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the mailbox list.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>flat</i>, <i>berkeley</i>, <i>berkeley-hash</i>,
<i>skiplist</i>, <i>sql</i></p>

<p style="margin-left:11%;"><b>mboxlist_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
mailboxes db file. If not specified will be
confdir/mailboxes.db</p>

<p style="margin-left:11%;"><b>mboxname_lockpath:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Path to mailbox name lock files
(default $conf/lock)</p>

<p style="margin-left:11%;"><b>metapartition_files:</b>
&lt;empty string&gt;</p>

<p style="margin-left:18%;">Space-separated list of
metadata files to be stored on a <i>metapartition</i> rather
than in the mailbox directory on a spool partition.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>header</i>, <i>index</i>, <i>cache</i>, <i>expunge</i>,
<i>squat</i></p>

<p style="margin-left:11%;"><b>metapartition-name:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The pathname of the metadata
partition <i>name</i>, corresponding to spool partition
<b>partition-name</b>. For any mailbox residing in a
directory on <b>partition-name</b>, the metadata files
listed in <i>metapartition_files</i> will be stored in a
corresponding directory on <b>metapartition-name</b>. Note
that not every <b>partition-name</b> option is required to
have a corresponding <b>metapartition-name</b> option, so
that you can selectively choose which spool partitions will
have separate metadata partitions.</p>

<p style="margin-left:11%;"><b>mupdate_authname:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The SASL username
(Authentication Name) to use when authenticating to the
mupdate server (if needed).</p>

<p style="margin-left:11%;"><b>mupdate_config:</b>
standard</p>

<p style="margin-left:18%;">The configuration of the
mupdate servers in the Cyrus Murder. The
&quot;standard&quot; config is one in which there are
discreet frontend (proxy) and backend servers. The
&quot;unified&quot; config is one in which a server can be
both a frontend and backend. The &quot;replicated&quot;
config is one in which multiple backend servers all share
the same mailspool, but each have their own
&quot;replicated&quot; copy of mailboxes.db.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>standard</i>, <i>unified</i>, <i>replicated</i></p>

<p style="margin-left:11%;"><b>munge8bit:</b> 1</p>

<p style="margin-left:18%;">If enabled, lmtpd munges
messages with 8-bit characters in the headers. The 8-bit
characters are changed to &lsquo;X&rsquo;. If
<b>reject8bit</b> is enabled, setting <b>munge8bit</b> has
no effect. (A proper solution to non-ASCII characters in
headers is offered by RFC 2047 and its predecessors.)</p>


<p style="margin-left:11%;"><b>mupdate_connections_max:</b>
128</p>

<p style="margin-left:18%;">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 immediately issued a BYE
response.</p>

<p style="margin-left:11%;"><b>mupdate_password:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The SASL password (if needed)
to use when authenticating to the mupdate server.</p>

<p style="margin-left:11%;"><b>mupdate_port:</b> 3905</p>

<p style="margin-left:18%;">The port of the mupdate server
for the Cyrus Murder</p>

<p style="margin-left:11%;"><b>mupdate_realm:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The SASL realm (if needed) to
use when authenticating to the mupdate server.</p>

<p style="margin-left:11%;"><b>mupdate_retry_delay:</b>
20</p>

<p style="margin-left:18%;">The base time to wait between
connection retries to the mupdate server.</p>

<p style="margin-left:11%;"><b>mupdate_server:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The mupdate server for the
Cyrus Murder</p>

<p style="margin-left:11%;"><b>mupdate_username:</b>
&lt;empty string&gt;</p>

<p style="margin-left:18%;">The SASL username
(Authorization Name) to use when authenticating to the
mupdate server</p>

<p style="margin-left:11%;"><b>mupdate_workers_max:</b>
50</p>

<p style="margin-left:18%;">The maximum number of mupdate
worker threads (overall)</p>


<p style="margin-left:11%;"><b>mupdate_workers_maxspare:</b>
10</p>

<p style="margin-left:18%;">The maximum number of idle
mupdate worker threads</p>


<p style="margin-left:11%;"><b>mupdate_workers_minspare:</b>
2</p>

<p style="margin-left:18%;">The minimum number of idle
mupdate worker threads</p>

<p style="margin-left:11%;"><b>mupdate_workers_start:</b>
5</p>

<p style="margin-left:18%;">The number of mupdate worker
threads to start</p>

<p style="margin-left:11%;"><b>netscapeurl:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">If enabled at compile time,
this specifies a URL to reply when Netscape asks the server
where the mail administration HTTP server is. Administrators
should set this to a local resource.</p>

<p style="margin-left:11%;"><b>newsaddheaders:</b> to</p>

<p style="margin-left:18%;">Space-separated list of headers
to be added to incoming usenet articles. Added <i>To:</i>
headers will contain email delivery addresses corresponding
to each newsgroup in the <i>Newsgroups:</i> header. Added
<i>Reply-To:</i> headers will contain email delivery
addresses corresponding to each newsgroup in the
<i>Followup-To:</i> or <i>Newsgroups:</i> header. If the
specified header(s) already exist in an article, the email
delivery addresses will be appended to the original header
body(s).</p>

<p style="margin-left:18%; margin-top: 1em">This option
applies if and only if the <b>newspostuser</b> option is
set.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>to</i>, <i>replyto</i></p>

<p style="margin-left:11%;"><b>newsgroups:</b> *</p>

<p style="margin-left:18%;">A wildmat pattern specifying
which mailbox hierarchies should be treated as newsgroups.
Only mailboxes matching the wildmat will accept and/or serve
articles via NNTP. If not set, a default wildmat of
&quot;*&quot; (ALL shared mailboxes) will be used. If the
<i>newsprefix</i> option is also set, the default wildmat
will be translated to &quot;&lt;newsprefix&gt;.*&quot;</p>

<p style="margin-left:11%;"><b>newsmaster:</b> news</p>

<p style="margin-left:18%;">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
&quot;news&quot; user the &rsquo;d&rsquo; right on the
desired mailboxes. To allow newsgroups to be automatically
created, deleted and renamed by the corresponding control
messages, give the &quot;news&quot; user the &rsquo;c&rsquo;
right on the desired mailbox hierarchies.</p>

<p style="margin-left:11%;"><b>newspeer:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">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 &rsquo;host&rsquo;
is the fully qualified hostname of the server,
&rsquo;port&rsquo; is the port on which the server is
listening, &rsquo;user&rsquo; and &rsquo;pass&rsquo; are the
authentication credentials and &rsquo;wildmat&rsquo; is a
pattern that specifies which groups should be fed. If no
&rsquo;port&rsquo; is specified, port 119 is used. If no
&rsquo;wildmat&rsquo; is specified, all groups are fed. If
&rsquo;user&rsquo; 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.</p>

<p style="margin-left:18%; margin-top: 1em">A
&rsquo;@&rsquo; may be used in place of &rsquo;!&rsquo; 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
&quot;peer.example.com:*,!control.*,@local.*&quot; 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.</p>

<p style="margin-left:11%;"><b>newspostuser:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Userid used to deliver usenet
articles to newsgroup folders (usually via lmtp2nntp). For
example, if set to &quot;post&quot;, email sent to
&quot;post+comp.mail.imap&quot; would be delivered to the
&quot;comp.mail.imap&quot; folder.</p>

<p style="margin-left:18%; margin-top: 1em">When set, the
Cyrus NNTP server will add the header(s) specified in the
<b>newsaddheaders</b> option to each incoming usenet
article. The added header(s) will contain email delivery
addresses corresponding to each relevent newsgroup. If not
set, no headers are added to usenet articles.</p>

<p style="margin-left:11%;"><b>newsprefix:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Prefix to be prepended to
newsgroup names to make the corresponding IMAP mailbox
names.</p>

<p style="margin-left:11%;"><b>newsrc_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the newsrc
db file. If not specified, will be confdir/fetchnews.db</p>

<p style="margin-left:11%;"><b>nntptimeout:</b> 3</p>

<p style="margin-left:18%;">Set the length of the NNTP
server&rsquo;s inactivity autologout timer, in minutes. The
minimum value is 3, the default.</p>

<p style="margin-left:11%;"><b>notifysocket:</b>
{configdirectory}/socket/notify</p>

<p style="margin-left:18%;">Unix domain socket that the
mail notification daemon listens on.</p>

<p style="margin-left:11%;"><b>notify_external:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Path to the external program
that notifyd(8) will call to send mail notifications.</p>

<p style="margin-left:11%; margin-top: 1em">The external
program will be called with the following command line
options: <b><br>
&minus;c</b> <i>class</i> <b><br>
&minus;p</b> <i>priority</i> <b><br>
&minus;u</b> <i>user</i> <b><br>
&minus;m</b> <i>mailbox</i></p>

<p style="margin-left:11%; margin-top: 1em">And the
notification message will be available on <i>stdin</i>.
<b><br>
partition-name:</b> &lt;none&gt;</p>

<p style="margin-left:18%;">The pathname of the partition
<i>name</i>. At least one partition pathname MUST be
specified. If the <b>defaultpartition</b> option is used,
then its pathname MUST be specified. For example, if the
value of the <b>defaultpartion</b> option is <b>default</b>,
then the <b>partition-default</b> field is required.</p>

<p style="margin-left:11%;"><b>plaintextloginpause:</b>
0</p>

<p style="margin-left:18%;">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.)</p>

<p style="margin-left:11%;"><b>plaintextloginalert:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Message to send to client after
a successful plaintext login.</p>

<p style="margin-left:11%;"><b>popexpiretime:</b> -1</p>

<p style="margin-left:18%;">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).
&quot;NEVER&quot;, 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.</p>

<p style="margin-left:11%;"><b>popminpoll:</b> 0</p>

<p style="margin-left:18%;">Set the minimum amount of time
the server forces users to wait between successive POP
logins, in minutes.</p>

<p style="margin-left:11%;"><b>popsubfolders:</b> 0</p>

<p style="margin-left:18%;">Allow access to subfolders of
INBOX via POP3 by using userid+subfolder syntax as the
authentication/authorization id.</p>

<p style="margin-left:11%;"><b>poppollpadding:</b> 1</p>

<p style="margin-left:18%;">Create a softer minimum poll
restriction. Allows <i>poppollpadding</i> connections before
the minpoll restriction is triggered. Additionally, one
padding entry is recovered every <i>popminpoll</i> minutes.
This allows for the occasional polling rate faster than
popminpoll, (i.e., for clients that require a send/receive
to send mail) but still enforces the rate long-term. Default
is 1 (disabled).</p>

<p style="margin-left:18%; margin-top: 1em">The easiest way
to think of it is a queue of past connections, with one slot
being filled for every connection, and one slot being
cleared every <i>popminpoll</i> minutes. When the queue is
full, the user will not be able to check mail again until a
slot is cleared. If the user waits a sufficient amount of
time, they will get back many or all of the slots.</p>

<p style="margin-left:11%;"><b>poptimeout:</b> 10</p>

<p style="margin-left:18%;">Set the length of the POP
server&rsquo;s inactivity autologout timer, in minutes. The
minimum value is 10, the default.</p>

<p style="margin-left:11%;"><b>popuseacl:</b> 0</p>

<p style="margin-left:18%;">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 &rsquo;r&rsquo;,
user to open the mailbox and list/retrieve messages. The
&rsquo;t&rsquo; right allows the user to delete messages.
The &rsquo;s&rsquo; right allows messages retrieved by the
user to have the \Seen flag set (only if
<i>popuseimapflags</i> is also enabled).</p>

<p style="margin-left:11%;"><b>popuseimapflags:</b> 0</p>

<p style="margin-left:18%;">If enabled, the pop server will
set and obey IMAP flags. Messages having the \Deleted flag
are ignored as if they do not exist. Messages that are
retrieved by the client will have the \Seen flag set. All
messages will have the \Recent flag unset.</p>

<p style="margin-left:11%;"><b>postmaster:</b>
postmaster</p>

<p style="margin-left:18%;">Username that is used as the
&rsquo;From&rsquo; address in rejection MDNs produced by
sieve.</p>

<p style="margin-left:11%;"><b>postuser:</b> &lt;empty
string&gt;</p>

<p style="margin-left:18%;">Userid used to deliver messages
to shared folders. For example, if set to &quot;bb&quot;,
email sent to &quot;bb+shared.blah&quot; would be delivered
to the &quot;shared.blah&quot; folder. By default, an email
address of &quot;+shared.blah&quot; would be used.</p>

<p style="margin-left:11%;"><b>proc_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Path to proc directory. Default
is NULL - must be an absolute path if specified. If not
specified, the path $confdir/proc/ will be used.</p>

<p style="margin-left:11%;"><b>proxy_authname:</b>
proxy</p>

<p style="margin-left:18%;">The authentication name to use
when authenticating to a backend server in the Cyrus
Murder.</p>

<p style="margin-left:11%;"><b>proxy_compress:</b> 0</p>

<p style="margin-left:18%;">Try to enable protocol-specific
compression when performing a client connection to a backend
server in the Cyrus Murder.</p>

<p style="margin-left:11%; margin-top: 1em">Note that this
should only be necessary over slow network connections. Also
note that currently only IMAP and MUPDATE support
compression. <b><br>
proxy_password:</b> &lt;none&gt;</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>proxy_realm:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The authentication realm to use
when authenticating to a backend server in the Cyrus
Murder</p>


<p style="margin-left:11%;"><b>proxyd_allow_status_referral:</b>
0</p>

<p style="margin-left:18%;">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.</p>


<p style="margin-left:11%;"><b>proxyd_disable_mailbox_referrals:</b>
0</p>

<p style="margin-left:18%;">Set to true to disable the use
of mailbox-referrals on the proxy servers.</p>

<p style="margin-left:11%;"><b>proxyservers:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">A list of users and groups that
are allowed to proxy for other users, separated by spaces.
Any user listed in this will be allowed to login for any
other user: use with caution. In a standard murder this
option should ONLY be set on backends. DO NOT SET on
frontends or things won&rsquo;t work properly.</p>

<p style="margin-left:11%;"><b>pts_module:</b> afskrb</p>

<p style="margin-left:18%;">The PTS module to use.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>afskrb</i>, <i>ldap</i></p>

<p style="margin-left:11%;"><b>ptloader_sock:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Unix domain socket that
ptloader listens on. (defaults to
configdir/ptclient/ptsock)</p>

<p style="margin-left:11%;"><b>ptscache_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the pts cache.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>berkeley-hash</i>, <i>skiplist</i></p>

<p style="margin-left:11%;"><b>ptscache_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
ptscache db file. If not specified, will be
confdir/ptscache.db</p>

<p style="margin-left:11%;"><b>ptscache_timeout:</b>
10800</p>

<p style="margin-left:18%;">The timeout (in seconds) for
the PTS cache database when using the auth_krb_pts
authorization method (default: 3 hours).</p>

<p style="margin-left:11%;"><b>ptskrb5_convert524:</b>
1</p>

<p style="margin-left:18%;">When using the AFSKRB ptloader
module with Kerberos 5 canonicalization, do the final 524
conversion to get a n AFS style name (using &rsquo;.&rsquo;
instead of &rsquo;/&rsquo;, and using short names</p>


<p style="margin-left:11%;"><b>ptskrb5_strip_default_realm:</b>
1</p>

<p style="margin-left:18%;">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)</p>

<p style="margin-left:11%;"><b>qosmarking:</b> cs0</p>

<p style="margin-left:18%;">This specifies the Class
Selector or Differentiated Services Code Point designation
on IP headers (in the ToS field).</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>cs0</i>, <i>cs1</i>, <i>cs2</i>, <i>cs3</i>, <i>cs4</i>,
<i>cs5</i>, <i>cs6</i>, <i>cs7</i>, <i>af11</i>,
<i>af12</i>, <i>af13</i>, <i>af21</i>, <i>af22</i>,
<i>af23</i>, <i>af31</i>, <i>af32</i>, <i>af33</i>,
<i>af41</i>, <i>af42</i>, <i>af43</i>, <i>ef</i></p>

<p style="margin-left:11%;"><b>quota_db:</b>
quotalegacy</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
quotas.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>flat</i>, <i>berkeley</i>, <i>berkeley-hash</i>,
<i>skiplist</i>, <i>sql</i>, <i>quotalegacy</i></p>

<p style="margin-left:11%;"><b>quota_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path for the quota
database (if you choose a single-file quota DB type - or the
base path if you choose quotalegacy). If not specified will
be confdir/quota.db or confdir/quota/</p>

<p style="margin-left:11%;"><b>quotawarn:</b> 90</p>

<p style="margin-left:18%;">The percent of quota
utilization over which the server generates warnings.</p>

<p style="margin-left:11%;"><b>quotawarnkb:</b> 0</p>

<p style="margin-left:18%;">The maximum amount of free
space (in kB) at 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).</p>

<p style="margin-left:11%;"><b>reject8bit:</b> 0</p>

<p style="margin-left:18%;">If enabled, lmtpd rejects
messages with 8-bit characters in the headers.</p>

<p style="margin-left:11%;"><b>rfc2046_strict:</b> 0</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>rfc3028_strict:</b> 1</p>

<p style="margin-left:18%;">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
&quot;to&quot; and &quot;from&quot; will be allowed in
envelope tests. When disabled, ANY grammatically correct
header will be allowed.</p>

<p style="margin-left:11%;"><b>sasl_auto_transition:</b>
0</p>

<p style="margin-left:18%;">If enabled, the SASL library
will automatically create authentication secrets when given
a plaintext password. See the SASL documentation.</p>

<p style="margin-left:11%;"><b>sasl_maximum_layer:</b>
256</p>

<p style="margin-left:18%;">Maximum SSF (security strength
factor) that the server will allow a client to
negotiate.</p>

<p style="margin-left:11%;"><b>sasl_minimum_layer:</b>
0</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>sasl_option:</b> 0</p>

<p style="margin-left:18%;">Any SASL option can be set by
preceding it with &quot;sasl_&quot;. This file overrides the
SASL configuration file.</p>

<p style="margin-left:11%;"><b>sasl_pwcheck_method:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The mechanism used by the
server to verify plaintext passwords. Possible values
include &quot;auxprop&quot;, &quot;saslauthd&quot;, and
&quot;pwcheck&quot;.</p>

<p style="margin-left:11%;"><b>seenstate_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the seen state.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>flat</i>, <i>berkeley</i>, <i>berkeley-hash</i>,
<i>skiplist</i></p>

<p style="margin-left:11%;"><b>sendmail:</b>
/usr/lib/sendmail</p>

<p style="margin-left:18%;">The pathname of the sendmail
executable. Sieve invokes sendmail for sending rejections,
redirects and vacation responses.</p>

<p style="margin-left:11%;"><b>serverlist:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Whitespace separated list of
backend server names. Used for finding server with the most
available free space for proxying CREATE.</p>

<p style="margin-left:11%;"><b>servername:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>serverinfo:</b> on</p>

<p style="margin-left:18%;">The server information to
display in the greeting and capability responses.
Information is displayed as follows:</p>


<p style="margin-left:18%; margin-top: 1em">&quot;off&quot;
= no server information in the greeting or capabilities <br>
&quot;min&quot; = <i>servername</i> in the greeting; no
server information in the capabilities <br>
&quot;on&quot; = <i>servername</i> and product version in
the greeting; product version in the capabilities</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>off</i>, <i>min</i>, <i>on</i></p>

<p style="margin-left:11%;"><b>sharedprefix:</b> Shared
Folders</p>

<p style="margin-left:18%;">If using the alternate IMAP
namespace, the prefix for the shared namespace. The
hierarchy delimiter will be automatically appended.</p>

<p style="margin-left:11%;"><b>sieve_allowreferrals:</b>
1</p>

<p style="margin-left:18%;">If enabled, timsieved will
issue referrals to clients when the user&rsquo;s scripts
reside on a remote server (in a Murder). Otherwise,
timsieved will proxy traffic to the remote server.</p>

<p style="margin-left:11%;"><b>sieve_extensions:</b>
fileinto reject vacation imapflags notify envelope <br>
relational regex subaddress copy imap4flags</p>

<p style="margin-left:18%;">Space-separated list of Sieve
extensions allowed to be used in sieve scripts, enforced at
submission by timsieved(8). Any previously installed script
will be unaffected by this option and will continue to
execute regardless of the extensions used. This option has
no effect on options that are disabled at compile time
(e.g., &quot;regex&quot;).</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>fileinto</i>, <i>reject</i>, <i>vacation</i>,
<i>imapflags</i>, <i>notify</i>, <i>include</i>,
<i>envelope</i>, <i>body</i>, <i>relational</i>,
<i>regex</i>, <i>subaddress</i>, <i>copy</i>,
<i>imap4flags</i></p>

<p style="margin-left:11%;"><b>sieve_maxscriptsize:</b>
32</p>

<p style="margin-left:18%;">Maximum size (in kilobytes) any
sieve script can be, enforced at submission by
timsieved(8).</p>

<p style="margin-left:11%;"><b>sieve_maxscripts:</b> 5</p>

<p style="margin-left:18%;">Maximum number of sieve scripts
any user may have, enforced at submission by
timsieved(8).</p>

<p style="margin-left:11%;"><b>sieve_utf8fileinto:</b>
0</p>

<p style="margin-left:18%;">If enabled, the sieve engine
expects folder names for the <i>fileinto</i> action in
scripts to use UTF8 encoding. Otherwise, modified UTF7
encoding should be used.</p>


<p style="margin-left:11%;"><b>sieve_sasl_send_unsolicited_capability:</b>
0</p>

<p style="margin-left:18%;">If enabled, timsieved will emit
a capability response after a successful SASL
authentication, per draft-martin-managesieve-12.txt .</p>

<p style="margin-left:11%;"><b>sievedir:</b> /usr/sieve</p>

<p style="margin-left:18%;">If sieveusehomedir is false,
this directory is searched for Sieve scripts.</p>

<p style="margin-left:11%;"><b>sievenotifier:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Notifyd(8) method to use for
&quot;SIEVE&quot; notifications. If not set,
&quot;SIEVE&quot; notifications are disabled.</p>

<p style="margin-left:11%; margin-top: 1em">This method is
only used when no method is specified in the script. <b><br>
sieveusehomedir:</b> 0</p>

<p style="margin-left:18%;">If enabled, lmtpd will look for
Sieve scripts in user&rsquo;s home directories:
~user/.sieve.</p>

<p style="margin-left:11%;"><b>singleinstancestore:</b>
1</p>

<p style="margin-left:18%;">If enabled, imapd, 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.</p>


<p style="margin-left:11%;"><b>skiplist_always_checkpoint:</b>
1</p>

<p style="margin-left:18%;">If enabled, this option forces
the skiplist cyrusdb backend to always checkpoint when doing
a recovery. This causes slightly more IO, but on the other
hand leads to more efficient databases, and the entire file
is already &quot;hot&quot;.</p>

<p style="margin-left:11%;"><b>skiplist_unsafe:</b> 0</p>

<p style="margin-left:18%;">If enabled, this option forces
the skiplist cyrusdb backend to not sync writes to the disk.
Enabling this option is NOT RECOMMENDED.</p>

<p style="margin-left:11%;"><b>soft_noauth:</b> 1</p>

<p style="margin-left:18%;">If enabled, lmtpd returns
temporary failures if the client does not successfully
authenticate. Otherwise lmtpd returns permanent failures
(causing the mail to bounce immediately).</p>

<p style="margin-left:11%;"><b>specialusealways:</b> 0</p>

<p style="margin-left:18%;">If enabled, this option causes
LIST and LSUB output to always include the XLIST
&quot;special-use&quot; flags. See
&quot;xlist-*&rsquo;&quot;</p>

<p style="margin-left:11%;"><b>sql_database:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Name of the database which
contains the cyrusdb table(s).</p>

<p style="margin-left:11%;"><b>sql_engine:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Name of the SQL engine to
use.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>mysql</i>, <i>pgsql</i>, <i>sqlite</i></p>

<p style="margin-left:11%;"><b>sql_hostnames:</b> &lt;empty
string&gt;</p>

<p style="margin-left:18%;">Comma separated list of SQL
servers (in host[:port] format).</p>

<p style="margin-left:11%;"><b>sql_passwd:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Password to use for
authentication to the SQL server.</p>

<p style="margin-left:11%;"><b>sql_user:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Username to use for
authentication to the SQL server.</p>

<p style="margin-left:11%;"><b>sql_usessl:</b> 0</p>

<p style="margin-left:18%;">If enabled, a secure connection
will be made to the SQL server.</p>

<p style="margin-left:11%;"><b>srvtab:</b> &lt;empty
string&gt;</p>

<p style="margin-left:18%;">The pathname of <i>srvtab</i>
file containing the server&rsquo;s private key. This option
is passed to the SASL library and overrides its default
setting.</p>

<p style="margin-left:11%;"><b>submitservers:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">A list of users and groups that
are allowed to resolve &quot;urlauth=submit+&quot; IMAP
URLs, separated by spaces. Any user listed in this will be
allowed to fetch the contents of any valid
&quot;urlauth=submit+&quot; IMAP URL: use with caution.</p>

<p style="margin-left:11%;"><b>subscription_db:</b>
flat</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the subscriptions list.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>flat</i>, <i>berkeley</i>, <i>berkeley-hash</i>,
<i>skiplist</i></p>

<p style="margin-left:11%;"><b>suppress_capabilities:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Suppress the named capabilities
from any capability response. Use the exact case as it
appears in the response, e.g. &quot;suppress_capabilities:
ESEARCH QRESYNC WITHIN XLIST LIST-EXTENDED&quot; if you have
a murder with 2.3.x backends and don&rsquo;t want clients
being confused by new capabilities that some backends
don&rsquo;t support.</p>

<p style="margin-left:11%;"><b>statuscache:</b> 0</p>

<p style="margin-left:18%;">Enable/disable the imap status
cache.</p>

<p style="margin-left:11%;"><b>statuscache_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the imap status cache.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>berkeley-nosync</i>,
<i>berkeley-hash</i>, <i>berkeley-hash-nosync</i>,
<i>skiplist</i>, <i>sql</i></p>

<p style="margin-left:11%;"><b>statuscache_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
statuscache db file. If not specified, will be
confdir/statuscache.db</p>

<p style="margin-left:11%;"><b>sync_authname:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The authentication name to use
when authenticating to a sync server. Prefix with a channel
name to only apply for that channel</p>

<p style="margin-left:11%;"><b>sync_compress:</b> 0</p>

<p style="margin-left:18%;">Enable compression on
replication traffic. Prefix with a channel name to only
apply for that channel</p>

<p style="margin-left:11%;"><b>sync_host:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Name of the host (replica
running sync_server(8)) to which replication actions will be
sent by sync_client(8). Prefix with a channel name to only
apply for that channel</p>

<p style="margin-left:11%;"><b>sync_log:</b> 0</p>

<p style="margin-left:18%;">Enable replication action
logging by lmtpd(8), imapd(8), pop3d(8), and nntpd(8). The
log {configdirectory}/sync/log is used by sync_client(8) for
&quot;rolling&quot; replication.</p>

<p style="margin-left:11%;"><b>sync_log_chain:</b> 0</p>

<p style="margin-left:18%;">Enable replication action
logging by sync_server as well, allowing chaining of
replicas. Use this on &rsquo;B&rsquo; for A =&gt; B =&gt; C
replication layout</p>

<p style="margin-left:11%;"><b>sync_log_channels:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">If specified, log all events to
multiple log files in directories specified by each
&quot;channel&quot;. To run these log files, you need to
pass the -n option to sync_client -r with the channel name.
Use this for a mesh style replication layout - every machine
replicating to every other machine.</p>

<p style="margin-left:11%;"><b>sync_password:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The default password to use
when authenticating to a sync server. Prefix with a channel
name to only apply for that channel</p>

<p style="margin-left:11%;"><b>sync_port:</b> csync</p>

<p style="margin-left:18%;">Name of the service (or port
number) of the replication service on replica host. The
default is &quot;csync&quot; which is usally port 2005, but
any service name or numeric port can be specified. Prefix
with a channel name to only apply for that channel</p>

<p style="margin-left:11%;"><b>sync_realm:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The authentication realm to use
when authenticating to a sync server. Prefix with a channel
name to only apply for that channel</p>

<p style="margin-left:11%;"><b>sync_repeat_interval:</b>
1</p>

<p style="margin-left:18%;">Minimum interval (in seconds)
between replication runs in rolling replication mode. If a
replication run takes longer than this time, we repeat
immediately. Prefix with a channel name to only apply for
that channel</p>

<p style="margin-left:11%;"><b>sync_shutdown_file:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Simple latch used to tell
sync_client(8) that it should shut down at the next
opportunity. Safer than sending signals to running
processes. Prefix with a channel name to only apply for that
channel</p>

<p style="margin-left:11%;"><b>syslog_prefix:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">String to be prepended to the
process name in syslog entries.</p>

<p style="margin-left:11%;"><b>tcp_keepalive:</b> 0</p>

<p style="margin-left:18%;">Enable keepalive on TCP
connections</p>

<p style="margin-left:11%;"><b>tcp_keepalive_cnt:</b> 0</p>

<p style="margin-left:18%;">Number of TCP keepalive probes
to send before declaring the connection dead (0 == system
default)</p>

<p style="margin-left:11%;"><b>tcp_keepalive_idle:</b>
0</p>

<p style="margin-left:18%;">Number of seconds a connection
must be idle before keepalive probes are sent (0 == system
default)</p>

<p style="margin-left:11%;"><b>tcp_keepalive_intvl:</b>
0</p>

<p style="margin-left:18%;">Number of seconds between
keepalive probes (0 == system default)</p>

<p style="margin-left:11%;"><b>temp_path:</b> /tmp</p>

<p style="margin-left:18%;">The pathname to store temporary
files in</p>

<p style="margin-left:11%;"><b>timeout:</b> 30</p>

<p style="margin-left:18%;">The length of the IMAP
server&rsquo;s inactivity autologout timer, in minutes. The
minimum value is 30, the default.</p>

<p style="margin-left:11%;"><b>tls_ca_file:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing one or more
Certificate Authority (CA) certificates.</p>

<p style="margin-left:11%;"><b>tls_ca_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Path to directory with
certificates of CAs. This directory must have filenames with
the hashed value of the certificates (see openssl(XXX)).</p>

<p style="margin-left:11%;"><b>tlscache_db:</b>
skiplist</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the TLS cache.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>berkeley</i>, <i>berkeley-nosync</i>,
<i>berkeley-hash</i>, <i>berkeley-hash-nosync</i>,
<i>skiplist</i>, <i>sql</i></p>

<p style="margin-left:11%;"><b>tlscache_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
tlscache db file. If not specified, will be
confdir/tls_sessions.db</p>

<p style="margin-left:11%;"><b>tls_cert_file:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing the certificate
presented for server authentication during STARTTLS. A value
of &quot;disabled&quot; will disable SSL/TLS.</p>

<p style="margin-left:11%;"><b>tls_cipher_list:</b>
DEFAULT</p>

<p style="margin-left:18%;">The list of SSL/TLS ciphers to
allow. The format of the string is described in
ciphers(1).</p>

<p style="margin-left:11%;"><b>tls_compression:</b> 0</p>

<p style="margin-left:18%;">deactivate TLS compression by
default</p>

<p style="margin-left:11%;"><b>tls_eccurve:</b>
prime256v1</p>

<p style="margin-left:18%;">The elliptic curve used for
ECDHE. Default is NIST Suite B prime256. See &rsquo;openssl
ecparam -list_curves&rsquo; for possible values.</p>

<p style="margin-left:11%;"><b>tls_key_file:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">File containing the private key
belonging to the server certificate. A value of
&quot;disabled&quot; will disable SSL/TLS.</p>


<p style="margin-left:11%;"><b>tls_prefer_server_ciphers:</b>
0</p>

<p style="margin-left:18%;">Prefer the ciphers on the
server side instead of client side</p>

<p style="margin-left:11%;"><b>tls_require_cert:</b> 0</p>

<p style="margin-left:18%;">Require a client certificate
for ALL services (imap, pop3, lmtp, sieve).</p>

<p style="margin-left:11%;"><b>tls_session_timeout:</b>
1440</p>

<p style="margin-left:18%;">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.</p>

<p style="margin-left:11%;"><b>tls_versions:</b> tls1_0
tls1_1 tls1_2</p>

<p style="margin-left:18%;">A list of SSL/TLS versions to
not disable. Cyrus IMAP SSL/TLS starts with all protocols,
and substracts protocols not in this list. Newer versions of
SSL/TLS will need to be added here to allow them to get
disabled.</p>

<p style="margin-left:11%;"><b>umask:</b> 077</p>

<p style="margin-left:18%;">The umask value used by various
Cyrus IMAP programs.</p>

<p style="margin-left:11%;"><b>userdeny_db:</b> flat</p>

<p style="margin-left:18%;">The cyrusdb backend to use for
the user access list.</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>flat</i>, <i>berkeley</i>, <i>berkeley-hash</i>,
<i>skiplist</i>, <i>sql</i></p>

<p style="margin-left:11%;"><b>userdeny_db_path:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">The absolute path to the
userdeny db file. If not specified, will be
confdir/user_deny.db</p>

<p style="margin-left:11%;"><b>user_folder_limit:</b> 0</p>

<p style="margin-left:18%;">Limit the number of folders a
user can create in their INBOX. Set to 0 (default) for no
limit. Only affects folders in user.</p>

<p style="margin-left:11%;"><b>username_tolower:</b> 1</p>

<p style="margin-left:18%;">Convert usernames to all
lowercase before login/authentication. This is useful with
authentication backends which ignore case during username
lookups (such as LDAP).</p>

<p style="margin-left:11%;"><b>userprefix:</b> Other
Users</p>

<p style="margin-left:18%;">If using the alternate IMAP
namespace, the prefix for the other users namespace. The
hierarchy delimiter will be automatically appended.</p>

<p style="margin-left:11%;"><b>unix_group_enable:</b> 1</p>

<p style="margin-left:18%;">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)</p>

<p style="margin-left:11%;"><b>unixhierarchysep:</b> 0</p>

<p style="margin-left:18%;">Use the UNIX separator
character &rsquo;/&rsquo; for delimiting levels of mailbox
hierarchy. The default is to use the netnews separator
character &rsquo;.&rsquo;.</p>

<p style="margin-left:11%;"><b>virtdomains:</b> off</p>

<p style="margin-left:18%;">Enable virtual domain support.
If enabled, the user&rsquo;s domain will be determined by
splitting a fully qualified userid at the last
&rsquo;@&rsquo; or &rsquo;%&rsquo; symbol. If the userid is
unqualified, and the virtdomains option is set to
&quot;on&quot;, 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).</p>

<p style="margin-left:18%; margin-top: 1em">Allowed values:
<i>off</i>, <i>userid</i>, <i>on</i></p>

<p style="margin-left:11%;"><b>xlist-*:</b>
&lt;none&gt;</p>

<p style="margin-left:18%;">Cyrus 2.4 ONLY - enable special
use flags. The valid names can be taken from GMail&rsquo;s
XLIST documents or RFC 6154. Attribute name in the
configuration key should be defined in lowercase. The
attribute value is case sensitive, may contain whitespace
and must be valid UTF7-IMAP string. It must exactly match
the name of the subfolder of a user&rsquo;s INBOX.</p>

<p style="margin-left:18%; margin-top: 1em">Example:
xlist-drafts: My Drafts</p>

<p style="margin-left:18%; margin-top: 1em">Every user on
your server with a &rsquo;INBOX.My Drafts&rsquo; folder will
get the special use flag &quot; versions of Cyrus have a
much more flexible RFC 6154 compatible system.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>imapd(8)</b>,
<b>pop3d(8)</b>, <b>nntpd(8)</b>, <b>lmtpd(8)</b>,
<b>timsieved(8)</b>, <b>idled(8)</b>, <b>notifyd(8)</b>,
<b>deliver(8)</b>, <b>cyrus-master(8)</b>, <b>ciphers(1)</b></p>
<hr>
</body>
</html>