.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::MtPolicyd::Plugin::Quota 3pm"
.TH Mail::MtPolicyd::Plugin::Quota 3pm "2022-10-15" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::MtPolicyd::Plugin::Quota \- mtpolicyd plugin for accounting in sql tables
.SH "VERSION"
.IX Header "VERSION"
version 2.05
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin can be used to do accounting based on request fields.
.SH "Example"
.IX Header "Example"
.Vb 3
\&  <Plugin quota\-clients>
\&    module = "Quota"
\&    table_prefix = "acct_"
\&
\&    # per month
\&    time_pattern = "%Y\-%m"
\&    # per ip
\&    field = "client_address"
\&    # allow 1000 mails
\&    metric = "count"
\&    threshold = 1000
\&    action = "defer you exceeded your monthly limit, please insert coin"
\&  </Plugin>
.Ve
.SH "Configuration"
.IX Header "Configuration"
.SS "Parameters"
.IX Subsection "Parameters"
The module takes the following parameters:
.IP "(uc_)enabled (default: on)" 4
.IX Item "(uc_)enabled (default: on)"
Enable/disable this check.
.IP "(uc_)field (required)" 4
.IX Item "(uc_)field (required)"
The field used for accounting/quota.
.IP "(uc_)metric (required)" 4
.IX Item "(uc_)metric (required)"
The metric on which the quota should be based.
.Sp
The Accounting module stores the following metrics:
.RS 4
.IP "count" 4
.IX Item "count"
Number of mails recivied.
.IP "count_rcpt" 4
.IX Item "count_rcpt"
Number of mails recivied multiplied with number of recipients.
.IP "size" 4
.IX Item "size"
Size of mails recivied.
.IP "size_rcpt" 4
.IX Item "size_rcpt"
Size of mails recivied multiplied with number of recipients.
.RE
.RS 4
.RE
.ie n .IP "time_pattern (default: ""%Y\-%m"")" 4
.el .IP "time_pattern (default: ``%Y\-%m'')" 4
.IX Item "time_pattern (default: %Y-%m)"
A format string for building the time key used to store counters.
.Sp
Default is to build counters on a monthly base.
.Sp
For example use:
.Sp
.Vb 2
\&  * "%Y\-%W" for weekly
\&  * "%Y\-%m\-%d" for daily
.Ve
.Sp
See \*(L"man date\*(R" for format string sequences.
.Sp
You must use the same time_pattern as used in for the Accounting module.
.IP "threshold (required)" 4
.IX Item "threshold (required)"
The quota limit.
.IP "action (default: defer smtp traffic quota has been exceeded)" 4
.IX Item "action (default: defer smtp traffic quota has been exceeded)"
The action to return when the quota limit has been reached.
.ie n .IP "table_prefix (default: ""acct_"")" 4
.el .IP "table_prefix (default: ``acct_'')" 4
.IX Item "table_prefix (default: acct_)"
A prefix to add to every table.
.Sp
The table name will be the prefix + field_name.
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus Benning <ich@markusbenning.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 2, June 1991
.Ve