Mail::Message::Replace::MailHeader(3pm) 		User Contributed Perl Documentation		   Mail::Message::Replace::MailHeader(3pm)

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: ""()
	   See "OVERLOADED" in Mail::Message::Head

       overload: bool()
	   See "OVERLOADED" in Mail::Message::Head

METHODS

   Constructors
       $obj->build([PAIR|FIELD]-LIST)
	   See "Constructors" in Mail::Message::Head::Complete

       $obj->clone([NAMES|ARRAY-OF-NAMES|REGEXS])
	   See "Constructors" in Mail::Message::Head::Complete

       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'
	     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
	   log => LEVEL
	   message => MESSAGE
	   modified => BOOLEAN
	   trace => LEVEL

   The header
       $obj->isDelayed()
	   See "The header" in Mail::Message::Head

       $obj->isEmpty()
	   See "The header" in Mail::Message::Head

       $obj->isModified()
	   See "The header" in Mail::Message::Head

       $obj->knownNames()
	   See "The header" in Mail::Message::Head

       $obj->message([MESSAGE])
	   See "The header" in Mail::Message::Head

       $obj->modified([BOOLEAN])
	   See "The header" in Mail::Message::Head

       $obj->nrLines()
	   See "The header" in Mail::Message::Head::Complete

       $obj->orderedFields()
	   See "The header" in Mail::Message::Head

       $obj->size()
	   See "The header" in Mail::Message::Head::Complete

       $obj->wrap(INTEGER)
	   See "The header" in Mail::Message::Head::Complete

   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)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->addResentGroup(RESENT-GROUP|DATA)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->addSpamGroup(OBJECT)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->count(NAME)
	   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.

       $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])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->listGroup()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->names()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->print([FILEHANDLE])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->printSelected(FILEHANDLE, (STRING|REGEXP)s)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->printUndisclosed([FILEHANDLE])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeContentInfo()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeField(FIELD)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeFields(STRING|REGEXP, [STRING|REGEXP, ...])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeFieldsExcept(STRING|REGEXP, [STRING|REGEXP, ...])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeListGroup()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeResentGroups()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->removeSpamGroups()
	   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()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->reset(NAME, FIELDS)
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->set(FIELD | LINE | (NAME, BODY [,ATTRS]))
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->spamDetected()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->spamGroups([NAMES])
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->string()
	   See "Access to the header" in Mail::Message::Head::Complete

       $obj->study(NAME [,INDEX])
	   See "Access to the header" in Mail::Message::Head

   About the body
       $obj->guessBodySize()
	   See "About the body" in Mail::Message::Head

       $obj->guessTimeStamp()
	   See "About the body" in Mail::Message::Head::Complete

       $obj->isMultipart()
	   See "About the body" in Mail::Message::Head

       $obj->recvstamp()
	   See "About the body" in Mail::Message::Head::Complete

       $obj->timestamp()
	   See "About the body" in Mail::Message::Head::Complete

   Internals
       $obj->addNoRealize(FIELD)
	   See "Internals" in Mail::Message::Head

       $obj->addOrderedFields(FIELDS)
	   See "Internals" in Mail::Message::Head

       $obj->createFromLine()
	   See "Internals" in Mail::Message::Head::Complete

       $obj->createMessageId()
	   See "Internals" in Mail::Message::Head::Complete

       $obj->fileLocation()
	   See "Internals" in Mail::Message::Head

       $obj->load()
	   See "Internals" in Mail::Message::Head

       $obj->messageIdPrefix([PREFIX, [HOSTNAME]|CODE])
       Mail::Message::Replace::MailHeader->messageIdPrefix([PREFIX, [HOSTNAME]|CODE])
	   See "Internals" in Mail::Message::Head::Complete

       $obj->moveLocation(DISTANCE)
	   See "Internals" in Mail::Message::Head

       $obj->setNoRealize(FIELD)
	   See "Internals" in Mail::Message::Head

   Error handling
       $obj->AUTOLOAD()
	   See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)
	   See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
       Mail::Message::Replace::MailHeader->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
	   See "Error handling" in Mail::Reporter

       $obj->errors()
	   See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])
       Mail::Message::Replace::MailHeader->log([LEVEL [,STRINGS]])
	   See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Message::Replace::MailHeader->logPriority(LEVEL)
	   See "Error handling" in Mail::Reporter

       $obj->logSettings()
	   See "Error handling" in Mail::Reporter

       $obj->notImplemented()
	   See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->warnings()
	   See "Error handling" in Mail::Reporter

   Cleanup
       $obj->DESTROY()
	   See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction()
	   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(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()
	   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
       $obj->isa(CLASS)
       Mail::Message::Replace::MailHeader->isa(CLASS)
	   Of course, the "isa()" class inheritance check should not see our nasty trick.

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.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 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

perl v5.14.2							    2012-05-07				   Mail::Message::Replace::MailHeader(3pm)