File: SpamAssassin.pod

package info (click to toggle)
libmail-box-perl 2.117-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,828 kB
  • ctags: 1,564
  • sloc: perl: 23,381; makefile: 2
file content (60 lines) | stat: -rw-r--r-- 1,757 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
=encoding utf8

=head1 NAME

Mail::Message::Wrapper::SpamAssassin - Connect a Mail::Message with Mail::SpamAssassin

=head1 INHERITANCE

 Mail::Message::Wrapper::SpamAssassin
   is a Mail::SpamAssassin::Message

=head1 SYNOPSIS

 # 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

=head1 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.

The C<Mail::Message::Wrapper::SpamAssassin> 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.

=head1 METHODS

=over 4

=item Mail::Message::Wrapper::SpamAssassin-E<gt>B<new>($message, %options)

Creates a wrapper around the $message.  The already present fields
from a previous run of Spam::Assassin (or probably fake lines) are
removed first.

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.117,
built on August 24, 2014. Website: F<http://perl.overmeer.net/mailbox/>

=head1 LICENSE

Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>