--- name: "Mail::Message::Replace::MailHeader" section: "3pm" platform: "linux" package: "perl-mail-message" version: "4.05-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/Mail::Message::Replace::MailHeader" --- # Mail::Message::Replace::MailHeader(3pm) fake Mail::Header ## NAME Mail::Message::Replace::MailHeader - fake Mail::Header ## INHERITANCE ``` Mail::Message::Replace::MailHeader is a Mail::Message::Head::Complete is a Mail::Message::Head is a Mail::Reporter ``` ## SYNOPSIS ``` # 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. ``` ## DESCRIPTION This module is a wrapper around a Mail::Message::Head::Complete, which simulates a 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 **fold\_length()**, **header\_hashref()**. Extends "DESCRIPTION" in Mail::Message::Head::Complete. ## OVERLOADED Extends "OVERLOADED" in Mail::Message::Head::Complete. - overload: **""** stringifaction Inherited, see "OVERLOADED" in Mail::Message::Head - overload: **bool** true/false Inherited, see "OVERLOADED" in Mail::Message::Head ## METHODS Extends "METHODS" in Mail::Message::Head::Complete. ### Constructors Extends "Constructors" in Mail::Message::Head::Complete. - $class-\>**build**( \[PAIR\|$field\], ... ) Inherited, see "Constructors" in Mail::Message::Head::Complete - $obj-\>**clone**( \[@names\|ARRAY\|Regexps\] ) Inherited, see "Constructors" in Mail::Message::Head::Complete - $class-\>**new**( \[$arg\], %options ) The `$arg` is an array with header lines. Improves base, see "Constructors" in Mail::Message::Head ``` -Option --Defined in --Default FoldLength 79 MailFrom 'KEEP' Modify false field_type Mail::Message::Head Mail::Message::Field::Fast message Mail::Message::Head undef modified Mail::Message::Head false ``` - FoldLength =\> $octets - MailFrom =\> 'IGNORE'\|'ERROR'\|'COERCE'\|'KEEP' How to handle the `"From "` lines. See **mail\_from()**. - Modify =\> BOOLEAN Reformat all header lines when they come in: change the folding. - field\_type =\> CLASS - message =\> $message - modified =\> BOOLEAN ### Attributes Extends "Attributes" in Mail::Message::Head::Complete. ### The header Extends "The header" in Mail::Message::Head::Complete. - $obj-\>**isDelayed**() Inherited, see "The header" in Mail::Message::Head - $obj-\>**isEmpty**() Inherited, see "The header" in Mail::Message::Head - $obj-\>**isModified**() Inherited, see "The header" in Mail::Message::Head - $obj-\>**knownNames**() Inherited, see "The header" in Mail::Message::Head - $obj-\>**message**( \[$message\] ) Inherited, see "The header" in Mail::Message::Head - $obj-\>**modified**( \[BOOLEAN\] ) Inherited, see "The header" in Mail::Message::Head - $obj-\>**nrLines**() Inherited, see "The header" in Mail::Message::Head::Complete - $obj-\>**orderedFields**() Inherited, see "The header" in Mail::Message::Head - $obj-\>**size**() Inherited, see "The header" in Mail::Message::Head::Complete - $obj-\>**wrap**($integer) Inherited, see "The header" in Mail::Message::Head::Complete ### Access to the header Extends "Access to the header" in Mail::Message::Head::Complete. - $obj-\>**add**( $line, \[$index\] ) Add a header line, which simply calls `Mail::Message::Head::add()` on the header for the specified `$line`. The `$index` is ignored, the unfolded body of the field is returned. Improves base, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**addListGroup**($object) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**addResentGroup**($resent\_group\|$data) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**addSpamGroup**($object) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**count**($name) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**delete**( $tag, \[$index\] ) Delete the fields with the specified `$tag`. The deleted fields are returned. If no index is given, then all are removed. Improves base, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**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. Improves base, see "Access to the header" in Mail::Message::Head - $obj-\>**grepNames**( \[@names\|ARRAY\|Regexps\] ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**listGroup**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**names**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**print**( \[$fh\] ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**printSelected**($fh, \, ...) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**printUndisclosed**( \[$fh\] ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeContentInfo**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeField**($field) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeFields**( \, ... ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeFieldsExcept**( \, ... ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeListGroup**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeResentGroups**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**removeSpamGroups**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**replace**( $tag, $line, \[$index\] ) Replace the field named `$tag`. from place `$index` (by default the first) by the `$line`. When `$tag` is `"undef"`, it will be extracted from the `$line` first. This calls **Mail::Message::Head::Complete::reset()** on the message's head. - $obj-\>**resentGroups**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**reset**($name, @fields) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**set**( $field \| $line \| \<$name, $body, \[$attrs\]\> ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**spamDetected**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**spamGroups**( \[$names\] ) Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**string**() Inherited, see "Access to the header" in Mail::Message::Head::Complete - $obj-\>**study**( $name, \[$index\] ) Inherited, see "Access to the header" in Mail::Message::Head ### About the body Extends "About the body" in Mail::Message::Head::Complete. - $obj-\>**guessBodySize**() Inherited, see "About the body" in Mail::Message::Head - $obj-\>**guessTimeStamp**() Inherited, see "About the body" in Mail::Message::Head::Complete - $obj-\>**isMultipart**() Inherited, see "About the body" in Mail::Message::Head - $obj-\>**recvstamp**() Inherited, see "About the body" in Mail::Message::Head::Complete - $obj-\>**timestamp**() Inherited, see "About the body" in Mail::Message::Head::Complete ### Internals Extends "Internals" in Mail::Message::Head::Complete. - $obj-\>**addNoRealize**($field) Inherited, see "Internals" in Mail::Message::Head - $obj-\>**addOrderedFields**($fields) Inherited, see "Internals" in Mail::Message::Head - $obj-\>**createFromLine**() Inherited, see "Internals" in Mail::Message::Head::Complete - $obj-\>**createMessageId**() Inherited, see "Internals" in Mail::Message::Head::Complete - $obj-\>**fileLocation**() Inherited, see "Internals" in Mail::Message::Head - $obj-\>**load**() Inherited, see "Internals" in Mail::Message::Head - $any-\>**messageIdPrefix**( \[$prefix, \[$hostname\]\|CODE\] ) Inherited, see "Internals" in Mail::Message::Head::Complete - $obj-\>**moveLocation**($distance) Inherited, see "Internals" in Mail::Message::Head - $obj-\>**setNoRealize**($field) Inherited, see "Internals" in Mail::Message::Head ### Error handling Extends "Error handling" in Mail::Message::Head::Complete. - $obj-\>**AUTOLOAD**() Inherited, see "Error handling" in Mail::Reporter - $obj-\>**notImplemented**() Inherited, see "Error handling" in Mail::Reporter ### Cleanup Extends "Cleanup" in Mail::Message::Head::Complete. - $obj-\>**DESTROY**() Inherited, see "Cleanup" in Mail::Reporter ### Access to the header ### Simulating Mail::Header - $obj-\>**as\_string**() Returns the whole header as one big scalar. Calls **Mail::Message::Head::Complete::string()**. - $obj-\>**cleanup**() Cleanup memory usage. Not needed here. - $obj-\>**combine**( $tag, \[$with\] ) I do not see any valid reason for this command, so did not implement it. - $obj-\>**dup**() Duplicate the header, which is simply **clone()**. - $obj-\>**empty**() Clean-out the whole hash. Better not use this (simply create another header object), although it should work. - $obj-\>**exists**() Returns whether there are any fields. - $obj-\>**extract**(\\@lines) Extract (and remove) header fields from the array. - $obj-\>**fold**( \[$length\] ) Refold all fields in the header, to `$length` or whatever **fold\_length()** returns. - $obj-\>**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. - $obj-\>**header**( \[ARRAY\] ) Extract the fields from the `"ARRAY"`, if specified, and then fold the fields. Returned is an array with all fields, produced via **orderedFields()**. - $obj-\>**header\_hashref**(HASH) If you are using this method, you must be stupid... anyway: I do not want to support it for now: use **add()** and friends. - $obj-\>**mail\_from**( \['IGNORE'\|'ERROR'\|'COERCE'\|'KEEP'\] ) What to do when a header line in the form \`From ' is encountered. Valid values are `"IGNORE"` - ignore and discard the header, `"ERROR"` - invoke an error (die), `"COERCE"` - rename them as Mail-From and `"KEEP"` - keep them. - $obj-\>**modify**( \[BOOLEAN\] ) Refold the headers when they are added. - $obj-\>**read**($file) Read the header from the `$file`. Improves base, see "Internals" in Mail::Message::Head - $obj-\>**tags**() Returns all the names of fields, implemented by **Mail::Message::Head::Complete::names()**. - $obj-\>**unfold**( \[$tag\] ) Remove the folding for all instances of `$tag`, or all fields at once. ### The nasty bits - $any-\>**isa**($class) Of course, the `isa()` class inheritance check should not see our nasty trick. ## DETAILS Extends "DETAILS" in Mail::Message::Head::Complete. ## DIAGNOSTICS - Error: bad Mail-From choice: '$pick'. Cast by `mail_from()` - Warning: cannot remove field $name from header: not found. You ask to remove a field which is not known in the header. Using **delete()**, **reset()**, or **set()** to do the job will not result in warnings: those methods check the existence of the field first. Cast by `removeField()` - Error: class $package does not implement method $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. Cast by `notImplemented()` - Warning: field objects have an implied name ($name) Cast by `build()` ## SEE ALSO This module is part of Mail-Message version 4.05, built on April 10, 2026. Website: *http://perl.overmeer.net/mailbox/* ## LICENSE For contributors see file ChangeLog. This software is copyright (c) 2001-2026 by Mark Overmeer. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.