.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::WLBLEval 3"
.TH Mail::SpamAssassin::Plugin::WLBLEval 3 2025-12-13 "perl v5.42.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::Plugin::WLBLEval \- SpamAssassin plugin for blocklist and welcomelist evaluation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin Mail::SpamAssassin::Plugin::WLBLEval
\&
\&  # In your rules:
\&  header   FROM_IN_BLOCKLIST   eval:check_from_in_blocklist()
\&  header   TO_IN_WELCOMELIST   eval:check_to_in_welcomelist()
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin provides functions for blocklists and welcomelists for sender and recipient addresses, as well as URI host lists.
It supports matching by address, domain, and relay information.
.SH METHODS
.IX Header "METHODS"
.IP \fBcheck_from_in_blocklist()\fR 4
.IX Item "check_from_in_blocklist()"
Checks if the sender address is in the blocklist.
.IP \fBcheck_to_in_blocklist()\fR 4
.IX Item "check_to_in_blocklist()"
Checks if the recipient address is in the blocklist.
.IP \fBcheck_to_in_welcomelist()\fR 4
.IX Item "check_to_in_welcomelist()"
Checks if the recipient address is in the welcomelist.
.IP \fBcheck_to_in_more_spam()\fR 4
.IX Item "check_to_in_more_spam()"
Checks if the recipient address is in the more_spam_to list.
.IP \fBcheck_to_in_all_spam()\fR 4
.IX Item "check_to_in_all_spam()"
Checks if the recipient address is in the all_spam_to list.
.IP check_from_in_list($list) 4
.IX Item "check_from_in_list($list)"
Checks if the sender address is in the specified list.
.IP check_replyto_in_list($list) 4
.IX Item "check_replyto_in_list($list)"
Checks if the Reply\-To address is in the specified list.
.IP check_wb_list($params) 4
.IX Item "check_wb_list($params)"
Checks if an address is in a welcomelist or blocklist, based on parameters.
.IP check_to_in_list($list) 4
.IX Item "check_to_in_list($list)"
Checks if the recipient address is in the specified list.
.IP \fBcheck_from_in_welcomelist()\fR 4
.IX Item "check_from_in_welcomelist()"
Checks if the sender address is in the welcomelist.
.IP \fBcheck_forged_in_welcomelist()\fR 4
.IX Item "check_forged_in_welcomelist()"
Checks if the sender address is forged with respect to the welcomelist.
.IP \fBcheck_from_in_default_welcomelist()\fR 4
.IX Item "check_from_in_default_welcomelist()"
Checks if the sender address is in the default welcomelist.
.IP \fBcheck_forged_in_default_welcomelist()\fR 4
.IX Item "check_forged_in_default_welcomelist()"
Checks if the sender address is forged with respect to the default welcomelist.
.IP \fBcheck_mailfrom_matches_rcvd()\fR 4
.IX Item "check_mailfrom_matches_rcvd()"
Checks if the envelope sender domain matches the relay domain.
.IP \fBcheck_uri_host_in_blocklist()\fR 4
.IX Item "check_uri_host_in_blocklist()"
Checks if any URI host is in the blocklist.
.IP \fBcheck_uri_host_in_welcomelist()\fR 4
.IX Item "check_uri_host_in_welcomelist()"
Checks if any URI host is in the welcomelist.
.IP check_uri_host_listed($subname) 4
.IX Item "check_uri_host_listed($subname)"
Checks if any URI host is listed in the specified list.