Debian Codegraph @

upstream/debian-unstable/man8/deliverquota.maildrop.8

raw
1 '\" t
2 .\"<!-- Copyright 1998 - 2009 Double Precision, Inc. See COPYING for -->
3 .\"<!-- distribution information. -->
4 .\" Title: deliverquota
5 .\" Author: Sam Varshavchik
6 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
7 .\" Date: 11/12/2022
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Courier Mail Server
10 .\" Language: English
11 .\"
12 .TH "DELIVERQUOTA" "8" "11/12/2022" "Courier Mail Server" "Double Precision, Inc\&."
13 .\" -----------------------------------------------------------------
14 .\" * Define some portability stuff
15 .\" -----------------------------------------------------------------
16 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .\" http://bugs.debian.org/507673
18 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
19 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .ie \n(.g .ds Aq \(aq
21 .el .ds Aq '
22 .\" -----------------------------------------------------------------
23 .\" * set default formatting
24 .\" -----------------------------------------------------------------
25 .\" disable hyphenation
26 .nh
27 .\" disable justification (adjust text to left margin only)
28 .ad l
29 .\" -----------------------------------------------------------------
30 .\" * MAIN CONTENT STARTS HERE *
31 .\" -----------------------------------------------------------------
32 .SH "NAME"
33 deliverquota \- deliver to a maildir with a quota
34 .SH "SYNOPSIS"
35 .HP \w'\fBdeliverquota\fR\ 'u
36 \fBdeliverquota\fR [\-c] [\-w\ \fIpercent\fR] [\-W\ \fIfilename\fR] {\fImaildir\fR} {\fIquota\fR}
37 .SH "DESCRIPTION"
38 .PP
39 \fBdeliverquota\fR
40 delivers mail to a
41 \fImaildir\fR
42 taking into account any software\-imposed quota on the maildir\&. This manually\-enforced quota mechanism is described in the
43 \m[blue]\fB\fBmaildirquota\fR(7)\fR\m[]\&\s-2\u[1]\d\s+2
44 and
45 \m[blue]\fB\fBmaildirmake\fR(1)\fR\m[]\&\s-2\u[2]\d\s+2
46 manual pages\&. Instead of setting up your mail server to deliver the message directly to a maildir, configure the mail server to run the
47 \fBdeliverquota\fR
48 program in order to deliver the message, and specify the location of the maildir as the argument to
49 \fBdeliverquota\fR\&.
50 .PP
51 The second argument to
52 \fBdeliverquota\fR
53 is optional\&. If present,
54 \fIquota\fR
55 specifies a new quota setting for this maildir\&. Specifying
56 \fIquota\fR
57 is equivalent to running
58 \m[blue]\fB\fBmaildirmake\fR(1)\fR\m[]\&\s-2\u[2]\d\s+2
59 with the
60 \fB\-q\fR
61 option\&. The second argument to
62 \fBdeliverquota\fR
63 is considered obsolete, and may be removed in the future\&.
64 .PP
65 \fBdeliverquota\fR
66 reads the message from standard input and delivers it to
67 \fImaildir\fR\&.
68 \fImaildir\fR
69 may specify a path directly to a maildir folder, not the main
70 \fImaildir\fR
71 (as long as the folder was created by the
72 \m[blue]\fB\fBmaildirmake\fR(1)\fR\m[]\&\s-2\u[2]\d\s+2
73 command\&.
74 .PP
75 The
76 \fB\-c\fR
77 option automatically creates the maildir, and all missing parent subdirectories (as \*(Aq\fBmkdir \-p\fR\*(Aq)\&. This option should be used with caution\&.
78 .PP
79 The
80 \fB\-w N\fR
81 option places a warning message into the maildir if the maildir has a quota setting, and after the message was successfully delivered the maildir was at least
82 \fIN\fR
83 percent full\&. The warning message is copied from the file specified by the
84 \fB\-W\fR
85 option, or from
86 /etc/quotawarnmsg
87 if
88 \fB\-W\fR
89 was not specified\&. The "Date:" and "Message\-Id:" headers are added to the message\&. The warning is repeated every 24 hours (at least), until the maildir drops below
90 \fIN\fR
91 percent full\&.
92 .SH "RETURN CODE"
93 .PP
94 \fBdeliverquota\fR
95 delivers the message to the maildir and terminates with exit code 0 if the message can be delivered without going over quota\&.
96 .PP
97 If the maildir is over its specified quota: the maildrop version of
98 \fBdeliverquota\fR
99 terminates with an exit code 77 (EX_NOPERM); the Courier version of
100 \fBdeliverquota\fR
101 terminates with an exit code 75 (EX_TEMPFAIL)\&.
102 .SH "SEE ALSO"
103 .PP
104 \m[blue]\fB\fBmaildirquota\fR(7)\fR\m[]\&\s-2\u[1]\d\s+2,
105 \m[blue]\fB\fBmaildirmake\fR(1)\fR\m[]\&\s-2\u[2]\d\s+2\&.
106 .SH "AUTHOR"
107 .PP
108 \fBSam Varshavchik\fR
109 .RS 4
110 Author
111 .RE
112 .SH "NOTES"
113 .IP " 1." 4
114 \fBmaildirquota\fR(7)
115 .RS 4
116 \%http://www.courier-mta.org/maildirquota.html
117 .RE
118 .IP " 2." 4
119 \fBmaildirmake\fR(1)
120 .RS 4
121 \%http://www.courier-mta.org/maildirmake.html
122 .RE