Mail::Message::Head::Subset(3pm)

1Mail::Message::Head::SuUbsseert(C3o)ntributed Perl DocumMeanitla:t:iMoenssage::Head::Subset(3)
2
3
4

NAME

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

INHERITANCE

9        Mail::Message::Head::Subset realizes a Mail::Message::Head::Complete
10
11        Mail::Message::Head::Subset
12          is a Mail::Message::Head
13          is a Mail::Reporter
14

SYNOPSIS

16        my $subset = Mail::Message::Head::Subset->new(...)
17        $subset->isa('Mail::Message::Head')  # true
18        $subset->guessBodySize               # integer or undef
19        $subset->isDelayed                   # true
20

DESCRIPTION

22       Some types of folders contain an index file which lists a few lines of
23       information per messages.  Especially when it is costly to read header
24       lines, the index speeds-up access considerably.  For instance, the
25       subjects of all messages are often wanted, but waiting for a thousand
26       messages of the folder to be read may imply a thousand network reads
27       (IMAP) or file openings (MH)
28
29       When you access header fields which are not in the header subset, the
30       whole header has to be parsed (which may consume considerable time,
31       depending on the type of folder).
32

OVERLOADED

34       overload: ""
35           See "OVERLOADED" in Mail::Message::Head
36
37       overload: bool
38           See "OVERLOADED" in Mail::Message::Head
39

METHODS

41   Constructors
42       Mail::Message::Head::Subset->build([PAIR|FIELD]-LIST)
43           See "Constructors" in Mail::Message::Head
44
45       Mail::Message::Head::Subset->new(OPTIONS)
46           See "Constructors" in Mail::Message::Head
47
48   The header
49       $obj->isDelayed
50           See "The header" in Mail::Message::Head
51
52       $obj->isEmpty
53           See "The header" in Mail::Message::Head
54
55       $obj->isModified
56           See "The header" in Mail::Message::Head
57
58       $obj->knownNames
59           See "The header" in Mail::Message::Head
60
61       $obj->message([MESSAGE])
62           See "The header" in Mail::Message::Head
63
64       $obj->modified([BOOLEAN])
65           See "The header" in Mail::Message::Head
66
67       $obj->orderedFields
68           See "The header" in Mail::Message::Head
69
70   Access to the header
71       $obj->count(NAME)
72           Count the number of fields with this NAME.  If the NAME cannot be
73           found, the full header get loaded.  In case we find any NAME field,
74           it is decided we know all of them, and loading is not needed.
75
76       $obj->get(NAME [,INDEX])
77           Get the data which is related to the field with the NAME.  The case
78           of the characters in NAME does not matter.  When a NAME is used
79           which is not known yet, realization will take place.
80
81       $obj->study(NAME [,INDEX])
82           See "Access to the header" in Mail::Message::Head
83
84   About the body
85       $obj->guessBodySize
86           The body size is defined in the "Content-Length" field.  However,
87           this field may not be known.  In that case, a guess is made based
88           on the known "Lines" field.  When also that field is not known yet,
89           "undef" is returned.
90
91       $obj->isMultipart
92           See "About the body" in Mail::Message::Head
93
94   Internals
95       $obj->addNoRealize(FIELD)
96           See "Internals" in Mail::Message::Head
97
98       $obj->addOrderedFields(FIELDS)
99           See "Internals" in Mail::Message::Head
100
101       $obj->fileLocation
102           See "Internals" in Mail::Message::Head
103
104       $obj->load
105           See "Internals" in Mail::Message::Head
106
107       $obj->moveLocation(DISTANCE)
108           See "Internals" in Mail::Message::Head
109
110       $obj->read(PARSER)
111           See "Internals" in Mail::Message::Head
112
113       $obj->setNoRealize(FIELD)
114           See "Internals" in Mail::Message::Head
115
116   Error handling
117       $obj->AUTOLOAD
118           See "Error handling" in Mail::Reporter
119
120       $obj->addReport(OBJECT)
121           See "Error handling" in Mail::Reporter
122
123       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
124           Mail::Message::Head::Subset->defaultTrace([LEVEL]|[LOGLEVEL,
125           TRACELEVEL]|[LEVEL, CALLBACK])
126
127           See "Error handling" in Mail::Reporter
128
129       $obj->errors
130           See "Error handling" in Mail::Reporter
131
132       $obj->log([LEVEL [,STRINGS]])
133           Mail::Message::Head::Subset->log([LEVEL [,STRINGS]])
134
135           See "Error handling" in Mail::Reporter
136
137       $obj->logPriority(LEVEL)
138           Mail::Message::Head::Subset->logPriority(LEVEL)
139
140           See "Error handling" in Mail::Reporter
141
142       $obj->logSettings
143           See "Error handling" in Mail::Reporter
144
145       $obj->notImplemented
146           See "Error handling" in Mail::Reporter
147
148       $obj->report([LEVEL])
149           See "Error handling" in Mail::Reporter
150
151       $obj->reportAll([LEVEL])
152           See "Error handling" in Mail::Reporter
153
154       $obj->trace([LEVEL])
155           See "Error handling" in Mail::Reporter
156
157       $obj->warnings
158           See "Error handling" in Mail::Reporter
159
160   Cleanup
161       $obj->DESTROY
162           See "Cleanup" in Mail::Reporter
163
164       $obj->inGlobalDestruction
165           See "Cleanup" in Mail::Reporter
166

DIAGNOSTICS

168       Error: Package $package does not implement $method.
169           Fatal error: the specific package (or one of its superclasses) does
170           not implement this method where it should. This message means that
171           some other related classes do implement this method however the
172           class at hand does not.  Probably you should investigate this and
173           probably inform the author of the package.
174

LICENSE

180       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
181       ChangeLog.
182
183       This program is free software; you can redistribute it and/or modify it
184       under the same terms as Perl itself.  See
185       http://www.perl.com/perl/misc/Artistic.html
186
187
188
189perl v5.12.3                      2011-01-26    Mail::Message::Head::Subset(3)