.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::SpamAssassin::AutoWelcomelist 3"
.TH Mail::SpamAssassin::AutoWelcomelist 3 2024-09-01 "perl v5.40.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::SpamAssassin::AutoWelcomelist \- auto\-welcomelist handler for SpamAssassin
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  (see Mail::SpamAssassin)
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mail::SpamAssassin is a module to identify spam using text analysis and
several internet-based realtime blocklists.
.PP
This class is used internally by SpamAssassin to manage the automatic
welcomelisting functionality.  Please refer to the \f(CW\*(C`Mail::SpamAssassin\*(C'\fR
documentation for public interfaces.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$meanscore = awl\->check_address($addr, $originating_ip, $signedby);" 4
.el .IP "\f(CW$meanscore\fR = awl\->check_address($addr, \f(CW$originating_ip\fR, \f(CW$signedby\fR);" 4
.IX Item "$meanscore = awl->check_address($addr, $originating_ip, $signedby);"
This method will return the mean score of all messages associated with the
given address, or undef if the address hasn't been seen before.
.Sp
If \fR\f(CB$originating_ip\fR\fB\fR is supplied, it will be used in the lookup.
.IP awl\->\fBcount()\fR; 4
.IX Item "awl->count();"
This method will return the count of messages used in determining the
welcomelist correction.
.IP awl\->add_score($score); 4
.IX Item "awl->add_score($score);"
This method will add half the score to the current entry.  Half the
score is used, so that repeated use of the same From and IP address
combination will gradually reduce the score.
.IP awl\->add_known_good_address($addr); 4
.IX Item "awl->add_known_good_address($addr);"
This method will add a score of \-100 to the given address \-\- effectively
"bootstrapping" the address as being one that should be welcomelisted.
.IP awl\->add_known_bad_address($addr); 4
.IX Item "awl->add_known_bad_address($addr);"
This method will add a score of 100 to the given address \-\- effectively
"bootstrapping" the address as being one that should be blocklisted.