/ 
Mail-Box-2.079
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Replace::MailHeader

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

!!! 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.

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().

OVERLOADED

overload: ""

overload: bool

METHODS

Constructors

$obj->build([PAIR|FIELD]-LIST)

$obj->clone([NAMES|ARRAY-OF-NAMES|REGEXS])

Mail::Message::Replace::MailHeader->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'

    . FoldLength => INTEGER

    . MailFrom => 'IGNORE'|'ERROR'|'COERCE'|'KEEP'

    . Modify => BOOLEAN

      Reformat all header lines when they come in: change the folding.

    . field_type => CLASS

    . log => LEVEL

    . message => MESSAGE

    . modified => BOOLEAN

    . trace => LEVEL

The header

$obj->isDelayed

$obj->isEmpty

$obj->isModified

$obj->knownNames

$obj->message([MESSAGE])

$obj->modified([BOOLEAN])

$obj->nrLines

$obj->orderedFields

$obj->size

$obj->wrap(INTEGER)

Access to the header

$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.

$obj->addListGroup(OBJECT)

$obj->addResentGroup(RESENT-GROUP|DATA)

$obj->addSpamGroup(OBJECT)

$obj->count(NAME)

$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.

$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.

$obj->grepNames([NAMES|ARRAY-OF-NAMES|REGEXS])

$obj->listGroup

$obj->names

$obj->print([FILEHANDLE])

$obj->printSelected(FILEHANDLE, (STRING|REGEXP)s)

$obj->printUndisclosed([FILEHANDLE])

$obj->removeContentInfo

$obj->removeField(FIELD)

$obj->removeFields(STRING|REGEXP, [STRING|REGEXP, ...])

$obj->removeFieldsExcept(STRING|REGEXP, [STRING|REGEXP, ...])

$obj->removeListGroup

$obj->removeResentGroups

$obj->removeSpamGroups

$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

$obj->reset(NAME, FIELDS)

$obj->set(FIELD | LINE | (NAME, BODY [,ATTRS]))

$obj->spamDetected

$obj->spamGroups([NAMES])

$obj->string

$obj->study(NAME [,INDEX])

About the body

$obj->guessBodySize

$obj->guessTimeStamp

$obj->isMultipart

$obj->recvstamp

$obj->timestamp

Internals

$obj->addNoRealize(FIELD)

$obj->addOrderedFields(FIELDS)

$obj->createFromLine

$obj->createMessageId

$obj->fileLocation

$obj->load

$obj->messageIdPrefix([PREFIX, [HOSTNAME]|CODE])

Mail::Message::Replace::MailHeader->messageIdPrefix([PREFIX, [HOSTNAME]|CODE])

$obj->moveLocation(DISTANCE)

$obj->setNoRealize(FIELD)

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Replace::MailHeader->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Replace::MailHeader->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Replace::MailHeader->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

Access to the header

Simulating Mail::Header

$obj->as_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(ARRAY)

    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 (call 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.

$obj->tags

$obj->unfold([TAG])

    Remove the folding for all instances of TAG, or all fields at once.

The nasty bits

$obj->isa(CLASS)

Mail::Message::Replace::MailHeader->isa(CLASS)

    Of course, the isa() class inheritance check should not see our nasty trick.

DETAILS

DIAGNOSTICS

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.

Warning: Field objects have an implied name ($name)

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.079, built on November 28, 2007. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2007 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 http://www.perl.com/perl/misc/Artistic.html