Mail::M...amGroup(3)

📦

version 4.04 · 11 versions

💖 Mail::Message::Head::SpamGroup 💖

okay so bestie, welcome to the manual page for Mail::Message::Head::SpamGroup(3) — yes it's filed under User Contributed Perl Documentation, and yes we are absolutely going to read the whole thing together. Grab a snack. 🍓

🌸 NAME 🌸

Mail::Message::Head::SpamGroup — header fields that are all about fighting spam. the spam-fighting header field bestie 💅

🦋 INHERITANCE 🦋

so the family tree goes like this, lowkey iconic:

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

✨ SYNOPSIS ✨

here's the vibe check, in code, no cap:

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

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

my @sgs = $head->spamGroups;

🎀 DESCRIPTION 🎀

so a spam group is literally just a lil set of header fields that get added by spam-detection and spam-fighting software. and this class knows All The Details about that software. it's giving very informed. 👑

it also extends "DESCRIPTION" in Mail::Message::Head::FieldGroup.

🔥 METHODS 🔥

extends "METHODS" in Mail::Message::Head::FieldGroup.

🌈 Constructors 🌈

extends "Constructors" in Mail::Message::Head::FieldGroup.

$obj->clone() — inherited, so go read "Constructors" in Mail::Message::Head::FieldGroup for the tea.
$any->fighter($name, %options) — gets you the settings of one specific spam-fighter, and if you want, you can set them at the same time. the names of all the defined fighters come from knownFighters(). heads up: the names are case-sensitive, so don't be sloppy with your caps bestie.

every one of the %options gets passed through as a setting to the spamfilter — except these few that get special treatment and are listed right here:

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

fields => REGEXP — the regular expression that says which header fields were added by the spam-fighter software. 🕵️
isspam => CODE — this CODE has to return "true" or "false", telling you whether the spam fighter thinks the message is spam. the CODE ref gets called with the spamgroup object (the one under construction) and the header that's being inspected.
version => CODE — you can call this to collect the official name and the version of the software being used to detect spam. the CODE ref gets called with the spamgroup object (the one under construction) and the header that's being 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->from($head|$message, %options) — hands you a list of Mail::Message::Head::SpamGroup objects, built from the $message or the message $head you passed in. improves the base, so peek at "Constructors" in Mail::Message::Head::FieldGroup.

 -Option--Default
  types   undef

types => ARRAY-OF-NAMES — only these specified types get tried. if the ARRAY is empty, you get an empty list back. skip this option entirely and all the sets come back to you. 🎁

$any->habeasSweFieldsCorrect( [$message|$head] ) — returns a "true" value if the $message or $head has Habeas-SWE fields and they're correct. no argument? then it's used as an instance method on an existing Spam-Group. cute.

» 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)
{   ...
}

$any->implementedTypes() — inherited, go see "Constructors" in Mail::Message::Head::FieldGroup.
$any->isSpamGroupFieldName($name) — that's it, that's the method. 💅
$any->knownFighters() — returns an unsorted list of every name that represents a pre-defined spam-fighter software. you can ask for details about them, and you can register even more fighters using the fighter() method. collect them all 🌈
$class->new($fields, %options) — builds an object that maintains one single set of fields which were added by spam-fighting software. improves the base, so check "Constructors" in Mail::Message::Head::FieldGroup.

 -Option  --Defined in                     --Default
  head      Mail::Message::Head::FieldGroup  undef
  software  Mail::Message::Head::FieldGroup  undef
  type      Mail::Message::Head::FieldGroup  undef
  version   Mail::Message::Head::FieldGroup  undef

head => $head
software => STRING
type => STRING
version => STRING

$obj->spamDetected( [BOOLEAN] ) — tells you (and after you set it, remembers) whether this group of spam headers thinks the message is spam. see Mail::Message::Head::Complete::spamDetected() for the related lore.

» example: 🫶

die if $head->spamDetected;

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

🌟 Attributes 🌟

extends "Attributes" in Mail::Message::Head::FieldGroup.

💌 The header 💌

extends "The header" in Mail::Message::Head::FieldGroup.

$obj->add( <$field, $value> | $object ) — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->addFields( [$fieldnames] ) — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->attach($head) — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->delete() — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->fieldNames() — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->fields() — inherited, see "The header" in Mail::Message::Head::FieldGroup.
$obj->head() — inherited, see "The header" in Mail::Message::Head::FieldGroup.

🔍 Access to the header 🔍

extends "Access to the header" in Mail::Message::Head::FieldGroup.

$obj->software() — inherited, see "Access to the header" in Mail::Message::Head::FieldGroup.
$obj->type() — inherited, see "Access to the header" in Mail::Message::Head::FieldGroup.
$obj->version() — inherited, see "Access to the header" in Mail::Message::Head::FieldGroup.

🛠 Internals 🛠

extends "Internals" in Mail::Message::Head::FieldGroup.

$obj->collectFields( [$name] ) — inherited, see "Internals" in Mail::Message::Head::FieldGroup.
$obj->detected($type, $software, $version) — inherited, see "Internals" in Mail::Message::Head::FieldGroup.

😭 Error handling 😭

extends "Error handling" in Mail::Message::Head::FieldGroup.

$obj->AUTOLOAD() — inherited, see "Error handling" in Mail::Reporter.
$obj->details() — inherited, see "Error handling" in Mail::Message::Head::FieldGroup.
$obj->notImplemented() — inherited, see "Error handling" in Mail::Reporter.
$obj->print( [$fh] ) — inherited, see "Error handling" in Mail::Message::Head::FieldGroup.

🧹 Cleanup 🧹

extends "Cleanup" in Mail::Message::Head::FieldGroup.

$obj->DESTROY() — inherited, see "Cleanup" in Mail::Reporter.

💀 DIAGNOSTICS 💀

Error: class $package does not implement method $method. — fatal error, bestie. the specific $package (or one of its superclasses) does not implement this method where it should. this message means some other related classes do implement this method, but the class you're holding right now does not. you should probably investigate this and probably inform the author of the package. cast by notImplemented().

👀 SEE ALSO 👀

this module is part of Mail-Message version 4.04, built on February 04, 2026. website: http://perl.overmeer.net/CPAN/ 🌐

📜 LICENSE 📜

for contributors, see file ChangeLog.

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

and that's the whole page, bestie — thanks for reading all the way down 🫶 this was Mail::Message::Head::SpamGroup(3), brought to you by perl v5.42.0 on 2026-02-05. stan a well-documented spam header. 💖

📦 where this page comes from

fedora 44: perl-Mail-Message 4.04-1.fc44 · GPL-1.0-or-later OR Artistic-1.0-Perl
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms