imapd.8.html   [plain text]


<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<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>
<!-- Creator     : groff version 1.18 -->
<!-- CreationDate: Mon Feb 14 13:02:17 2005 -->
<a name="NAME"></a>
<h2>NAME</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p>imapd &minus; IMAP server process</p>
</td>
</table></p>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>imapd</b> [ <b>&minus;C</b> <i>config-file</i> ] [
<b>&minus;U</b> <i>uses</i> ] [ <b>&minus;T</b>
<i>timeout</i> ] [ <b>&minus;D</b> ]<br>
[ <b>&minus;s</b> ] [ <b>&minus;p</b> <i>ssf</i> ]</p>
</td>
</table></p>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><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>
<!-- INDENTATION -->
<p><i>Imapd</i> reads its configuration options out of the
<i>imapd.conf</i>(5) file unless specified otherwise by
<b>-C</b>.</p>
<!-- INDENTATION -->
<p>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>
<!-- INDENTATION -->
<p>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>
<!-- INDENTATION -->
<p>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>
</td>
</table></p>
<a name="OPTIONS"></a>
<h2>OPTIONS</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>&minus;C</b> <i>config-file</i></p></td>
</table></p>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>Read configuration options from <i>config-file</i>.</p>
</td>
</table>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>&minus;U</b> <i>uses</i></p></td>
</table></p>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>The maximum number of times that the process should be
used for new connections before shutting down. The default
is 250.</p>
</td>
</table>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>&minus;T</b> <i>timeout</i></p></td>
</table></p>
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td>
<td width="77%">
<p>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>
</td>
</table>
<!-- TABS -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="3" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="10%">

<p><b>&minus;D</b></p>
</td>
<td width="77%">

<p>Run external debugger specified in debug_command.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="10%">

<p><b>&minus;s</b></p>
</td>
<td width="77%">

<p>Serve IMAP over SSL (imaps). All data to and from
<i>imapd</i> is encrypted using the Secure Sockets
Layer.</p>
</td>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="10%">

<p><b>&minus;p</b> <i>ssf</i></p>
</td>
<td width="77%">

<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>
</table></p>
<a name="FILES"></a>
<h2>FILES</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>/etc/imapd.conf</b></p></td>
</table></p>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<!-- INDENTATION -->
<p><table width="100%" border=0 rules="none" frame="void"
       cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td>
<td width="89%">
<p><b>imapd.conf(5)</b>, <b>master(8)</b></p>
</td>
</table></p>
<hr>
</body>
</html>