GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::REPLACE::MAILHEADER (3)

.ds Aq ’

NAME

Mail::Message::Replace::MailHeader - fake Mail::Header

CONTENTS

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

See documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Head
overload: <B>boolB>() See OVERLOADED in Mail::Message::Head

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>buildB>([PAIR|FIELD]-LIST) See Constructors in Mail::Message::Head::Complete
$obj-><B>cloneB>([NAMES|ARRAY-OF-NAMES|REGEXS]) See Constructors in Mail::Message::Head::Complete
Mail::Message::Replace::MailHeader-><B>newB>([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

See documentation in the base class.
$obj-><B>isDelayedB>() See The header in Mail::Message::Head
$obj-><B>isEmptyB>() See The header in Mail::Message::Head
$obj-><B>isModifiedB>() See The header in Mail::Message::Head
$obj-><B>knownNamesB>() See The header in Mail::Message::Head
$obj-><B>messageB>([MESSAGE]) See The header in Mail::Message::Head
$obj-><B>modifiedB>([BOOLEAN]) See The header in Mail::Message::Head
$obj-><B>nrLinesB>() See The header in Mail::Message::Head::Complete
$obj-><B>orderedFieldsB>() See The header in Mail::Message::Head
$obj-><B>sizeB>() See The header in Mail::Message::Head::Complete
$obj-><B>wrapB>(INTEGER) See The header in Mail::Message::Head::Complete

    Access to the header

See documentation in the base class.
$obj-><B>addB>(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-><B>addListGroupB>(OBJECT) See Access to the header in Mail::Message::Head::Complete
$obj-><B>addResentGroupB>(RESENT-GROUP|DATA) See Access to the header in Mail::Message::Head::Complete
$obj-><B>addSpamGroupB>(OBJECT) See Access to the header in Mail::Message::Head::Complete
$obj-><B>countB>(NAME) See Access to the header in Mail::Message::Head::Complete
$obj-><B>deleteB>(TAG, [INDEX]) Delete the fields with the specified TAG. The deleted fields are returned. If no index is given, then all are removed.
$obj-><B>getB>(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-><B>grepNamesB>([NAMES|ARRAY-OF-NAMES|REGEXS]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>listGroupB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>namesB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>printB>([FILEHANDLE]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>printSelectedB>(FILEHANDLE, (STRING|REGEXP)s) See Access to the header in Mail::Message::Head::Complete
$obj-><B>printUndisclosedB>([FILEHANDLE]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeContentInfoB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeFieldB>(FIELD) See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeFieldsB>(STRING|REGEXP, [STRING|REGEXP, ...]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeFieldsExceptB>(STRING|REGEXP, [STRING|REGEXP, ...]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeListGroupB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeResentGroupsB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>removeSpamGroupsB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>replaceB>(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-><B>resentGroupsB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>resetB>(NAME, FIELDS) See Access to the header in Mail::Message::Head::Complete
$obj-><B>setB>(FIELD | LINE | (NAME, BODY [,ATTRS])) See Access to the header in Mail::Message::Head::Complete
$obj-><B>spamDetectedB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>spamGroupsB>([NAMES]) See Access to the header in Mail::Message::Head::Complete
$obj-><B>stringB>() See Access to the header in Mail::Message::Head::Complete
$obj-><B>studyB>(NAME [,INDEX]) See Access to the header in Mail::Message::Head

    About the body

See documentation in the base class.
$obj-><B>guessBodySizeB>() See About the body in Mail::Message::Head
$obj-><B>guessTimeStampB>() See About the body in Mail::Message::Head::Complete
$obj-><B>isMultipartB>() See About the body in Mail::Message::Head
$obj-><B>recvstampB>() See About the body in Mail::Message::Head::Complete
$obj-><B>timestampB>() See About the body in Mail::Message::Head::Complete

    Internals

See documentation in the base class.
$obj-><B>addNoRealizeB>(FIELD) See Internals in Mail::Message::Head
$obj-><B>addOrderedFieldsB>(FIELDS) See Internals in Mail::Message::Head
$obj-><B>createFromLineB>() See Internals in Mail::Message::Head::Complete
$obj-><B>createMessageIdB>() See Internals in Mail::Message::Head::Complete
$obj-><B>fileLocationB>() See Internals in Mail::Message::Head
$obj-><B>loadB>() See Internals in Mail::Message::Head
$obj-><B>messageIdPrefixB>([PREFIX, [HOSTNAME]|CODE])
Mail::Message::Replace::MailHeader-><B>messageIdPrefixB>([PREFIX, [HOSTNAME]|CODE]) See Internals in Mail::Message::Head::Complete
$obj-><B>moveLocationB>(DISTANCE) See Internals in Mail::Message::Head
$obj-><B>setNoRealizeB>(FIELD) See Internals in Mail::Message::Head

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Replace::MailHeader-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Replace::MailHeader-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Replace::MailHeader-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

    Access to the header

    Simulating Mail::Header

$obj-><B>as_stringB>() Returns the whole header as one big scalar. Calls Mail::Message::Head::Complete::string().
$obj-><B>cleanupB>() Cleanup memory usage. Not needed here.
$obj-><B>combineB>(TAG, [WITH]) I do not see any valid reason for this command, so did not implement it.
$obj-><B>dupB>() Duplicate the header, which is simply clone().
$obj-><B>emptyB>() Clean-out the whole hash. Better not use this (simply create another header object), although it should work.
$obj-><B>existsB>() Returns whether there are any fields.
$obj-><B>extractB>(ARRAY) Extract (and remove) header fields from the array.
$obj-><B>foldB>([LENGTH]) Refold all fields in the header, to LENGTH or whatever fold_length() returns.
$obj-><B>fold_lengthB>([[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-><B>headerB>([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-><B>header_hashrefB>(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-><B>mail_fromB>([’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-><B>modifyB>([BOOLEAN]) Refold the headers when they are added.
$obj-><B>readB>(FILE) Read the header from the FILE.
$obj-><B>tagsB>() Returns all the names of fields, implemented by Mail::Message::Head::Complete::names().
$obj-><B>unfoldB>([TAG]) Remove the folding for all instances of TAG, or all fields at once.

    The nasty bits

$obj-><B>isaB>(CLASS)
Mail::Message::Replace::MailHeader-><B>isaB>(CLASS) Of course, the isa() class inheritance check should not see our nasty trick.

DETAILS

See documentation in the base class.

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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::REPLACE::MAILHEADER (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.