.\" 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::AddScoreHeader 3pm"
.TH Mail::MtPolicyd::Plugin::AddScoreHeader 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::AddScoreHeader \- mtpolicyd plugin for adding the score as header to the mail
.SH "VERSION"
.IX Header "VERSION"
version 2.05
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Adds an header with the current score and score details to the mail.
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "(uc_)spam_score (default: 5)" 4
.IX Item "(uc_)spam_score (default: 5)"
If the score is higher than this value it'll be tagged as '\s-1YES\s0'.
Otherwise '\s-1NO\s0'.
.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 "header_name (default: X\-MtScore)" 4
.IX Item "header_name (default: X-MtScore)"
The name of the header to set.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 6
\&  <Plugin add\-score\-header>
\&    module = "AddScoreHeader"
\&    # score_field = "score"
\&    # header_name = "X\-MtScore"
\&    spam_score = 5
\&  </Plugin>
.Ve
.PP
Will return an action like:
.PP
.Vb 1
\&  X\-MtScore: YES score=7.5 [CTIPREP_TEMP=2.5, spamhaus\-rbl=5]
.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