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
33       Extends "DESCRIPTION" in Mail::Message::Head.
34

OVERLOADED

36       Extends "OVERLOADED" in Mail::Message::Head.
37
38       overload: ""
39           Inherited, see "OVERLOADED" in Mail::Message::Head
40
41       overload: bool
42           Inherited, see "OVERLOADED" in Mail::Message::Head
43

METHODS

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

DETAILS

184       Extends "DETAILS" in Mail::Message::Head.
185

DIAGNOSTICS

187       Error: Package $package does not implement $method.
188           Fatal error: the specific package (or one of its superclasses) does
189           not implement this method where it should. This message means that
190           some other related classes do implement this method however the
191           class at hand does not.  Probably you should investigate this and
192           probably inform the author of the package.
193

LICENSE

199       Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
200       ChangeLog.
201
202       This program is free software; you can redistribute it and/or modify it
203       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
204
205
206
207perl v5.30.1                      2020-01-30    Mail::Message::Head::Subset(3)