{
    "content": [
        {
            "type": "text",
            "text": "# Mail::Message::Head::Subset (perldoc)\n\n## NAME\n\nMail::Message::Head::Subset - subset of header information of a message\n\n## SYNOPSIS\n\nmy $subset = Mail::Message::Head::Subset->new(...)\n$subset->isa('Mail::Message::Head')  # true\n$subset->guessBodySize               # integer or undef\n$subset->isDelayed                   # true\n\n## DESCRIPTION\n\nSome types of folders contain an index file which lists a few lines of information per messages.\nEspecially when it is costly to read header lines, the index speeds-up access considerably. For\ninstance, the subjects of all messages are often wanted, but waiting for a thousand messages of\nthe folder to be read may imply a thousand network reads (IMAP) or file openings (MH)\n\n## Sections\n\n- **NAME**\n- **INHERITANCE**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OVERLOADED**\n- **METHODS** (7 subsections)\n- **DETAILS**\n- **DIAGNOSTICS**\n- **SEE ALSO**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Mail::Message::Head::Subset",
        "section": "",
        "mode": "perldoc",
        "summary": "Mail::Message::Head::Subset - subset of header information of a message",
        "synopsis": "my $subset = Mail::Message::Head::Subset->new(...)\n$subset->isa('Mail::Message::Head')  # true\n$subset->guessBodySize               # integer or undef\n$subset->isDelayed                   # true",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INHERITANCE",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 10,
                "subsections": []
            },
            {
                "name": "OVERLOADED",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "Constructors",
                        "lines": 8
                    },
                    {
                        "name": "The header",
                        "lines": 23
                    },
                    {
                        "name": "Access to the header",
                        "lines": 15
                    },
                    {
                        "name": "About the body",
                        "lines": 10
                    },
                    {
                        "name": "Internals",
                        "lines": 23
                    },
                    {
                        "name": "Error handling",
                        "lines": 42
                    },
                    {
                        "name": "Cleanup",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DETAILS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Mail::Message::Head::Subset - subset of header information of a message\n",
                "subsections": []
            },
            "INHERITANCE": {
                "content": "Mail::Message::Head::Subset realizes a Mail::Message::Head::Complete\n\nMail::Message::Head::Subset\nis a Mail::Message::Head\nis a Mail::Reporter\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "my $subset = Mail::Message::Head::Subset->new(...)\n$subset->isa('Mail::Message::Head')  # true\n$subset->guessBodySize               # integer or undef\n$subset->isDelayed                   # true\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Some types of folders contain an index file which lists a few lines of information per messages.\nEspecially when it is costly to read header lines, the index speeds-up access considerably. For\ninstance, the subjects of all messages are often wanted, but waiting for a thousand messages of\nthe folder to be read may imply a thousand network reads (IMAP) or file openings (MH)\n\nWhen you access header fields which are not in the header subset, the whole header has to be\nparsed (which may consume considerable time, depending on the type of folder).\n\nExtends \"DESCRIPTION\" in Mail::Message::Head.\n",
                "subsections": []
            },
            "OVERLOADED": {
                "content": "Extends \"OVERLOADED\" in Mail::Message::Head.\n\noverload: \"\"\nInherited, see \"OVERLOADED\" in Mail::Message::Head\n\noverload: bool\nInherited, see \"OVERLOADED\" in Mail::Message::Head\n",
                "subsections": []
            },
            "METHODS": {
                "content": "Extends \"METHODS\" in Mail::Message::Head.\n",
                "subsections": [
                    {
                        "name": "Constructors",
                        "content": "Extends \"Constructors\" in Mail::Message::Head.\n\nMail::Message::Head::Subset->build( [PAIR|$field]-LIST )\nInherited, see \"Constructors\" in Mail::Message::Head\n\nMail::Message::Head::Subset->new(%options)\nInherited, see \"Constructors\" in Mail::Message::Head\n"
                    },
                    {
                        "name": "The header",
                        "content": "Extends \"The header\" in Mail::Message::Head.\n\n$obj->isDelayed()\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->isEmpty()\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->isModified()\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->knownNames()\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->message( [$message] )\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->modified( [BOOLEAN] )\nInherited, see \"The header\" in Mail::Message::Head\n\n$obj->orderedFields()\nInherited, see \"The header\" in Mail::Message::Head\n"
                    },
                    {
                        "name": "Access to the header",
                        "content": "Extends \"Access to the header\" in Mail::Message::Head.\n\n$obj->count($name)\nCount the number of fields with this $name. If the $name cannot be found, the full header\nget loaded. In case we find any $name field, it is decided we know all of them, and loading\nis not needed.\n\n$obj->get( $name, [$index] )\nGet the data which is related to the field with the $name. The case of the characters in\n$name does not matter. When a $name is used which is not known yet, realization will take\nplace.\n\n$obj->study( $name, [$index] )\nInherited, see \"Access to the header\" in Mail::Message::Head\n"
                    },
                    {
                        "name": "About the body",
                        "content": "Extends \"About the body\" in Mail::Message::Head.\n\n$obj->guessBodySize()\nThe body size is defined in the \"Content-Length\" field. However, this field may not be\nknown. In that case, a guess is made based on the known \"Lines\" field. When also that field\nis not known yet, \"undef\" is returned.\n\n$obj->isMultipart()\nInherited, see \"About the body\" in Mail::Message::Head\n"
                    },
                    {
                        "name": "Internals",
                        "content": "Extends \"Internals\" in Mail::Message::Head.\n\n$obj->addNoRealize($field)\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->addOrderedFields($fields)\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->fileLocation()\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->load()\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->moveLocation($distance)\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->read($parser)\nInherited, see \"Internals\" in Mail::Message::Head\n\n$obj->setNoRealize($field)\nInherited, see \"Internals\" in Mail::Message::Head\n"
                    },
                    {
                        "name": "Error handling",
                        "content": "Extends \"Error handling\" in Mail::Message::Head.\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::Message::Head::Subset->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback]\n)\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::Message::Head::Subset->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Message::Head::Subset->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::Message::Head.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Reporter\n"
                    }
                ]
            },
            "DETAILS": {
                "content": "Extends \"DETAILS\" in Mail::Message::Head.\n",
                "subsections": []
            },
            "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.009, built on August 18, 2020. Website:\nhttp://perl.overmeer.net/CPAN/\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "Copyrights 2001-2020 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": []
            }
        }
    }
}