{
    "content": [
        {
            "type": "text",
            "text": "# Mail::Box::MH::Index (perldoc)\n\n## NAME\n\nMail::Box::MH::Index - keep index files for messages.\n\n## SYNOPSIS\n\nmy $index = Mail::Box::MH::Index->new;\n$index->read(...)\n$index->write(...)\n\n## DESCRIPTION\n\nMessage folders which store their data in one single file per message are very inefficient for\nproducing subject overviews and for computing message threads. The \"Mail::Box::MH::Index\" object\nis able to store and read a the headers of a set of \"Mail::Box::MH::Message\" messages which are\npart of a single \"Mail::Box::MH\" folder in one file.\n\n## Sections\n\n- **NAME**\n- **INHERITANCE**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS** (4 subsections)\n- **DIAGNOSTICS**\n- **SEE ALSO**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Mail::Box::MH::Index",
        "section": "",
        "mode": "perldoc",
        "summary": "Mail::Box::MH::Index - keep index files for messages.",
        "synopsis": "my $index = Mail::Box::MH::Index->new;\n$index->read(...)\n$index->write(...)",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INHERITANCE",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 15,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "Constructors",
                        "lines": 26
                    },
                    {
                        "name": "The Index",
                        "lines": 18
                    },
                    {
                        "name": "Error handling",
                        "lines": 41
                    },
                    {
                        "name": "Cleanup",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Mail::Box::MH::Index - keep index files for messages.\n",
                "subsections": []
            },
            "INHERITANCE": {
                "content": "Mail::Box::MH::Index\nis a Mail::Reporter\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "my $index = Mail::Box::MH::Index->new;\n$index->read(...)\n$index->write(...)\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Message folders which store their data in one single file per message are very inefficient for\nproducing subject overviews and for computing message threads. The \"Mail::Box::MH::Index\" object\nis able to store and read a the headers of a set of \"Mail::Box::MH::Message\" messages which are\npart of a single \"Mail::Box::MH\" folder in one file.\n\nWhen the \"Mail::Box::MH::Index\" functionality is enabled by specifying\nMail::Box::MH::new(keepindex) when opening a folder, the index file is automatically read. When\nthe folder is closed, a new index file is created.\n\nSpecial care is taken to avoid problems which occur when the user changes or removes message\nfiles without updating the index. If the index is not trustworthy it will not be used (costing\nsome performance for the reader of the folder).\n\nExtends \"DESCRIPTION\" in Mail::Reporter.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "Extends \"METHODS\" in Mail::Reporter.\n",
                "subsections": [
                    {
                        "name": "Constructors",
                        "content": "Extends \"Constructors\" in Mail::Reporter.\n\nMail::Box::MH::Index->new(%options)\n-Option   --Defined in     --Default\nfilename                    <required>\nheadtype                   Mail::Message::Head::Subset\nheadwrap                   72\nlog        Mail::Reporter   'WARNINGS'\ntrace      Mail::Reporter   'WARNINGS'\n\nfilename => FILENAME\nThe FILENAME which is used to store the headers of all the e-mails for one folder. This\nmust be an absolute pathname.\n\nheadtype => CLASS\nThe type of headers which will be used to store header information when it is read from\nthe index file. You can not be sure the index contains all header line (the mailbox may\nhave been updated without updating the index) so this will usually be (an sub-class of)\nMail::Message::Head::Subset.\n\nheadwrap => INTEGER\nThe preferred number of character in each header line.\n\nlog => LEVEL\ntrace => LEVEL\n"
                    },
                    {
                        "name": "The Index",
                        "content": "$obj->append($messages)\nAppend $messages to the index file.\n\n$obj->filename()\nReturns the name of the index file.\n\n$obj->get($msgfile)\nLook if there is header info for the specified $msgfile. The filename represents one message\nin folder type which are organized as directory. This method will return an object of the\nnew(headtype) as specified during creation of the index object, or \"undef\" if the\ninformation is not known or not trustworthy -i.e. the file size changed.\n\n$obj->read()\nRead the index file. The header objects can after this be requested with the get() method.\n\n$obj->write($messages)\nWrite an index file containing the headers specified $messages (Mail::Message objects).\n"
                    },
                    {
                        "name": "Error handling",
                        "content": "Extends \"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, $callback] )\nMail::Box::MH::Index->defaultTrace( [$level]|[$loglevel, $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::Index->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Box::MH::Index->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"
                    },
                    {
                        "name": "Cleanup",
                        "content": "Extends \"Cleanup\" in Mail::Reporter.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Reporter\n"
                    }
                ]
            },
            "DIAGNOSTICS": {
                "content": "Error: Package $package does not implement $method.\nFatal error: the specific package (or one of its superclasses) does not implement this\nmethod where it should. This message means that some other related classes do implement this\nmethod however the class at hand does not. Probably you should investigate this and probably\ninform the author of the package.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "This module is part of Mail-Box distribution version 3.010, built on July 18, 2023. Website:\nhttp://perl.overmeer.net/CPAN/\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "Copyrights 2001-2023 by [Mark Overmeer]. For other contributors see ChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself. See http://dev.perl.org/licenses/\n",
                "subsections": []
            }
        }
    }
}