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 Mail::Message::Head::Subset $subset = ...;
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 sub‐
25       jects of all messages are often wanted, but waiting for a thousand mes‐
26       sages 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
36           See "OVERLOADED" in Mail::Message::Head
37
38       overload: bool
39
40           See "OVERLOADED" in Mail::Message::Head
41

METHODS

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

DETAILS

DIAGNOSTICS

213       Error: Package $package does not implement $method.
214
215       Fatal error: the specific package (or one of its superclasses) does not
216       implement this method where it should. This message means that some
217       other related classes do implement this method however the class at
218       hand does not.  Probably you should investigate this and probably
219       inform the author of the package.
220

LICENSE

226       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
227       ChangeLog.
228
229       This program is free software; you can redistribute it and/or modify it
230       under the same terms as Perl itself.  See
231       http://www.perl.com/perl/misc/Artistic.html
232
233
234
235perl v5.8.8                       2007-03-25    Mail::Message::Head::Subset(3)