{
    "mode": "info",
    "parameter": "Mail::Box::MH::Labels",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/info/Mail%3A%3ABox%3A%3AMH%3A%3ALabels/json",
    "generated": "2026-07-05T13:52:52Z",
    "synopsis": "my $labels = Mail::Box::MH::Labels->new;\n$labels->read(...)\n$labels->write(...)",
    "sections": {
        "Mail::Box::MH::Labels(User Contributed Perl DocumentMail::Box::MH::Labels(3pm)": {
            "content": "",
            "subsections": []
        },
        "NAME": {
            "content": "Mail::Box::MH::Labels - maintain MH message related labels\n",
            "subsections": []
        },
        "INHERITANCE": {
            "content": "Mail::Box::MH::Labels\nis a Mail::Reporter\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "my $labels = Mail::Box::MH::Labels->new;\n$labels->read(...)\n$labels->write(...)\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "MH type message folders use one dedicated file per folder-directory to\nlist special tags to messages in that folder.  By doing this, mail\nagents may avoid parsing all the messages, which is very resource\nconsuming.\n\nLabels can be used to group messages, for instance to reflect which\nmessages have been read or which look like spam.  Some labels are\npredefined, but more can be added without limitation.\n\nExtends \"DESCRIPTION\" in Mail::Reporter.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "Extends \"METHODS\" in Mail::Reporter.\n\nConstructors\nExtends \"Constructors\" in Mail::Reporter.\n\nMail::Box::MH::Labels->new(%options)\n-Option  --Defined in     --Default\nfilename                   <required>\nlog       Mail::Reporter   'WARNINGS'\ntrace     Mail::Reporter   'WARNINGS'\n\nfilename => FILENAME\nThe FILENAME which is used in each directory to store the headers\nof all mails. The filename must be an absolute path.\n\nlog => LEVEL\ntrace => LEVEL\n\nThe Label Table\n$obj->append($messages)\nAppend the label information about the specified $messages to the\nend of the label file.  The information will not be merged with the\ninformation already present in the label file.\n\n$obj->filename()\nReturns the name of the index file.\n\n$obj->get($msgnr)\nLook if there is label info for message $msgnr.\n\n$obj->print($fh, $messages)\nPrint the labels of the specified messages to the opened file.\n\n$obj->read()\nRead all label information from file.\n\n$obj->write($messages)\nWrite the labels related to the specified messages to the label\nfile.\n\nError handling\nExtends \"Error handling\" in Mail::Reporter.\n\n$obj->AUTOLOAD()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->addReport($object)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,\n$callback] )\nMail::Box::MH::Labels->defaultTrace( [$level]|[$loglevel,\n$tracelevel]|[$level, $callback] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->errors()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->log( [$level, [$strings]] )\nMail::Box::MH::Labels->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Box::MH::Labels->logPriority($level)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logSettings()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->notImplemented()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->report( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->reportAll( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->trace( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->warnings()\nInherited, see \"Error handling\" in Mail::Reporter\n\nCleanup\nExtends \"Cleanup\" in Mail::Reporter.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Reporter\n",
            "subsections": []
        },
        "DIAGNOSTICS": {
            "content": "Error: Package $package does not implement $method.\nFatal error: the specific package (or one of its superclasses) does\nnot implement this method where it should. This message means that\nsome other related classes do implement this method however the\nclass at hand does not.  Probably you should investigate this and\nprobably inform the author of the package.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "This module is part of Mail-Box distribution version 3.009, built on\nAugust 18, 2020. Website: http://perl.overmeer.net/CPAN/\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see\nChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it\nunder the same terms as Perl itself.  See http://dev.perl.org/licenses/\n\nperl v5.30.3                      2020-08-20        Mail::Box::MH::Labels(3pm)",
            "subsections": []
        }
    },
    "summary": "Mail::Box::MH::Labels - maintain MH message related labels",
    "flags": [],
    "examples": [],
    "see_also": []
}