(stringifaction) The header, when used as string, will format as if
Mail::Message::Head::Complete::string() was called, so return a
nicely folder full header. An exception is made for Carp, which will
get a simplified string to avoid unreadible messages from croak
and confess
.
print $head; # implicit stringification by print $head->print; # the same print "$head"; # explicit stringication
When the header does not contain any lines (which is illegal, according to the RFCs), false is returned. In all other cases, a true value is produced.
See METHODS in Mail::Reporter
A fast way to construct a header with many lines.
The PAIRs are (name, content)
pairs of the header, but it is also possible
to pass Mail::Message::Field objects. A
Mail::Message::Head::Complete header is created by simply calling
Mail::Message::Head::Complete::build(), and then each field
is added. Double field names are permitted.
my $subject = Mail::Message::Field->new(Subject => 'xyz'); my $head = Mail::Message::Head->build ( From => 'me@example.com' , To => 'you@anywhere.aq' , $subject , Received => 'one' , Received => 'two' ); print ref $head; # --> Mail::Message::Head::Complete
Create a new message header object. The object will store all the fields of a header. When you get information from the header, it will be returned to you as Mail::Message::Field objects, although the fields may be stored differently internally.
If you try to instantiate a Mail::Message::Head, you will automatically be upgraded to a Mail::Message::Head::Complete --a full head.
Option | Defined in | Default |
---|---|---|
field_type | ||
log | Mail::Reporter |
|
message | undef | |
modified | <false> | |
trace | Mail::Reporter |
|
Headers may only be partially read, in which case they are called delayed. This method returns true if some header information still needs to be read. Returns false if all header data has been read. Will never trigger completion.
Are there any fields defined in the current header? Be warned that the header will not be loaded for this: delayed headers will return true in any case.
Returns whether the header has been modified after being read.
if($head->isModified) { ... }
Like Mail::Message::Head::Complete::names(), but only returns the known
header fields, which may be less than names
for header types which are
partial. names()
will trigger completion, where knownNames()
does not.
Get (after setting) the message where this header belongs to. This does not trigger completion.
Sets the modified flag to BOOLEAN. Without value, the current setting is returned, but in that case you can better use isModified(). Changing this flag will not trigger header completion.
$head->modified(1); if($head->modified) { ... } if($head->isModified) { ... }
Retuns the fields ordered the way they were read or added.
Get the data which is related to the field with the NAME. The case of the characters in NAME does not matter.
If there is only one data element defined for the NAME, or if there is an INDEX specified as the second argument, only the specified element will be returned. If the field NAME matches more than one header the return value depends on the context. In LIST context, all values will be returned in the order they are read. In SCALAR context, only the last value will be returned.
my $head = Mail::Message::Head->new; $head->add('Received: abc'); $head->add('Received: xyz'); $head->add('Subject: greetings'); my @rec_list = $head->get('Received'); my $rec_scalar = $head->get('Received'); print ",@rec_list,$rec_scalar," # ,abc xyz, xyz, print $head->get('Received', 0); # abc my @sub_list = $head->get('Subject'); my $sub_scalar = $head->get('Subject'); print ",@sub_list,$sub_scalar," # ,greetings, greetings,
Like get(), but puts more effort in understanding the contents of the field. Mail::Message::Field::study() will be called for the field with the specified FIELDNAME, which returns Mail::Message::Field::Full objects. In scalar context only the last field with that name is returned. When an INDEX is specified, that element is returned.
Try to estimate the size of the body of this message, but without parsing
the header or body. The result might be undef
or a few percent of
the real size. It may even be very far of the real value, that's why
this is a guess.
Returns whether the body of the related message is a multipart body.
May trigger completion, when the Content-Type
field is not defined.
Add a field, like Mail::Message::Head::Complete::add() does, but avoid the loading of a possibly partial header. This method does not test the validity of the argument, nor flag the header as changed. This does not trigger completion.
Returns the location of the header in the file, as a pair begin and end. The begin is the first byte of the header. The end is the first byte after the header.
Be sure that the header is loaded. This returns the loaded header object.
Move the registration of the header in the file.
Set a field, but avoid the loading of a possibly partial header as set() does. This method does not test the validity of the argument, nor flag the header as changed. This does not trigger completion.