NAME¶
Mail::Message::Field::Fast - one line of a message header
INHERITANCE¶
Mail::Message::Field::Fast
is a Mail::Message::Field
is a Mail::Reporter
SYNOPSIS¶
See Mail::Message::Field
DESCRIPTION¶
This is the faster, but less flexible implementation of a header field. The data
is stored in an array, and some hacks are made to speeds things up. Be gentle
with me, and consider that each message contains many of these lines, so speed
is very important here.
OVERLOADED¶
- overload: ""()
- See "OVERLOADED" in Mail::Message::Field
- overload: +0()
- See "OVERLOADED" in Mail::Message::Field
- overload: <=>()
- See "OVERLOADED" in Mail::Message::Field
- overload: bool()
- See "OVERLOADED" in Mail::Message::Field
- overload: cmp()
- See "OVERLOADED" in Mail::Message::Field
METHODS¶
Constructors¶
- $obj->clone()
- See "Constructors" in Mail::Message::Field
- Mail::Message::Field::Fast->new(DATA)
- The constructor of this object does not follow the usual
practise within the Mail::Box suite: it does not use the constructor
Mail::Reporter::new(). Therefor it has no logging or tracing
facilities.
The method can be used in one of the following ways:
- •
- new LINE
Pass a LINE as it could be found in a file: a (possibly folded) line which
is terminated by a new-line.
- •
- new NAME, (BODY|OBJECTS), [ATTRIBUTES]
A set of values which shape the line.
Create a new header field object. Specify the whole LINE at once, and it will be
split-up for you. I case you already have the parts of the header line, you
may specify them separately as NAME and BODY.
In case you specify a single OBJECT, or a reference to an array of OBJECTS,
these objects are processed to become suitable to fill a field, usually by
simple strification. When you specify one or more Mail::Address objects, these
are transformed into a string using their "format" method. You may
also add one Mail::Message::Field, whose body is taken. In case of an array,
the elements are joined into one string with a comma.
ATTRIBUTES can be exactly one string which may contain multiple attributes at
once, quoted and formatted as required in RFC2822. As alternative, list of
key-value pairs can be used. In this case, the values will get quoted if
needed and everything formatted as the protocol demands.
-Option--Defined in --Default
log Mail::Reporter <disabled>
trace Mail::Reporter <disabled>
- log => LEVEL
- trace => LEVEL
example:
my $mime = Mail::Message::Field->new(
'Content-Type: text/plain; charset=US-ASCII');
my $mime = Mail::Message::Field->new(
'Content-Type' => 'text/plain; charset=US-ASCII');
my $mime = Mail::Message::Field->new(
'Content-Type' => 'text/plain', 'charset=US-ASCII');
my $mime = Mail::Message::Field->new(
'Content-Type' => 'text/plain', charset => 'Latin1');
my $mime = Mail::Message::Field->new(
To => Mail::Address->new('My', 'me@example.com');
my $mime = Mail::Message::Field->new(
Cc => [ Mail::Address->new('You', 'you@example.com')
, Mail::Address->new('His', 'he@example.com')
]);
But in practice, you can simply call
my $head = Mail::Message::Head->new;
$head->add( 'Content-Type' => 'text/plain'
, charset => 'utf8');
which implicitly calls this constructor (when needed). You can specify the same
things for
Mail::Message::Head::Complete::add() as this "new"
accepts.
The field¶
- $obj->isStructured()
- Mail::Message::Field::Fast->isStructured()
- See "The field" in Mail::Message::Field
- $obj->length()
- See "The field" in Mail::Message::Field
- $obj->nrLines()
- See "The field" in Mail::Message::Field
- $obj->print([FILEHANDLE])
- See "The field" in Mail::Message::Field
- $obj->size()
- See "The field" in Mail::Message::Field
- $obj->string([WRAP])
- See "The field" in Mail::Message::Field
- $obj->toDisclose()
- See "The field" in Mail::Message::Field
Access to the name¶
- $obj->Name()
- See "Access to the name" in
Mail::Message::Field
- $obj->name()
- See "Access to the name" in
Mail::Message::Field
- $obj->wellformedName([STRING])
- See "Access to the name" in
Mail::Message::Field
Access to the body¶
- $obj->body()
- See "Access to the body" in
Mail::Message::Field
- $obj->folded()
- See "Access to the body" in
Mail::Message::Field
- $obj->foldedBody([BODY])
- See "Access to the body" in
Mail::Message::Field
- $obj->stripCFWS([STRING])
- Mail::Message::Field::Fast->stripCFWS([STRING])
- See "Access to the body" in
Mail::Message::Field
- $obj->unfoldedBody([BODY, [WRAP]])
- See "Access to the body" in
Mail::Message::Field
Access to the content¶
- $obj->addresses()
- See "Access to the content" in
Mail::Message::Field
- $obj->attribute(NAME [, VALUE])
- See "Access to the content" in
Mail::Message::Field
- $obj->attributes()
- See "Access to the content" in
Mail::Message::Field
- $obj->comment([STRING])
- See "Access to the content" in
Mail::Message::Field
- $obj->study()
- See "Access to the content" in
Mail::Message::Field
- $obj->toDate([TIME])
- Mail::Message::Field::Fast->toDate([TIME])
- See "Access to the content" in
Mail::Message::Field
- $obj->toInt()
- See "Access to the content" in
Mail::Message::Field
Other methods¶
- $obj->dateToTimestamp(STRING)
- Mail::Message::Field::Fast->dateToTimestamp(STRING)
- See "Other methods" in Mail::Message::Field
Internals¶
- $obj->consume(LINE | (NAME,BODY|OBJECTS))
- See "Internals" in Mail::Message::Field
- $obj->defaultWrapLength([LENGTH])
- See "Internals" in Mail::Message::Field
- $obj->fold(NAME, BODY, [MAXCHARS])
- Mail::Message::Field::Fast->fold(NAME, BODY,
[MAXCHARS])
- See "Internals" in Mail::Message::Field
- $obj->setWrapLength([LENGTH])
- See "Internals" in Mail::Message::Field
- $obj->stringifyData(STRING|ARRAY|OBJECTS)
- See "Internals" in Mail::Message::Field
- $obj->unfold(STRING)
- See "Internals" in Mail::Message::Field
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::Field::Fast->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::Field::Fast->log([LEVEL
[,STRINGS]])
- See "Error handling" in Mail::Reporter
- $obj->logPriority(LEVEL)
- Mail::Message::Field::Fast->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
DIAGNOSTICS¶
- Warning: Field content is not numerical: $content
- The numeric value of a field is requested (for instance the
"Lines" or "Content-Length" fields should be
numerical), however the data contains weird characters.
- Warning: Illegal character in field name $name
- A new field is being created which does contain characters
not permitted by the RFCs. Using this field in messages may break other
e-mail clients or transfer agents, and therefore mutulate or extinguish
your message.
- 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