.\"  <!-- $Id: deliverquota.sgml,v 1.1 2001/12/08 06:09:06 mrsam Exp $ -->
.\"  <!-- Copyright 1998 - 2001 Double Precision, Inc.  See COPYING for -->
.\"  <!-- distribution information. -->
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "DELIVERQUOTA" "8" "17 January 2002" "Double Precision, Inc." ""
.SH NAME
deliverquota \- deliver to a maildir with a quota
.SH SYNOPSIS

\fBdeliverquota\fR [ \fB-c\fR]  [ \fB-w \fIpercent\fB\fR]  \fB\fImaildir\fB\fR \fB\fIquota\fB\fR

.SH "DESCRIPTION"
.PP
\fBdeliverquota\fR delivers mail to a
maildir with a software-imposed quota.
The manually-enforced quota mechanism described in
\fBmaildirquota\fR(7).
Instead of setting up your mail
server to deliver the message to a maildir, set up the mail server to
deliver the message to the \fBdeliverquota\fR program,
and specify the
location of the maildir, and its corresponding quota, as the arguments.
.PP
\fBdeliverquota\fR reads the message from standard input
and delivers it
to \fImaildir\fR.
\fImaildir\fR
may specify a path directly to a maildir folder,
not the main \fImaildir\fR
(as long as the folder was created by the
\fBmaildirmake\fR(1) command.
.PP
\fIquota\fR
is a list of comma separated quota specifications. A quota specification
consists of a number followed by either 'S', indicating the maximum message
size in bytes, or 'C', maximum number of messages. For example:
.PP
.sp
.RS
.PP

.nf
\fBdeliverquota ./Maildir 5000000S,1000C\fR
.fi
.RE
This delivers to ./Maildir with the quota set to
5,000,000 bytes or 1000 messages, whichever comes first.
.PP
.sp
.RS
.PP

.nf
\fBdeliverquota ./Maildir 1000000S\fR
.fi
.RE
This delivers to ./Maildir with the quota set
to 1,000,000 bytes, without limiting number of messages.
.PP
The \fB-c\fR option automatically creates the maildir,
and all missing parent subdirectories (as '\fBmkdir -p\fR').
This option should be used with caution.
.PP
The \fB-w N\fR option places a warning message
into the maildir if
the message was successfully delivered, but the maildir is now at least
\fIN\fR percent full.
The warning message is copied verbatim from
\fI/usr/local/share/sqwebmail/quotawarnmsg\fR with the addition of
"Date:" and
"Message-Id:" headers.
The warning is repeated every 24 hours (at least), until the maildir drops
below
\fIN\fR percent full.
.SH "RETURN CODE"
.PP
\fBdeliverquota\fR delivers the message to the maildir
and terminates with
exit code 0 if the message can be delivered without going over quota.
.PP
If the maildir is over its specified quota, \fBdeliverquota\fR
terminates with exit code 77 (EX_NOPERM).
.SH "SEE ALSO"
.PP
\fBmaildirquota\fR(7),
\fBmaildirmake\fR(1),
http://www.qmail.org/man/man5/maildir.html.