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 little
16       data is retrieved 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
24       Extends "DESCRIPTION" in Mail::Message::Head.
25

OVERLOADED

27       Extends "OVERLOADED" in Mail::Message::Head.
28
29       overload: ""
30           Inherited, see "OVERLOADED" in Mail::Message::Head
31
32       overload: bool
33           Inherited, see "OVERLOADED" in Mail::Message::Head
34

METHODS

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

DETAILS

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

DIAGNOSTICS

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

LICENSE

198       Copyrights 2001-2023 by [Mark Overmeer]. For other contributors see
199       ChangeLog.
200
201       This program is free software; you can redistribute it and/or modify it
202       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
203
204
205
206perl v5.38.0                      2023-08-21         Mail::Box::IMAP4::Head(3)