.\" Automatically generated by Pod::Man 4.14 (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 .. .\" 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::SpamAssassin::PerMsgLearner 3pm" .TH Mail::SpamAssassin::PerMsgLearner 3pm "2023-04-30" "perl v5.36.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::PerMsgLearner \- per\-message status (spam or not\-spam) .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& my $spamtest = Mail::SpamAssassin\->new({ \& \*(Aqrules_filename\*(Aq => \*(Aq/etc/spamassassin.rules\*(Aq, \& \*(Aquserprefs_filename\*(Aq => $ENV{HOME}.\*(Aq/.spamassassin/user_prefs\*(Aq \& }); \& my $mail = $spamtest\->parse(); \& \& my $status = $spamtest\->learn($mail,$id,$isspam,$forget); \& my $didlearn = $status\->did_learn(); \& $status\->finish(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Mail::SpamAssassin \f(CW\*(C`learn()\*(C'\fR method returns an object of this class. This object encapsulates all the per-message state for the learning process. .SH "METHODS" .IX Header "METHODS" .ie n .IP "$didlearn = $status\->\fBdid_learn()\fR" 4 .el .IP "\f(CW$didlearn\fR = \f(CW$status\fR\->\fBdid_learn()\fR" 4 .IX Item "$didlearn = $status->did_learn()" Returns \f(CW1\fR if the message was learned from or forgotten successfully. .ie n .IP "$status\->\fBfinish()\fR" 4 .el .IP "\f(CW$status\fR\->\fBfinish()\fR" 4 .IX Item "$status->finish()" Finish with the object. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBMail::SpamAssassin\fR\|(3) \&\fBspamassassin\fR\|(1)