<!-- Creator : groff version 1.20.1 -->
<!-- CreationDate: Thu Mar 24 21:49:37 2011 -->
<!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</title>
</head>
<body>
<h1 align="center">IMAPD</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPTIONS">OPTIONS</a><br>
<a href="#FILES">FILES</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 −
IMAP server process</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>imapd</b> [
<b>−C</b> <i>config-file</i> ] [ <b>−U</b>
<i>uses</i> ] [ <b>−T</b> <i>timeout</i> ] [
<b>−D</b> ] <br>
[ <b>−s</b> ] [ <b>−N</b> ] [ <b>−t</b> ]
[ <b>−p</b> <i>ssf</i> ]</p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>Imapd</i> is
an IMAP4rev1 server. It accepts commands on its standard
input and responds on its standard output. It MUST be
invoked by <i>master</i>(8) with those descriptors attached
to a remote client connection.</p>
<p style="margin-left:11%; margin-top: 1em"><i>Imapd</i>
reads its configuration options out of the
<i>imapd.conf</i>(5) file unless specified otherwise by
<b>-C</b>.</p>
<p style="margin-left:11%; margin-top: 1em">If the file
msg/shutdown is created under the directory specified in the
<i>configdirectory</i> configuration option, then
<i>imapd</i> will shut down the connection, sending the
first line contained in the file to the client as the
reason. New connections are denied.</p>
<p style="margin-left:11%; margin-top: 1em">If the file
msg/motd is created under the directory specified in the
<i>configdirectory</i> configuration option, then
<i>imapd</i> will send the first line contained in the file
to clients upon connect as an ALERT message which
IMAP-compliant clients are required to display. This option
serves to annoy users mostly. Unfortunately clients tend to
connect far more frequently than is apparent, causing each
connection to generate a seperate server ALERT for each
connection. Many clients do not display these properly, if
they do anything with them at all.</p>
<p style="margin-left:11%; margin-top: 1em">If the
directory log/<i>user</i> exists under the directory
specified in the <i>configdirectory</i> configuration
option, then <i>imapd</i> will create protocol telemetry
logs for sessions authenticating as <i>user</i>. The
telemetry logs will be stored in the log/<i>user</i>
directory with a filename of the <i>imapd</i>
process-id.</p>
<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>−C</b>
<i>config-file</i></p>
<p style="margin-left:22%;">Read configuration options from
<i>config-file</i>.</p>
<p style="margin-left:11%;"><b>−U</b> <i>uses</i></p>
<p style="margin-left:22%;">The maximum number of times
that the process should be used for new connections before
shutting down. The default is 250.</p>
<p style="margin-left:11%;"><b>−T</b>
<i>timeout</i></p>
<p style="margin-left:22%;">The number of seconds that the
process will wait for a new connection before shutting down.
Note that a value of 0 (zero) will disable the timeout. The
default is 60.</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="9%">
<p><b>−D</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Run external debugger specified in debug_command.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>−s</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Serve IMAP over SSL (imaps). All data to and from
<i>imapd</i> is encrypted using the Secure Sockets
Layer.</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>−N</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Bypass password checking. (Not recommended unless you
know what you’re doing.)</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>−t</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Do not allow the use of cleartext passwords on the wire.
Equivalent to setting <i>allowplaintext: no</i> in the
configuration file.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>−p</b> <i>ssf</i></p></td>
<td width="2%"></td>
<td width="78%">
<p>Tell <i>imapd</i> that an external layer exists. An SSF
(security strength factor) of 1 means an integrity
protection layer exists. Any higher SSF implies some form of
privacy protection.</p></td></tr>
</table>
<h2>FILES
<a name="FILES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>/etc/imapd.conf</b></p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>imapd.conf(5)</b>,
<b>cyrus-master(8)</b></p>
<hr>
</body>
</html>
