File: pop3front.html

package info (click to toggle)
mailfront 2.12-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,072 kB
  • sloc: sh: 5,549; ansic: 5,083; makefile: 35
file content (60 lines) | stat: -rw-r--r-- 2,392 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<html>
<body>

<h2><a href="mailfront.html">MailFront</a></h2>

<h1>POP3 Front End</h1>

<hr>

<p>The POP3 front end is composed of two pieces: an authentication
front end and a transfer back-end.</p>

<p>Connections are timed out after <tt>$TIMEOUT</tt> seconds of
inactivity (defaults to 1200 seconds or 20 minutes), or
<tt>$SESSION_TIMEOUT</tt> seconds after the connection was established
(defaults to 86400 seconds or 24 hours).</p>

<h2>pop3front-auth</h2>

<p>Usage: <tt>pop3front-auth CVM PROGRAM [ ARGS ... ]</tt></p>

<p><tt>pop3front-auth</tt> authenticates the username and password sent
by the client using the named CVM.  If successful, it sets up the
environment and executes <tt>PROGRAM</tt>.  It also offers <a
href="http://www.faqs.org/rfcs/rfc1734.html">RFC 1734</a> complient AUTH
support through <a href="cvm-sasl.html">cvm-sasl</a>.</p>

<p>If <tt>$AUTH_TIMEOUT</tt> or <tt>$AUTH_SESSION_TIMEOUT</tt> are set,
they override <tt>$TIMEOUT</tt> and <tt>$SESSION_TIMEOUT</tt>
respectively.</p>

<p>If <tt>$MAXUSERCMD</tt> is set, no more than the specified number of
the <tt>USER</tt> command may be issued.  If <tt>$MAXAUTHFAIL</tt> is
set, no more than the specified number of authentication failures may
occur.  After these limits are reached, the client is disconnected.</p>

<h2>pop3front-maildir</h2>

<p>Usage: <tt>pop3front-maildir [ DEFAULT-MAILDIR ]</tt></p>

<p><tt>pop3front-maildir</tt> serves messages via POP3 out of a
maildir.  If <tt>$MAILBOX</tt> is set, its contents are used as the
path to the mailbox, otherwise the <tt>DEFAULT-MAILDIR</tt> argument
must be present.  If <tt>$MAX_MESSAGES</tt> is set, the total number
of accessable messages will be limited to that number.  In addition,
if either of <tt>$MAX_CUR_MESSAGES</tt> or <tt>$MAX_NEW_MESSAGES</tt>
are set, the total number of accessable messages in the <tt>cur</tt>
and <tt>new</tt> subdirectories respectively will each be limited to
that number.</p>

<p>If the filenames in the maildir contain a size indicator, as
specified <a href="http://www.courier-mta.org/imap/README.maildirquota.html">here
for Courier IMAP</a>
and <a href="http://wiki.dovecot.org/MailboxFormat/Maildir">here for
Dovecot</a>, this program will avoid using stat to calculate the file
size.  This is a significant performance optimization on systems with
either very large or very many mailboxes.</p>

</body>
</html>