/usr/share/perl5/Mail/Message/Replace/MailHeader.pod is in libmail-message-perl 3.006-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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 | =encoding utf8
=head1 NAME
Mail::Message::Replace::MailHeader - fake Mail::Header
=head1 INHERITANCE
Mail::Message::Replace::MailHeader
is a Mail::Message::Head::Complete
is a Mail::Message::Head
is a Mail::Reporter
=head1 SYNOPSIS
!!! ALPHA CODE !!!
# change
use Mail::Internet;
use Mail::Header;
# into
use Mail::Message::Replace::MailInternet;
# in existing code, and the code should still work, but
# with the Mail::Message features.
=head1 DESCRIPTION
This module is a wrapper around a L<Mail::Message::Head::Complete|Mail::Message::Head::Complete>,
which simulates a L<Mail::Header> object. The name-space of that module
is hijacked and many methods are added.
Most methods will work without any change, but you should test your
software again. Small changes have been made to L<fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">,
L<header_hashref()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">.
Extends L<"DESCRIPTION" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DESCRIPTION">.
=head1 OVERLOADED
Extends L<"OVERLOADED" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"OVERLOADED">.
=over 4
=item overload: B<"">
Inherited, see L<Mail::Message::Head/"OVERLOADED">
=item overload: B<bool>
Inherited, see L<Mail::Message::Head/"OVERLOADED">
=back
=head1 METHODS
Extends L<"METHODS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Constructors">.
=over 4
=item Mail::Message::Replace::MailHeader-E<gt>B<build>( [PAIR|$field], ... )
Inherited, see L<Mail::Message::Head::Complete/"Constructors">
=item $obj-E<gt>B<clone>( [@names|ARRAY|Regexps] )
Inherited, see L<Mail::Message::Head::Complete/"Constructors">
=item Mail::Message::Replace::MailHeader-E<gt>B<new>( [$arg], %options )
The $arg is an array with header lines.
-Option --Defined in --Default
FoldLength 79
MailFrom 'KEEP'
Modify <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 FoldLength => INTEGER
=item MailFrom => 'IGNORE'|'ERROR'|'COERCE'|'KEEP'
How to handle the C<From > lines. See L<mail_from()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">.
=item Modify => BOOLEAN
Reformat all header lines when they come in: change the folding.
=item field_type => CLASS
=item log => LEVEL
=item message => MESSAGE
=item modified => BOOLEAN
=item trace => LEVEL
=back
=back
=head2 The header
Extends L<"The header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"The header">.
=over 4
=item $obj-E<gt>B<isDelayed>()
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isEmpty>()
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<isModified>()
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<knownNames>()
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<message>( [$message] )
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<modified>( [BOOLEAN] )
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<nrLines>()
Inherited, see L<Mail::Message::Head::Complete/"The header">
=item $obj-E<gt>B<orderedFields>()
Inherited, see L<Mail::Message::Head/"The header">
=item $obj-E<gt>B<size>()
Inherited, see L<Mail::Message::Head::Complete/"The header">
=item $obj-E<gt>B<wrap>($integer)
Inherited, see L<Mail::Message::Head::Complete/"The header">
=back
=head2 Access to the header
Extends L<"Access to the header" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Access to the header">.
=over 4
=item $obj-E<gt>B<add>( $line, [$index] )
Add a header line, which simply calls C<Mail::Message::Head::add()> on
the header for the specified $line. The $index is ignored, the unfolded
body of the field is returned.
=item $obj-E<gt>B<addListGroup>($object)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<addResentGroup>($resent_group|$data)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<addSpamGroup>($object)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<count>($name)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<delete>( $tag, [$index] )
Delete the fields with the specified $tag. The deleted fields are
returned. If no index is given, then all are removed.
=item $obj-E<gt>B<get>( $name, [$index] )
Get all the header fields with the specified $name. In scalar context,
only the first fitting $name is returned. Even when only one $name is
specified, multiple lines may be returned in list context: some fields
appear more than once in a header.
=item $obj-E<gt>B<grepNames>( [@names|ARRAY|Regexps] )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<listGroup>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<names>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<print>( [$fh] )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<printSelected>($fh, <STRING|Regexp>, ...)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<printUndisclosed>( [$fh] )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeContentInfo>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeField>($field)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeFields>( <STRING|Regexp>, ... )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeFieldsExcept>( <STRING|Regexp>, ... )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeListGroup>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeResentGroups>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<removeSpamGroups>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<replace>( $tag, $line, [$index] )
Replace the field named $tag. from place $index (by default the first) by
the $line. When $tag is C<undef>, it will be extracted from the $line first.
This calls L<Mail::Message::Head::Complete::reset()|Mail::Message::Head::Complete/"Access to the header"> on the message's head.
=item $obj-E<gt>B<resentGroups>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<reset>($name, @fields)
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<set>( $field | $line | <$name, $body, [$attrs]> )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<spamDetected>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<spamGroups>( [$names] )
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<string>()
Inherited, see L<Mail::Message::Head::Complete/"Access to the header">
=item $obj-E<gt>B<study>( $name, [$index] )
Inherited, see L<Mail::Message::Head/"Access to the header">
=back
=head2 About the body
Extends L<"About the body" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"About the body">.
=over 4
=item $obj-E<gt>B<guessBodySize>()
Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<guessTimeStamp>()
Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<isMultipart>()
Inherited, see L<Mail::Message::Head/"About the body">
=item $obj-E<gt>B<recvstamp>()
Inherited, see L<Mail::Message::Head::Complete/"About the body">
=item $obj-E<gt>B<timestamp>()
Inherited, see L<Mail::Message::Head::Complete/"About the body">
=back
=head2 Internals
Extends L<"Internals" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Internals">.
=over 4
=item $obj-E<gt>B<addNoRealize>($field)
Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<addOrderedFields>($fields)
Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<createFromLine>()
Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<createMessageId>()
Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<fileLocation>()
Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<load>()
Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
=item Mail::Message::Replace::MailHeader-E<gt>B<messageIdPrefix>( [$prefix, [$hostname]|CODE] )
Inherited, see L<Mail::Message::Head::Complete/"Internals">
=item $obj-E<gt>B<moveLocation>($distance)
Inherited, see L<Mail::Message::Head/"Internals">
=item $obj-E<gt>B<setNoRealize>($field)
Inherited, see L<Mail::Message::Head/"Internals">
=back
=head2 Error handling
Extends L<"Error handling" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>($object)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
=item Mail::Message::Replace::MailHeader-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>( [$level, [$strings]] )
=item Mail::Message::Replace::MailHeader-E<gt>B<log>( [$level, [$strings]] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>($level)
=item Mail::Message::Replace::MailHeader-E<gt>B<logPriority>($level)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head2 Access to the header
=head2 Simulating Mail::Header
=over 4
=item $obj-E<gt>B<as_string>()
Returns the whole header as one big scalar.
Calls L<Mail::Message::Head::Complete::string()|Mail::Message::Head::Complete/"Access to the header">.
=item $obj-E<gt>B<cleanup>()
Cleanup memory usage. Not needed here.
=item $obj-E<gt>B<combine>( $tag, [$with] )
I do not see any valid reason for this command, so did not implement it.
=item $obj-E<gt>B<dup>()
Duplicate the header, which is simply L<clone()|Mail::Message::Head::Complete/"Constructors">.
=item $obj-E<gt>B<empty>()
Clean-out the whole hash. Better not use this (simply create another
header object), although it should work.
=item $obj-E<gt>B<exists>()
Returns whether there are any fields.
=item $obj-E<gt>B<extract>(ARRAY)
Extract (and remove) header fields from the array.
=item $obj-E<gt>B<fold>( [$length] )
Refold all fields in the header, to $length or whatever L<fold_length()|Mail::Message::Replace::MailHeader/"Simulating Mail::Header">
returns.
=item $obj-E<gt>B<fold_length>( [[$tag], $length] )
Returns the line wrap, optionally after setting it to $length. The
old value is returned. The $tag argument is ignored, because it is
silly to have different lines fold in different ways. This method
cannot be called statically anymore.
=item $obj-E<gt>B<header>( [ARRAY] )
Extract the fields from the ARRAY, if specified, and then fold the fields.
Returned is an array with all fields, produced via L<orderedFields()|Mail::Message::Head/"The header">.
=item $obj-E<gt>B<header_hashref>(HASH)
If you are using this method, you must be stupid... anyway: I do not want to
support it for now: use L<add()|Mail::Message::Replace::MailHeader/"Access to the header"> and friends.
=item $obj-E<gt>B<mail_from>( ['IGNORE'|'ERROR'|'COERCE'|'KEEP'] )
What to do when a header line in the form `From ' is encountered. Valid
values are C<IGNORE> - ignore and discard the header, C<ERROR> - invoke
an error (call die), C<COERCE> - rename them as Mail-From and C<KEEP>
- keep them.
=item $obj-E<gt>B<modify>( [BOOLEAN] )
Refold the headers when they are added.
=item $obj-E<gt>B<read>($file)
Read the header from the $file.
=item $obj-E<gt>B<tags>()
Returns all the names of fields, implemented by
L<Mail::Message::Head::Complete::names()|Mail::Message::Head::Complete/"Access to the header">.
=item $obj-E<gt>B<unfold>( [$tag] )
Remove the folding for all instances of $tag, or all fields at once.
=back
=head2 The nasty bits
=over 4
=item $obj-E<gt>B<isa>($class)
=item Mail::Message::Replace::MailHeader-E<gt>B<isa>($class)
Of course, the C<isa()> class inheritance check should not see our
nasty trick.
=back
=head1 DETAILS
Extends L<"DETAILS" in Mail::Message::Head::Complete|Mail::Message::Head::Complete/"DETAILS">.
=head1 DIAGNOSTICS
=over 4
=item Warning: Cannot remove field $name from header: not found.
You ask to remove a field which is not known in the header. Using
L<delete()|Mail::Message::Replace::MailHeader/"Access to the header">, L<reset()|Mail::Message::Head::Complete/"Access to the header">, or L<set()|Mail::Message::Head::Complete/"Access to the header"> to do the job will not result
in warnings: those methods check the existence of the field first.
=item Warning: Field objects have an implied name ($name)
=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-Message distribution version 3.006,
built on January 24, 2018. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
Copyrights 2001-2018 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://dev.perl.org/licenses/>
|