import rt 3.2.2
[freeside.git] / rt / lib / RT / Interface / Email / Filter / SpamAssassin.pm
1 # {{{ BEGIN BPS TAGGED BLOCK
2
3 # COPYRIGHT:
4 #  
5 # This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC 
6 #                                          <jesse@bestpractical.com>
7
8 # (Except where explicitly superseded by other copyright notices)
9
10
11 # LICENSE:
12
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
16 # from www.gnu.org.
17
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 # General Public License for more details.
22
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26
27
28 # CONTRIBUTION SUBMISSION POLICY:
29
30 # (The following paragraph is not intended to limit the rights granted
31 # to you to modify and distribute this software under the terms of
32 # the GNU General Public License and is only of importance to you if
33 # you choose to contribute your changes and enhancements to the
34 # community by submitting them to Best Practical Solutions, LLC.)
35
36 # By intentionally submitting any modifications, corrections or
37 # derivatives to this work, or any other work intended for use with
38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
39 # you are the copyright holder for those contributions and you grant
40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
41 # royalty-free, perpetual, license to use, copy, create derivative
42 # works based on those contributions, and sublicense and distribute
43 # those contributions and any derivatives thereof.
44
45 # }}} END BPS TAGGED BLOCK
46 package RT::Interface::Email::Filter::SpamAssassin;
47
48 use Mail::SpamAssassin;
49 my $spamtest = Mail::SpamAssassin->new();
50
51 sub GetCurrentUser {
52     my $item = shift;
53     my $status = $spamtest->check ($item);
54     return (undef, 0) unless $status->is_spam();
55     eval { $status->rewrite_mail() };
56     if ($status->get_hits > $status->get_required_hits()*1.5) { 
57         # Spammy indeed
58         return (undef, -1);
59     }
60     return (undef, 0);
61 }
62
63 =head1 NAME
64
65 RT::Interface::Email::Filter::SpamAssassin - Spam filter for RT
66
67 =head1 SYNOPSIS
68
69     @RT::MailPlugins = ("Filter::SpamAssassin", ...);
70
71 =head1 DESCRIPTION
72
73 This plugin checks to see if an incoming mail is spam (using
74 C<spamassassin>) and if so, rewrites its headers. If the mail is very
75 definitely spam - 1.5x more hits than required - then it is dropped on
76 the floor; otherwise, it is passed on as normal.
77
78 =cut
79
80 eval "require RT::Interface::Email::Filter::SpamAssassin_Vendor";
81 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email/Filter/SpamAssassin_Vendor.pm});
82 eval "require RT::Interface::Email::Filter::SpamAssassin_Local";
83 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email/Filter/SpamAssassin_Local.pm});
84
85 1;