/usr/share/perl5/Mail/Box/IMAP4/Head.pod is in libmail-box-perl 2.110-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | =encoding utf8
=head1 NAME
Mail::Box::IMAP4::Head - header fields related IMAP interface
=head1 INHERITANCE
Mail::Box::IMAP4::Head
is a Mail::Message::Head
is a Mail::Reporter
=head1 SYNOPSIS
=head1 DESCRIPTION
This class implements a pure IMAP4 protocol interface, where as little
data is retrieved from the header as possible. This may look nice
to you, but is not sufficient for many tasks. For instance, you cannot
removed or modify fields this way.
Change L<Mail::Box::IMAP4::new(cache_head)|Mail::Box::IMAP4/"METHODS"> to C<YES> or C<DELAY>, to
get a message header which is capable of performing all possible
games with headers. On the other hand: the other settings are not
100% safe...
See L<documentation in the base class|Mail::Message::Head/"DESCRIPTION">.
=head1 OVERLOADED
See L<documentation in the base class|Mail::Message::Head/"OVERLOADED">.
=over 4
=item overload: B<"">()
See L<Mail::Message::Head/"OVERLOADED">
=item overload: B<bool>()
See L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
See L<documentation in the base class|Mail::Message::Head/"METHODS">.
=head2 Constructors
See L<documentation in the base class|Mail::Message::Head/"Constructors">.
=over 4
=item Mail::Box::IMAP4::Head-E<gt>B<build>([PAIR|FIELD]-LIST)
See L<Mail::Message::Head/"Constructors">
=item Mail::Box::IMAP4::Head-E<gt>B<new>(OPTIONS)
-Option --Defined in --Default
cache_fields false
field_type Mail::Message::Head Mail::Message::Field::Fast
log Mail::Reporter 'WARNINGS'
message Mail::Message::Head undef
modified Mail::Message::Head <false>
trace Mail::Reporter 'WARNINGS'
=over 2
=item cache_fields => BOOLEAN
This is only a read-cache on fields, because this kind of header does
not allow writing of fields. See L<Mail::Box::IMAP4::new(cache_head)|Mail::Box::IMAP4/"METHODS">,
this value is set to C<false> for C<NO> and C<true> for C<PARTIAL>..
=item field_type => CLASS
=item log => LEVEL
=item message => MESSAGE
=item modified => BOOLEAN
=item trace => LEVEL
=back
=back
=head2 The header
See L<documentation in the base class|Mail::Message::Head/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<message>([MESSAGE])
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<modified>([BOOLEAN])
See L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<orderedFields>()
See L<Mail::Message::Head/"The header">
=back
=head2 Access to the header
See L<documentation in the base class|Mail::Message::Head/"Access to the header">.
=over 4
=item $obj-E<gt>B<get>(NAME [,INDEX])
Get the information about the header line NAME. Realization will
take place.
=item $obj-E<gt>B<study>(NAME [,INDEX])
See L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
See L<documentation in the base class|Mail::Message::Head/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
See L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<isMultipart>()
See L<Mail::Message::Head/"About the body">
=back
=head2 Internals
See L<documentation in the base class|Mail::Message::Head/"Internals">.
=over 4
=item $obj-E<gt>B<addNoRealize>(FIELD)
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<addOrderedFields>(FIELDS)
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<fileLocation>()
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<moveLocation>(DISTANCE)
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<read>(PARSER)
See L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<setNoRealize>(FIELD)
See L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
See L<documentation in the base class|Mail::Message::Head/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Box::IMAP4::Head-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Box::IMAP4::Head-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Box::IMAP4::Head-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
See L<documentation in the base class|Mail::Message::Head/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
See L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
See L<documentation in the base class|Mail::Message::Head/"DETAILS">.
=head1 DIAGNOSTICS
=over 4
=item Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not. Probably you should investigate this and probably inform the author
of the package.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.110,
built on January 05, 2014. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|