.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Mail::MtPolicyd::Plugin::Accounting 3pm"
.TH Mail::MtPolicyd::Plugin::Accounting 3pm "2017-01-13" "perl v5.24.1" "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::Accounting \- mtpolicyd plugin for accounting in sql tables
.SH "VERSION"
.IX Header "VERSION"
version 2.02
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&  <Plugin acct\-clients>
\&    module = "Accounting"
\&    # per ip and user
\&    fields = "client_address,sasl_username"
\&    # statistics per month
\&    time_pattern = "%Y\-%m"
\&    table_prefix = "acct_"
\&  </Plugin>
.Ve
.PP
This will create a table acct_client_address and a table acct_sasl_username.
.PP
If a request is received containing the field the plugin will update the row
in the fields table. The key is the fields value(ip or username) and the time
string build from the time_pattern.
.PP
For each key the following counters are stored:
.PP
.Vb 4
\&  * count
\&  * count_rcpt (count per recipient)
\&  * size
\&  * size_rcpt  (size * recipients)
.Ve
.PP
The resulting tables will look like:
.PP
.Vb 8
\&  mysql> select * from acct_client_address;
\&  +\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+
\&  | id | key          | time    | count | count_rcpt | size   | size_rcpt |
\&  +\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+
\&  |  1 | 192.168.0.1  | 2014\-12 |    11 |         11 | 147081 |    147081 |
\&  |  2 | 192.168.1.1  | 2014\-12 |     1 |          1 |  13371 |     13371 |
\&  | 12 | 192.168.2.1  | 2014\-12 |    10 |        100 | 133710 |   1337100 |
\&  ...
.Ve
.SS "\s-1PARAMETERS\s0"
.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 "fields (required)" 4
.IX Item "fields (required)"
A comma separated list of fields used for accounting.
.Sp
For each field a table will be created.
.Sp
For a list of available fields see postfix documentation:
.Sp
http://www.postfix.org/SMTPD_POLICY_README.html
.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.
.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 "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin can be used to do accounting based on request fields.
.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