Scroll to navigation

Mail::Box::MH::Labels(3pm) User Contributed Perl Documentation Mail::Box::MH::Labels(3pm)

NAME

Mail::Box::MH::Labels - maintain MH message related labels

INHERITANCE

 Mail::Box::MH::Labels
   is a Mail::Reporter

SYNOPSIS

  my $labels = Mail::Box::MH::Labels->new;
  $labels->read(...)
  $labels->write(...)

DESCRIPTION

MH type message folders use one dedicated file per folder-directory to list special tags to messages in that folder. By doing this, mail agents may avoid parsing all the messages, which is very resource consuming.

Labels can be used to group messages, for instance to reflect which messages have been read or which look like spam. Some labels are predefined, but more can be added without limitation.

Extends "DESCRIPTION" in Mail::Reporter.

METHODS

Extends "METHODS" in Mail::Reporter.

Constructors

Extends "Constructors" in Mail::Reporter.

$class->new(%options)
Inherited, see "Constructors" in Mail::Reporter 

 -Option  --Defined in     --Default
  filename                   <required>
  log       Mail::Reporter   'WARNINGS'
  trace     Mail::Reporter   'WARNINGS'
The FILENAME which is used in each directory to store the headers of all mails. The filename must be an absolute path.

Attributes

Extends "Attributes" in Mail::Reporter.

$obj->filename()
Returns the name of the index file.
$obj->logSettings()
Inherited, see "Attributes" in Mail::Reporter

Error handling

Extends "Error handling" in Mail::Reporter.

$obj->AUTOLOAD()
Inherited, see "Error handling" in Mail::Reporter
$obj->addReport($object)
Inherited, see "Error handling" in Mail::Reporter
$any->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see "Error handling" in Mail::Reporter
$obj->errors()
Inherited, see "Error handling" in Mail::Reporter
$any->log( [$level, [$strings]] )
Inherited, see "Error handling" in Mail::Reporter
$any->logPriority($level)
Inherited, see "Error handling" in Mail::Reporter
$obj->notImplemented()
Inherited, see "Error handling" in Mail::Reporter
$obj->report( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->reportAll( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->trace( [$level] )
Inherited, see "Error handling" in Mail::Reporter
$obj->warnings()
Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Reporter.

$obj->DESTROY()
Inherited, see "Cleanup" in Mail::Reporter

The Label Table

$obj->append($messages)
Append the label information about the specified $messages to the end of the label file. The information will not be merged with the information already present in the label file.
$obj->get($msgnr)
Look if there is label info for message $msgnr.
$obj->print($fh, $messages)
Print the labels of the specified messages to the opened file.
$obj->read()
Read all label information from file.
$obj->write(@messages)
Write the labels related to the specified @messages to the label file.

DIAGNOSTICS

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. Cast by notImplemented()

SEE ALSO

This module is part of Mail-Box version 3.012, built on November 27, 2025. Website: http://perl.overmeer.net/CPAN/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2001-2025 by Mark Overmeer.

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

2025-12-07 perl v5.40.1