.\" -*- 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::Message::Wrapper::SpamAssassin 3pm"
.TH Mail::Message::Wrapper::SpamAssassin 3pm 2024-03-07 "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
Mail::Message::Wrapper::SpamAssassin \- Connect a Mail::Message with Mail::SpamAssassin
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 2
\& Mail::Message::Wrapper::SpamAssassin
\&   is a Mail::SpamAssassin::Message
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& # WARNING: requires OLD SpamAssassion 2.x, not the new 3.x
\& # See Mail::Box::Search::SpamAssassin for the preferred interface
\& # However, it is possible to do:
\&
\& my $msg    = ...;   # some Mail::Message object
\& my $sa     = Mail::Message::Wrapper::SpamAssassin\->new($msg);
\& my $spam   = Mail::SpamAssassin\->new;
\& my $status = $spam\->check($sa);
\&
\& $msg\->label(spam => 1) if $status\->is_spam;
\& $status\->rewrite_mail;  # Adds spam lines to header
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
WARNING: This module only works with the old version of SpamAssassin:
version 2.x.  The newer 3.x releases have changed the way that messages
are kept. Please contribute improved code.
.PP
The \f(CW\*(C`Mail::Message::Wrapper::SpamAssassin\*(C'\fR class \-\-sorry for the
long package name\-\- is a wrapper around Mail::SpamAssassin::Message, which
is an interface to the spam checking software of Mail::SpamAssassin.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "Mail::Message::Wrapper::SpamAssassin\->\fBnew\fR($message, %options)" 4
.el .IP "Mail::Message::Wrapper::SpamAssassin\->\fBnew\fR($message, \f(CW%options\fR)" 4
.IX Item "Mail::Message::Wrapper::SpamAssassin->new($message, %options)"
Creates a wrapper around the \f(CW$message\fR.  The already present fields
from a previous run of Spam::Assassin (or probably fake lines) are
removed first.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail-Box distribution version 3.010,
built on July 18, 2023. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
Copyrights 2001\-2023 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR