GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::HEAD::SPAMGROUP (3)

.ds Aq ’

NAME

Mail::Message::Head::SpamGroup - spam fighting related header fields

CONTENTS

INHERITANCE



 Mail::Message::Head::SpamGroup
   is a Mail::Message::Head::FieldGroup
   is a Mail::Reporter



SYNOPSIS



 my $sg = Mail::Message::Head::SpamGroup->new(head => $head, ...);
 $head->addSpamGroup($sg);

 my $sg = $head->addSpamGroup( <options> );
 $sg->delete;

 my @sgs = $head->spamGroups;



DESCRIPTION

A spam group is a set of header fields which are added by spam detection and spam fighting software. This class knows various details about that software.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>() See Constructors in Mail::Message::Head::FieldGroup
$obj-><B>fighterB>(NAME, [SETTINGS])
Mail::Message::Head::SpamGroup-><B>fighterB>(NAME, [SETTINGS]) Get the SETTINGS of a certain spam-fighter, optionally after setting them. The knownFighters() method returns the defined names. The names are case-sensitive.



 -Option --Default
  fields   <required>
  isspam   <required>
  version  undef



fields => REGEXP The regular expression which indicates which of the header fields are added by the spam fighter software.
isspam => CODE The CODE must return true or false, to indicate whether the spam fighter thinks that the message contains spam. The CODE ref is called with the spamgroup object (under construction) and the header which is inspected.
version => CODE Can be called to collect the official name and the version of the software which is used to detect spam. The CODE ref is called with the spamgroup object (under construction) and the header which is inspected.

example: adding your own spam-fighter definitions



 Mail::Message::Head::SpamGroup->fighter( MY-OWN,
    fields => qw/^x-MY-SPAM-DETECTOR-/,
    isspam => sub { my ($sg, $head) = @_; $head->fields > 100 }
   );



$obj-><B>fromB>(HEAD|MESSAGE, OPTIONS) Returns a list of Mail::Message::Head::SpamGroup objects, based on the specified MESSAGE or message HEAD.



 -Option--Default
  types   undef



types => ARRAY-OF-NAMES Only the specified types will be tried. If the ARRAY is empty, an empty list is returned. Without this option, all sets are returned.
$obj-><B>habeasSweFieldsCorrectB>([MESSAGE|HEAD])
Mail::Message::Head::SpamGroup-><B>habeasSweFieldsCorrectB>([MESSAGE|HEAD]) Returns a true value if the MESSAGE or HEAD contains Habeas-SWE fields which are correct. Without argument, this is used as instance method on an existing Spam-Group.

example: checking Habeas-SWE fields



 if(Mail::Message::Head::SpamGroup->habeasSweFieldsCorrect($message))
 {   $message->label(spam => 0);
 }

 my $sg = $message->head->spamGroups(Habeas-SWE);
 if($sg->habeasSweFieldsCorrect) { ... };

 use List::Util first;
 if(first {$_->habeasSweFieldsCorrect} $head->spamGroups)
 {   ...
 }



$obj-><B>implementedTypesB>()
Mail::Message::Head::SpamGroup-><B>implementedTypesB>() See Constructors in Mail::Message::Head::FieldGroup
$obj-><B>isSpamGroupFieldNameB>(NAME)
Mail::Message::Head::SpamGroup-><B>isSpamGroupFieldNameB>(NAME)
$obj-><B>knownFightersB>()
Mail::Message::Head::SpamGroup-><B>knownFightersB>() Returns an unsorted list of all names representing pre-defined spam-fighter software. You can ask details about them, and register more fighters with the fighter() method.
Mail::Message::Head::SpamGroup-><B>newB>(FIELDS, OPTIONS) Construct an object which maintains one set of fields which were added by spam fighting software.



 -Option  --Defined in                     --Default
  head      Mail::Message::Head::FieldGroup  undef
  log       Mail::Reporter                   WARNINGS
  software  Mail::Message::Head::FieldGroup  undef
  trace     Mail::Reporter                   WARNINGS
  type      Mail::Message::Head::FieldGroup  undef
  version   Mail::Message::Head::FieldGroup  undef



head => HEAD
log => LEVEL
software => STRING
trace => LEVEL
type => STRING
version => STRING
$obj-><B>spamDetectedB>([BOOLEAN]) Returns (after setting) whether this group of spam headers thinks that this is spam. See Mail::Message::Head::Complete::spamDetected().

example:



  die if $head->spamDetected;

  foreach my $sg ($head->spamGroups)
  {   print $sg->type." found spam\n" if $sg->spamDetected;
  }



    The header

See documentation in the base class.
$obj-><B>addB>((FIELD, VALUE) | OBJECT) See The header in Mail::Message::Head::FieldGroup
$obj-><B>addFieldsB>([FIELDNAMES]) See The header in Mail::Message::Head::FieldGroup
$obj-><B>attachB>(HEAD) See The header in Mail::Message::Head::FieldGroup
$obj-><B>deleteB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>fieldNamesB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>fieldsB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>headB>() See The header in Mail::Message::Head::FieldGroup

    Access to the header

See documentation in the base class.
$obj-><B>softwareB>() See Access to the header in Mail::Message::Head::FieldGroup
$obj-><B>typeB>() See Access to the header in Mail::Message::Head::FieldGroup
$obj-><B>versionB>() See Access to the header in Mail::Message::Head::FieldGroup

    Internals

See documentation in the base class.
$obj-><B>collectFieldsB>([NAME]) See Internals in Mail::Message::Head::FieldGroup
$obj-><B>detectedB>(TYPE, SOFTWARE, VERSION) See Internals in Mail::Message::Head::FieldGroup

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Head::SpamGroup-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>detailsB>() See Error handling in Mail::Message::Head::FieldGroup
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Head::SpamGroup-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Head::SpamGroup-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>printB>([FILEHANDLE]) See Error handling in Mail::Message::Head::FieldGroup
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DETAILS

    Spam fighting fields

Detected spam fighting software

The Mail::Message::Head::SpamGroup class can be used to detect fields which were produced by different spam fighting software.
o SpamAssassin

These fields are added by Mail::SpamAssassin, which is the central implementation of the spam-assassin package. The homepage of this GPL’ed project can be found at <http://spamassassin.org>.

o Habeas-SWE

Habeas tries to fight spam via the standard copyright protection mechanism: Sender Warranted E-mail (SWE). Only when you have a contract with Habeas, you are permitted to add a few copyrighted lines to your e-mail. Spam senders will be refused a contract. Mail clients which see these nine lines are (quite) sure that the message is sincere.

See <http://www.habeas.com> for all the details on this commercial product.

o MailScanner

The MailScanner filter is developed and maintained by transtec Computers. The software is available for free download from <http://www.sng.ecs.soton.ac.uk/mailscanner/>. Commercial support is provided via <http://www.mailscanner.biz>.

DIAGNOSTICS

Error: Package $package does not implement $method. Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

SEE ALSO

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 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 http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::HEAD::SPAMGROUP (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.