1Mail::Box::IMAP4::Head(U3s)er Contributed Perl DocumentatMiaoinl::Box::IMAP4::Head(3)
2
3
4

NAME

6       Mail::Box::IMAP4::Head - header fields related IMAP interface
7

INHERITANCE

9        Mail::Box::IMAP4::Head
10          is a Mail::Message::Head
11          is a Mail::Reporter
12

DESCRIPTION

14       This class implements a pure IMAP4 protocol interface, where as little
15       data is retreived from the header as possible.  This may look nice to
16       you, but is not sufficient for many tasks.  For instance, you cannot
17       removed or modify fields this way.
18
19       Change Mail::Box::IMAP4::new(cache_head) to "YES" or "DELAY", to get a
20       message header which is capable of performing all possible games with
21       headers.  On the other hand: the other settings are not 100% safe...
22

OVERLOADED

24       overload: ""
25           See "OVERLOADED" in Mail::Message::Head
26
27       overload: bool
28           See "OVERLOADED" in Mail::Message::Head
29

METHODS

31   Constructors
32       Mail::Box::IMAP4::Head->build([PAIR|FIELD]-LIST)
33           See "Constructors" in Mail::Message::Head
34
35       Mail::Box::IMAP4::Head->new(OPTIONS)
36            -Option      --Defined in     --Default
37             cache_fields                   false
38             field_type    Mail::Message::Head  Mail::Message::Field::Fast
39             log           Mail::Reporter   'WARNINGS'
40             message       Mail::Message::Head  undef
41             modified      Mail::Message::Head  <false>
42             trace         Mail::Reporter   'WARNINGS'
43
44           cache_fields => BOOLEAN
45             This is only a read-cache on fields, because this kind of header
46             does not allow writing of fields.  See
47             Mail::Box::IMAP4::new(cache_head), this value is set to "false"
48             for "NO" and "true" for "PARTIAL"..
49
50           field_type => CLASS
51           log => LEVEL
52           message => MESSAGE
53           modified => BOOLEAN
54           trace => LEVEL
55
56   The header
57       $obj->isDelayed
58           See "The header" in Mail::Message::Head
59
60       $obj->isEmpty
61           See "The header" in Mail::Message::Head
62
63       $obj->isModified
64           See "The header" in Mail::Message::Head
65
66       $obj->knownNames
67           See "The header" in Mail::Message::Head
68
69       $obj->message([MESSAGE])
70           See "The header" in Mail::Message::Head
71
72       $obj->modified([BOOLEAN])
73           See "The header" in Mail::Message::Head
74
75       $obj->orderedFields
76           See "The header" in Mail::Message::Head
77
78   Access to the header
79       $obj->get(NAME [,INDEX])
80           Get the information about the header line NAME.  Realization will
81           take place.
82
83       $obj->study(NAME [,INDEX])
84           See "Access to the header" in Mail::Message::Head
85
86   About the body
87       $obj->guessBodySize
88           See "About the body" in Mail::Message::Head
89
90       $obj->isMultipart
91           See "About the body" in Mail::Message::Head
92
93   Internals
94       $obj->addNoRealize(FIELD)
95           See "Internals" in Mail::Message::Head
96
97       $obj->addOrderedFields(FIELDS)
98           See "Internals" in Mail::Message::Head
99
100       $obj->fileLocation
101           See "Internals" in Mail::Message::Head
102
103       $obj->load
104           See "Internals" in Mail::Message::Head
105
106       $obj->moveLocation(DISTANCE)
107           See "Internals" in Mail::Message::Head
108
109       $obj->read(PARSER)
110           See "Internals" in Mail::Message::Head
111
112       $obj->setNoRealize(FIELD)
113           See "Internals" in Mail::Message::Head
114
115   Error handling
116       $obj->AUTOLOAD
117           See "Error handling" in Mail::Reporter
118
119       $obj->addReport(OBJECT)
120           See "Error handling" in Mail::Reporter
121
122       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
123           Mail::Box::IMAP4::Head->defaultTrace([LEVEL]|[LOGLEVEL,
124           TRACELEVEL]|[LEVEL, CALLBACK])
125
126           See "Error handling" in Mail::Reporter
127
128       $obj->errors
129           See "Error handling" in Mail::Reporter
130
131       $obj->log([LEVEL [,STRINGS]])
132           Mail::Box::IMAP4::Head->log([LEVEL [,STRINGS]])
133
134           See "Error handling" in Mail::Reporter
135
136       $obj->logPriority(LEVEL)
137           Mail::Box::IMAP4::Head->logPriority(LEVEL)
138
139           See "Error handling" in Mail::Reporter
140
141       $obj->logSettings
142           See "Error handling" in Mail::Reporter
143
144       $obj->notImplemented
145           See "Error handling" in Mail::Reporter
146
147       $obj->report([LEVEL])
148           See "Error handling" in Mail::Reporter
149
150       $obj->reportAll([LEVEL])
151           See "Error handling" in Mail::Reporter
152
153       $obj->trace([LEVEL])
154           See "Error handling" in Mail::Reporter
155
156       $obj->warnings
157           See "Error handling" in Mail::Reporter
158
159   Cleanup
160       $obj->DESTROY
161           See "Cleanup" in Mail::Reporter
162
163       $obj->inGlobalDestruction
164           See "Cleanup" in Mail::Reporter
165

DIAGNOSTICS

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

SEE ALSO

175       This module is part of Mail-Box distribution version 2.097, built on
176       January 26, 2011. Website: http://perl.overmeer.net/mailbox/
177

LICENSE

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