unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::Box::MH::Labels(User Contributed Perl DocumentMail::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.

METHODS
       Constructors

       Mail::Box::MH::Labels->new(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->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->filename

           Returns the name of the index file.

       $obj->get(MSGNR)

           Look if there is label info for message MSGNR.

       $obj->print(FILEHANDLE, 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.

       Error handling

       $obj->AUTOLOAD

           See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)

           See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

       Mail::Box::MH::Labels->defaultTrace([LEVEL]|[LOGLEVEL,
       TRACELEVEL]|[LEVEL, CALLBACK])

           See "Error handling" in Mail::Reporter

       $obj->errors

           See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])

       Mail::Box::MH::Labels->log([LEVEL [,STRINGS]])

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

       Mail::Box::MH::Labels->logPriority(LEVEL)

           See "Error handling" in Mail::Reporter

       $obj->logSettings

           See "Error handling" in Mail::Reporter

       $obj->notImplemented

           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->warnings

           See "Error handling" in Mail::Reporter

       Cleanup

       $obj->DESTROY

           See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction

           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.082, built on
       April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE
       Copyrights 2001-2008 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



perl v5.10.0                      2008-04-28        Mail::Box::MH::Labels(3pm)