.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::Plugin::FreeMail 3pm"
.TH Mail::SpamAssassin::Plugin::FreeMail 3pm 2024-04-02 "perl v5.38.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
FreeMail \- check message headers/body for freemail\-domains
.SH SYNOPSIS
.IX Header "SYNOPSIS"
If for example From-address is freemail, and Reply-To or address found in mail body is
different freemail address, return success.  Good sign of Nigerian scams
etc.  Test idea from Marc Perkel.
.PP
Also separate functions to check various portions of message for freemails.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
freemail_domains domain ...
.PP
.Vb 1
\&   List of domains to be used in checks.
\&
\&   Regexp is not supported, but following wildcards work:
\&
\&   ? for single character (does not match a dot)
\&   * for multiple characters (does not match a dot)
\&
\&   For example:
\&   freemail_domains hotmail.com hotmail.co.?? yahoo.* yahoo.*.*
.Ve
.PP
freemail_welcomelist email/domain ...
.PP
.Vb 1
\&   Previously freemail_whitelist which will work interchangeably until 4.1.
\&
\&   Emails or domains listed here are ignored (pretend they aren\*(Aqt
\&   freemail). No wildcards!
.Ve
.PP
freemail_import_welcomelist_auth 1/0
.PP
.Vb 2
\&   Entries in welcomelist_auth will also be used to welcomelist emails
\&   or domains from being freemail.  Default is 0.
.Ve
.PP
freemail_import_def_welcomelist_auth 1/0
.PP
.Vb 2
\&   Entries in def_welcomelist_auth will also be used to welcomelist emails
\&   or domains from being freemail.  Default is 0.
.Ve
.PP
header FREEMAIL_REPLYTO eval:check_freemail_replyto(['option'])
.PP
.Vb 1
\&   Checks/compares freemail addresses found from headers and body.
\&
\&   Possible options:
\&
\&   replyto      From: or body address is different than Reply\-To
\&                (this is the default)
\&   reply        as above, but if no Reply\-To header is found,
\&                compares From: and body
.Ve
.PP
header FREEMAIL_FROM eval:check_freemail_from(['regex'])
.PP
.Vb 3
\&   Checks all possible "from" headers to see if sender is freemail.
\&   Uses SA all_from_addrs() function (includes \*(AqResent\-From\*(Aq, \*(AqFrom\*(Aq,
\&   \*(AqEnvelopeFrom\*(Aq etc).
\&
\&   Add optional regex to match the found email address(es). For example,
\&   to see if user ends in digit: check_freemail_from(\*(Aq\ed@\*(Aq)
\&
\&   If you use multiple check_freemail_from rules with regexes, remember
\&   that they might hit different emails from different heades. To match
\&   a certain header only, use check_freemail_header.
.Ve
.PP
header FREEMAIL_HDRX eval:check_freemail_header('header' [, 'regex'])
.PP
.Vb 2
\&   Searches defined header for freemail address. Optional regex to match
\&   the found address (like in check_freemail_from).
.Ve
.PP
header FREEMAIL_BODY eval:check_freemail_body(['regex'])
.PP
.Vb 1
\&   Searches body for freemail address. With optional regex to match.
.Ve