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::MESSAGE::HEAD::SUBSET (3)

.ds Aq ’

NAME

Mail::Message::Head::Subset - subset of header information of a message

CONTENTS

INHERITANCE



 Mail::Message::Head::Subset realizes a Mail::Message::Head::Complete

 Mail::Message::Head::Subset
   is a Mail::Message::Head
   is a Mail::Reporter



SYNOPSIS



 my $subset = Mail::Message::Head::Subset->new(...)
 $subset->isa(Mail::Message::Head)  # true
 $subset->guessBodySize               # integer or undef
 $subset->isDelayed                   # true



DESCRIPTION

Some types of folders contain an index file which lists a few lines of information per messages. Especially when it is costly to read header lines, the index speeds-up access considerably. For instance, the subjects of all messages are often wanted, but waiting for a thousand messages of the folder to be read may imply a thousand network reads (IMAP) or file openings (MH)

When you access header fields which are not in the header subset, the whole header has to be parsed (which may consume considerable time, depending on the type of folder).

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Head
overload: <B>boolB>() See OVERLOADED in Mail::Message::Head

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Message::Head::Subset-><B>buildB>([PAIR|FIELD]-LIST) See Constructors in Mail::Message::Head
Mail::Message::Head::Subset-><B>newB>(OPTIONS) See Constructors in Mail::Message::Head

    The header

See documentation in the base class.
$obj-><B>isDelayedB>() See The header in Mail::Message::Head
$obj-><B>isEmptyB>() See The header in Mail::Message::Head
$obj-><B>isModifiedB>() See The header in Mail::Message::Head
$obj-><B>knownNamesB>() See The header in Mail::Message::Head
$obj-><B>messageB>([MESSAGE]) See The header in Mail::Message::Head
$obj-><B>modifiedB>([BOOLEAN]) See The header in Mail::Message::Head
$obj-><B>orderedFieldsB>() See The header in Mail::Message::Head

    Access to the header

See documentation in the base class.
$obj-><B>countB>(NAME) Count the number of fields with this NAME. If the NAME cannot be found, the full header get loaded. In case we find any NAME field, it is decided we know all of them, and loading is not needed.
$obj-><B>getB>(NAME [,INDEX]) Get the data which is related to the field with the NAME. The case of the characters in NAME does not matter. When a NAME is used which is not known yet, realization will take place.
$obj-><B>studyB>(NAME [,INDEX]) See Access to the header in Mail::Message::Head

    About the body

See documentation in the base class.
$obj-><B>guessBodySizeB>() The body size is defined in the Content-Length field. However, this field may not be known. In that case, a guess is made based on the known Lines field. When also that field is not known yet, undef is returned.
$obj-><B>isMultipartB>() See About the body in Mail::Message::Head

    Internals

See documentation in the base class.
$obj-><B>addNoRealizeB>(FIELD) See Internals in Mail::Message::Head
$obj-><B>addOrderedFieldsB>(FIELDS) See Internals in Mail::Message::Head
$obj-><B>fileLocationB>() See Internals in Mail::Message::Head
$obj-><B>loadB>() See Internals in Mail::Message::Head
$obj-><B>moveLocationB>(DISTANCE) See Internals in Mail::Message::Head
$obj-><B>readB>(PARSER) See Internals in Mail::Message::Head
$obj-><B>setNoRealizeB>(FIELD) See Internals in Mail::Message::Head

    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::Message::Head::Subset-><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::Message::Head::Subset-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Head::Subset-><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

DETAILS

See documentation in the base class.

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::MESSAGE::HEAD::SUBSET (3) 2013-08-19

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