.\" 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::ScoreAction 3pm"
.TH Mail::MtPolicyd::Plugin::ScoreAction 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::ScoreAction \- mtpolicyd plugin for running an action based on the score
.SH "VERSION"
.IX Header "VERSION"
version 2.05
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Returns a action based on the score.
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "threshold (required)" 4
.IX Item "threshold (required)"
If the score is higher than this value the action will be executed.
.IP "match (default: gt)" 4
.IX Item "match (default: gt)"
If it should match if the score if >= or <= the threshold.
.Sp
Possible values: gt, lt
.IP "uc_threshold (default: undef)" 4
.IX Item "uc_threshold (default: undef)"
If set the value for threshold will be fetched from this
user-config value if defined.
.IP "score_field (default: score)" 4
.IX Item "score_field (default: score)"
Specifies the name of the field the score is stored in.
Could be set if you need multiple scores.
.IP "action (default: empty)" 4
.IX Item "action (default: empty)"
The action to be executed.
.Sp
The following patterns in the string will be replaced:
.Sp
.Vb 1
\&  %IP%, %SCORE%, %SCORE_DETAIL%
.Ve
.IP "Plugin (default: empty)" 4
.IX Item "Plugin (default: empty)"
Execute this plugins when the condition matched.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Reject everything with a score >= 15. and do greylisting for the remaining request with a score >=5.
.PP
.Vb 10
\&  <Plugin ScoreReject>
\&    module = "ScoreAction"
\&    threshold = 15
\&    action = "reject sender ip %IP% is blocked (score=%SCORE%%SCORE_DETAIL%)"
\&  </Plugin>
\&  <Plugin ScoreGreylist>
\&    module = "ScoreAction"
\&    threshold = 5
\&    <Plugin greylist>
\&      module = "Greylist"
\&      score = \-5
\&      mode = "passive"
\&    </Plugin>
\&  </Plugin>
.Ve
.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