Mail::Box::IMAP4::Head(3pm)

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

SYNOPSIS

DESCRIPTION

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

OVERLOADED

25       overload: ""
26
27           See "OVERLOADED" in Mail::Message::Head
28
29       overload: bool
30
31           See "OVERLOADED" in Mail::Message::Head
32

METHODS

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

DETAILS

DIAGNOSTICS

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

LICENSE

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