NAME

Mail::SpamAssassin::SimpleClient::Result - the results of checking a message

VERSION

version 0.101610

METHODS

new

my $result = Mail::SpamAssassin::SimpleClient::Result->new(\%arg);

This method returns a new Result object. Don't call this method unless you are Mail::SpamAssassin::SimpleClient. (nota bene, you are not.)

is_spam

This method returns a true or false value indicating whether the checked message was found to be spam.

score

threshold

These methods return the message's score and the score that would be needed to classify the message as spam.

sa_version

This method returns the version of SpamAssassin that checked the message.

tests

my @test_names = $result->tests;

This method returns a list of tests against which the message matched. Note that not every test is an indicator of spamminess. Some indicate hamminess.

test_scores

my %test_score = $result->test_scores;

This method returns a list of name/value pairs. The values are the number of points (positive or negative) for which the test counts. Since non-spam reports do not elaborate on the number of points per test, the value for each test on a non-spam result is undefined.

test_descriptions

my %descriptions = $result->test_descriptions;

This method returns a list of name/value pairs. The values are the full description names for any tests run. Since non-spam reports do not elaborate on individual tests run, the description for each test on a non-spam result is undefined.

email

This method returns the email object included in the response.

AUTHOR

Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.