rt/lib/RT/Interface/Email/Filter/SpamAssassin.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   6 #                                          <sales@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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 package RT::Interface::Email::Filter::SpamAssassin;
  50
  51 use Mail::SpamAssassin;
  52 my $spamtest = Mail::SpamAssassin->new();
  53
  54 sub GetCurrentUser {
  55     my %args = (
  56         Message     => undef,
  57         CurrentUser => undef,
  58         AuthLevel   => undef,
  59         @_
  60     );
  61     my $status = $spamtest->check( $args{'Message'} );
  62     return ( $args{'CurrentUser'}, $args{'AuthLevel'} )
  63       unless $status->is_spam();
  64
  65     eval { $status->rewrite_mail() };
  66     if ( $status->get_hits > $status->get_required_hits() * 1.5 ) {
  67
  68         # Spammy indeed
  69         return ( $args{'CurrentUser'}, -1 );
  70     }
  71     return ( $args{'CurrentUser'}, $args{'AuthLevel'} );
  72
  73 }
  74
  75 =head1 NAME
  76
  77 RT::Interface::Email::Filter::SpamAssassin - Spam filter for RT
  78
  79 =head1 SYNOPSIS
  80
  81     # in RT config
  82     Set(@MailPlugins, 'Filter::SpamAssassin', ...other filters...);
  83
  84 =head1 DESCRIPTION
  85
  86 This plugin checks to see if an incoming mail is spam (using
  87 C<spamassassin>) and if so, rewrites its headers. If the mail is very
  88 definitely spam - 1.5x more hits than required - then it is dropped on
  89 the floor; otherwise, it is passed on as normal.
  90
  91 =cut
  92
  93 eval "require RT::Interface::Email::Filter::SpamAssassin_Vendor";
  94 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email/Filter/SpamAssassin_Vendor.pm});
  95 eval "require RT::Interface::Email::Filter::SpamAssassin_Local";
  96 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/Email/Filter/SpamAssassin_Local.pm});
  97
  98 1;