| 1 |
'\" t |
| 2 |
.\"<!-- Copyright 1998 - 2008 Double Precision, Inc. See COPYING for --> |
| 3 |
.\"<!-- distribution information. --> |
| 4 |
.\" Title: maildirquota |
| 5 |
.\" Author: Sam Varshavchik |
| 6 |
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> |
| 7 |
.\" Date: 11/04/2020 |
| 8 |
.\" Manual: Double Precision, Inc. |
| 9 |
.\" Source: Courier Mail Server |
| 10 |
.\" Language: English |
| 11 |
.\" |
| 12 |
.TH "MAILDIRQUOTA" "7" "11/04/2020" "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 |
maildirquota \- voluntary Maildir quotas |
| 34 |
.SH "SYNOPSIS" |
| 35 |
.HP \w'\fBmaildirmake\fR\ 'u |
| 36 |
\fBmaildirmake\fR {\-q} {10000000S} {\&./Maildir} |
| 37 |
.SH "DESCRIPTION" |
| 38 |
.PP |
| 39 |
\fBmaildrop\fR |
| 40 |
has a manual quota enforcement implementation that does use the quota facilities of the host operating system (filesystem\-based quotas)\&. This is an option that is set at configuration time, and may be disabled\&. |
| 41 |
.PP |
| 42 |
Using filesystem quotas sometimes leads to problems\&. After a hard quota is hit, most commands issued by mail clients fail, including some commands that poorly\-written mail software may not expect to fail, and therefore be unable to gracefully handle the unexpected failure\&. |
| 43 |
.PP |
| 44 |
With manual quotas, the only operations that fail are the ones that most mail clients expect to fail, when the mailbox is full\&. However, filesystem\-based quotas cannot be used in some situations, such as virtual mailboxes\&. If this experimental feature is enabled, approximate quota enforcement can be implemented by |
| 45 |
\fBmaildrop\fR |
| 46 |
or |
| 47 |
\fBdeliverquota\fR |
| 48 |
to whatever extent it\*(Aqs possible to do so\&. Quotas are enabled by the |
| 49 |
\fB\-q\fR |
| 50 |
option to |
| 51 |
\fBmaildirmake\fR\&. Both |
| 52 |
\fBmaildrop\fR |
| 53 |
and |
| 54 |
\fBdeliverquota\fR |
| 55 |
will observe any |
| 56 |
\fBmaildirmake\fR\-requested quota\&. |
| 57 |
.SS "LIMITATIONS" |
| 58 |
.PP |
| 59 |
This quota mechanism will only work as long as |
| 60 |
\fBmaildrop\fR |
| 61 |
(or |
| 62 |
\fBdeliverquota\fR) are the only applications that deliver messages to the maildir, or as long as other applications implement the same quota enforcement mechanism\&. The quota enforcement mechanism is described separately in the |
| 63 |
README\&.maildirquota\&.html |
| 64 |
file in the source code distribution\&. |
| 65 |
.PP |
| 66 |
Quota enforcement will still work, to some extent, if there are other applications that deliver or modify messages in the maildir\&. However, quota enforcement may not kick in immediately when the maildir goes over quota, in fact the maildir can go over quota by a noticeable amount\&. But eventually, as long as |
| 67 |
\fBmaildrop\fR |
| 68 |
or |
| 69 |
\fBdeliverquota\fR |
| 70 |
are responsible for delivering the majority of messages, quota enforcement will kick in\&. Also, other sources of messages may also result in noticeable performance degradation, because quote recalculation will become noticeably more expensive\&. |
| 71 |
.PP |
| 72 |
Also keep in mind that this quota mechanism is generally useless if mail recipients have direct access to their maildirs\&. |
| 73 |
.PP |
| 74 |
Finally even under the best conditions this quota enforcement does have a small chance of a race condition where a maildir will go over quota by some amount\&. maildirs are designed for speed, and this quota implementation was designed to have as little additional overhead as possible, compared to regular maildirs\&. To enforce an exact quota you would have to use some kind of a locking facility, which will impose a drastic performance degradation on the overall maildir performance\&. A decision has been made to avoid locking, with the only negative side effect being a possibility of going over quota in very low probability situations\&. |
| 75 |
.PP |
| 76 |
A way to minimize the risk of going over quota is to set reasonable quotas, in relation to maximum message sizes supported by your mail server\&. If you set your maildir quota to five gigabytes, for example, it makes very little sense to configure your mail server to accept messages up to three gigabytes in size\&. Your maildir quota should be chosen so that it makes sense when compared to the maximum message size allowed by your mail server\&. |
| 77 |
.SS "FOLDERS" |
| 78 |
.PP |
| 79 |
This quota implementation is compatible with a popular extension to maildir which defines individual mail folders within a single maildir\&. However, in order to create a compatible folder, you MUST use the |
| 80 |
\fBmaildirmake\fR |
| 81 |
command that comes with |
| 82 |
\fBmaildrop\fR, and you MUST use the |
| 83 |
\fB\-f\fR |
| 84 |
option to |
| 85 |
\fBmaildirmake\fR, giving the name of the folder\&. Do not use |
| 86 |
\fBmaildirmake\fR |
| 87 |
and specify the directory name of the maildir folder\&. Quota enforcement will not work if you do that\&. |
| 88 |
.SH "SEE ALSO" |
| 89 |
.PP |
| 90 |
\m[blue]\fB\fBmaildrop\fR(1)\fR\m[]\&\s-2\u[1]\d\s+2, |
| 91 |
\m[blue]\fB\fBmaildirmake\fR(1)\fR\m[]\&\s-2\u[2]\d\s+2, |
| 92 |
\m[blue]\fB\fBmaildropfilter\fR(5)\fR\m[]\&\s-2\u[3]\d\s+2, |
| 93 |
\m[blue]\fB\fBdeliverquota\fR(8)\fR\m[]\&\s-2\u[4]\d\s+2\&. |
| 94 |
.SH "AUTHOR" |
| 95 |
.PP |
| 96 |
\fBSam Varshavchik\fR |
| 97 |
.RS 4 |
| 98 |
Author |
| 99 |
.RE |
| 100 |
.SH "NOTES" |
| 101 |
.IP " 1." 4 |
| 102 |
\fBmaildrop\fR(1) |
| 103 |
.RS 4 |
| 104 |
\%http://www.courier-mta.org/maildrop.html |
| 105 |
.RE |
| 106 |
.IP " 2." 4 |
| 107 |
\fBmaildirmake\fR(1) |
| 108 |
.RS 4 |
| 109 |
\%http://www.courier-mta.org/maildirmake.html |
| 110 |
.RE |
| 111 |
.IP " 3." 4 |
| 112 |
\fBmaildropfilter\fR(5) |
| 113 |
.RS 4 |
| 114 |
\%http://www.courier-mta.org/maildropfilter.html |
| 115 |
.RE |
| 116 |
.IP " 4." 4 |
| 117 |
\fBdeliverquota\fR(8) |
| 118 |
.RS 4 |
| 119 |
\%http://www.courier-mta.org/deliverquota.html |
| 120 |
.RE |