NAME

Mail::SpamAssassin::PerMsgLearner - per-message status (spam or not-spam)


SYNOPSIS

  my $spamtest = new Mail::SpamAssassin ({
    'rules_filename'      => '/etc/spamassassin.rules',
    'userprefs_filename'  => $ENV{HOME}.'/.spamassassin.cf'
  });
  my $mail = Mail::SpamAssassin::NoMailAudit->new();
  my $status = $spamtest->learn ($mail);
  ...


DESCRIPTION

The Mail::SpamAssassin learn() method returns an object of this class. This object encapsulates all the per-message state for the learning process.


METHODS

$status->learn_spam($id)
Learn the message as spam.

$id is an optional message-identification string, used internally to tag the message. If it is undef, the Message-Id of the message will be used. It should be unique to that message.

$status->learn_ham($id)
Learn the message as ham.

$id is an optional message-identification string, used internally to tag the message. If it is undef, the Message-Id of the message will be used. It should be unique to that message.

$status->forget($id)
Forget about a previously-learned message.

$id is an optional message-identification string, used internally to tag the message. If it is undef, the Message-Id of the message will be used. It should be unique to that message.

$didlearn = $status->did_learn()
Returns 1 if the message was learned from or forgotten succesfully.

$status->finish()
Finish with the object.


SEE ALSO

Mail::SpamAssassin spamassassin