.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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::RegexList 3pm"
.TH Mail::MtPolicyd::Plugin::RegexList 3pm "2018-06-20" "perl v5.26.2" "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::RegexList \- mtpolicyd plugin for regex matching
.SH "VERSION"
.IX Header "VERSION"
version 2.03
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&  <Plugin regex\-whitelist>
\&    module = "RegexList"
\&    key = "request:client_name"
\&    regex = "^mail\-[a\-z][a\-z]0\-f[0\-9]*\e.google\e.com$"
\&    regex = "\e.bofh\-noc\e.de$"
\&    # file = "/etc/mtpolicyd/regex\-whitelist.txt"
\&    action = "accept"
\&  </Plugin>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin matches a value against a list of regular expressions
and executes an action if it matched.
.SS "\s-1PARAMETERS\s0"
.IX Subsection "PARAMETERS"
The module takes the following parameters:
.ie n .IP "(uc_)enabled (default: ""on"")" 4
.el .IP "(uc_)enabled (default: ``on'')" 4
.IX Item "(uc_)enabled (default: on)"
Could be set to 'off' to deactivate check. Could be used to activate/deactivate check per user.
.ie n .IP "key (default: ""request:client_address"")" 4
.el .IP "key (default: ``request:client_address'')" 4
.IX Item "key (default: request:client_address)"
Field to query.
.IP "invert (default: 0)" 4
.IX Item "invert (default: 0)"
If set to 1 the logic will be inverted.
.IP "regex (default: empty)" 4
.IX Item "regex (default: empty)"
One or more regular expressions
.IP "file (default: empty)" 4
.IX Item "file (default: empty)"
A file to load regular expressions from.
.Sp
One regex per line. Empty lines and lines starting with # will be ignored.
.PP
By default the plugin will do nothing. One of the following actions should be specified:
.IP "action (default: empty)" 4
.IX Item "action (default: empty)"
If given this action will be returned to the \s-1MTA\s0 if the \s-1SQL\s0 query matched.
.IP "score (default: empty)" 4
.IX Item "score (default: empty)"
If given this score will be applied to the session.
.IP "Plugin (default: empty)" 4
.IX Item "Plugin (default: empty)"
Execute this plugins when the condition matched.
.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