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::BOX::MH::LABELS (3)

.ds Aq ’

NAME

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

CONTENTS

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.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::MH::Labels-><B>newB>(OPTIONS)


 -Option  --Defined in     --Default
  filename                   <required>
  log       Mail::Reporter   WARNINGS
  trace     Mail::Reporter   WARNINGS



filename => FILENAME The FILENAME which is used in each directory to store the headers of all mails. The filename must be an absolute path.
log => LEVEL
trace => LEVEL

    The Label Table

$obj-><B>appendB>(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-><B>filenameB>() Returns the name of the index file.
$obj-><B>getB>(MSGNR) Look if there is label info for message MSGNR.
$obj-><B>printB>(FILEHANDLE, MESSAGES) Print the labels of the specified messages to the opened file.
$obj-><B>readB>() Read all label information from file.
$obj-><B>writeB>(MESSAGES) Write the labels related to the specified messages to the label file.

    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::Box::MH::Labels-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::MH::Labels-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::MH::Labels-><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>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

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::BOX::MH::LABELS (3) 2013-08-19

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