/usr/share/perl5/Mail/Message/Head/SpamGroup.pod is in libmail-box-perl 2.099-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | =head1 NAME
Mail::Message::Head::SpamGroup - spam fighting related header fields
=head1 INHERITANCE
Mail::Message::Head::SpamGroup
is a Mail::Message::Head::FieldGroup
is a Mail::Reporter
=head1 SYNOPSIS
my $sg = Mail::Message::Head::SpamGroup->new(head => $head, ...);
$head->addSpamGroup($sg);
my $sg = $head->addSpamGroup( <options> );
$sg->delete;
my @sgs = $head->spamGroups;
=head1 DESCRIPTION
A I<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.
=head1 METHODS
=head2 Constructors
=over 4
=item $obj-E<gt>B<clone>
See L<Mail::Message::Head::FieldGroup/"Constructors">
=item $obj-E<gt>B<fighter>(NAME, [SETTINGS])
=item Mail::Message::Head::SpamGroup-E<gt>B<fighter>(NAME, [SETTINGS])
Get the SETTINGS of a certain spam-fighter, optionally after setting them.
The L<knownFighters()> method returns the defined names. The names
are case-sensitive.
-Option --Default
fields <required>
isspam <required>
version undef
=over 2
=item fields => REGEXP
The regular expression which indicates which of the header fields are
added by the spam fighter software.
=item 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.
=item 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.
=back
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 }
);
=item $obj-E<gt>B<from>(HEAD|MESSAGE, OPTIONS)
Returns a list of C<Mail::Message::Head::SpamGroup> objects, based on the
specified MESSAGE or message HEAD.
-Option--Default
types undef
=over 2
=item 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.
=back
=item $obj-E<gt>B<habeasSweFieldsCorrect>([MESSAGE|HEAD])
=item Mail::Message::Head::SpamGroup-E<gt>B<habeasSweFieldsCorrect>([MESSAGE|HEAD])
Returns a true value if the MESSAGE or HEAD contains C<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)
{ ...
}
=item $obj-E<gt>B<implementedTypes>
=item Mail::Message::Head::SpamGroup-E<gt>B<implementedTypes>
See L<Mail::Message::Head::FieldGroup/"Constructors">
=item $obj-E<gt>B<isSpamGroupFieldName>(NAME)
=item Mail::Message::Head::SpamGroup-E<gt>B<isSpamGroupFieldName>(NAME)
=item $obj-E<gt>B<knownFighters>
=item Mail::Message::Head::SpamGroup-E<gt>B<knownFighters>
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 L<fighter()|Mail::Message::Head::SpamGroup/"Constructors"> method.
=item Mail::Message::Head::SpamGroup-E<gt>B<new>(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
=over 2
=item head => HEAD
=item log => LEVEL
=item software => STRING
=item trace => LEVEL
=item type => STRING
=item version => STRING
=back
=item $obj-E<gt>B<spamDetected>([BOOLEAN])
Returns (after setting) whether this group of spam headers thinks that
this is spam. See L<Mail::Message::Head::Complete::spamDetected()|Mail::Message::Head::Complete/"Access to the header">.
example:
die if $head->spamDetected;
foreach my $sg ($head->spamGroups)
{ print $sg->type." found spam\n" if $sg->spamDetected;
}
=back
=head2 The header
=over 4
=item $obj-E<gt>B<add>((FIELD, VALUE) | OBJECT)
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<addFields>([FIELDNAMES])
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<attach>(HEAD)
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<delete>
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fieldNames>
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fields>
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<head>
See L<Mail::Message::Head::FieldGroup/"The header">
=back
=head2 Access to the header
=over 4
=item $obj-E<gt>B<software>
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<type>
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<version>
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<collectFields>([NAME])
See L<Mail::Message::Head::FieldGroup/"Internals">
=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
See L<Mail::Message::Head::FieldGroup/"Internals">
=back
=head2 Error handling
=over 4
=item $obj-E<gt>B<AUTOLOAD>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Message::Head::SpamGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>
See L<Mail::Message::Head::FieldGroup/"Error handling">
=item $obj-E<gt>B<errors>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Message::Head::SpamGroup-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Message::Head::SpamGroup-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<print>([FILEHANDLE])
See L<Mail::Message::Head::FieldGroup/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
=over 4
=item $obj-E<gt>B<DESTROY>
See L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>
See L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
=head2 Spam fighting fields
=head3 Detected spam fighting software
The L<Mail::Message::Head::SpamGroup|Mail::Message::Head::SpamGroup> class can be used to detect
fields which were produced by different spam fighting software.
=over 4
=item * SpamAssassin
These fields are added by L<Mail::SpamAssassin>, which is the central
implementation of the spam-assassin package. The homepage of this
GPL'ed project can be found at L<http://spamassassin.org>.
=item * 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 L<http://www.habeas.com> for all the details on this commercial
product.
=item * MailScanner
The MailScanner filter is developed and maintained by
transtec Computers. The software is available for free download from
L<http://www.sng.ecs.soton.ac.uk/mailscanner/>. Commercial support
is provided via L<http://www.mailscanner.biz>.
=back
=head1 DIAGNOSTICS
=over 4
=item 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.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2011 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>
|