=encoding utf8

=head1 NAME

Mail::Message::Field::Fast - one line of a message header

=head1 INHERITANCE

 Mail::Message::Field::Fast
   is a Mail::Message::Field
   is a Mail::Reporter

=head1 SYNOPSIS

 See Mail::Message::Field

=head1 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.

See L<documentation in the base class|Mail::Message::Field/"DESCRIPTION">.
 
=head1 OVERLOADED

See L<documentation in the base class|Mail::Message::Field/"OVERLOADED">.
 
=over 4

=item overload: B<"">()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<0+>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<<=>>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<bool>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<cmp>()

See L<Mail::Message::Field/"OVERLOADED">

=back

=head1 METHODS

See L<documentation in the base class|Mail::Message::Field/"METHODS">.
 
=head2 Constructors

See L<documentation in the base class|Mail::Message::Field/"Constructors">.
 
=over 4

=item $obj-E<gt>B<clone>()

See L<Mail::Message::Field/"Constructors">

=item Mail::Message::Field::Fast-E<gt>B<new>(DATA)

The constructor of this object does not follow the usual practise within
the Mail::Box suite: it does not use the constructor
L<Mail::Reporter::new()|Mail::Reporter/"Constructors">.
Therefor it has no logging or tracing facilities.

The method can be used in one of the following ways:

=over 4

=item * B<new> LINE

Pass a LINE as it could be found in a file: a (possibly folded) line
which is terminated by a new-line.

=item * B<new> NAME, (BODY|OBJECTS), [ATTRIBUTES]

A set of values which shape the line.

=back

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
L<Mail::Address|Mail::Address> objects, these are transformed into a string using
their C<format> method.  You may also add one L<Mail::Message::Field|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>

=over 2

=item log => LEVEL

=item trace => LEVEL

=back

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 L<Mail::Message::Head::Complete::add()|Mail::Message::Head::Complete/"Access to the header"> as this
C<new> accepts.

=back

=head2 The field

See L<documentation in the base class|Mail::Message::Field/"The field">.
 
=over 4

=item $obj-E<gt>B<isStructured>()

=item Mail::Message::Field::Fast-E<gt>B<isStructured>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<length>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<nrLines>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<print>([FILEHANDLE])

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<size>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<string>([WRAP])

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<toDisclose>()

See L<Mail::Message::Field/"The field">

=back

=head2 Access to the name

See L<documentation in the base class|Mail::Message::Field/"Access to the name">.
 
=over 4

=item $obj-E<gt>B<Name>()

See L<Mail::Message::Field/"Access to the name">

=item $obj-E<gt>B<name>()

See L<Mail::Message::Field/"Access to the name">

=item $obj-E<gt>B<wellformedName>([STRING])

See L<Mail::Message::Field/"Access to the name">

=back

=head2 Access to the body

See L<documentation in the base class|Mail::Message::Field/"Access to the body">.
 
=over 4

=item $obj-E<gt>B<body>()

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<folded>()

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<foldedBody>([BODY])

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<stripCFWS>([STRING])

=item Mail::Message::Field::Fast-E<gt>B<stripCFWS>([STRING])

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])

See L<Mail::Message::Field/"Access to the body">

=back

=head2 Access to the content

See L<documentation in the base class|Mail::Message::Field/"Access to the content">.
 
=over 4

=item $obj-E<gt>B<addresses>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<attribute>(NAME [, VALUE])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<attributes>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<comment>([STRING])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<study>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<toDate>([TIME])

=item Mail::Message::Field::Fast-E<gt>B<toDate>([TIME])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<toInt>()

See L<Mail::Message::Field/"Access to the content">

=back

=head2 Other methods

See L<documentation in the base class|Mail::Message::Field/"Other methods">.
 
=over 4

=item $obj-E<gt>B<dateToTimestamp>(STRING)

=item Mail::Message::Field::Fast-E<gt>B<dateToTimestamp>(STRING)

See L<Mail::Message::Field/"Other methods">

=back

=head2 Internals

See L<documentation in the base class|Mail::Message::Field/"Internals">.
 
=over 4

=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<defaultWrapLength>([LENGTH])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])

=item Mail::Message::Field::Fast-E<gt>B<fold>(NAME, BODY, [MAXCHARS])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<setWrapLength>([LENGTH])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<unfold>(STRING)

See L<Mail::Message::Field/"Internals">

=back

=head2 Error handling

See L<documentation in the base class|Mail::Message::Field/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<addReport>(OBJECT)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

=item Mail::Message::Field::Fast-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<errors>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])

=item Mail::Message::Field::Fast-E<gt>B<log>([LEVEL [,STRINGS]])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logPriority>(LEVEL)

=item Mail::Message::Field::Fast-E<gt>B<logPriority>(LEVEL)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logSettings>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<notImplemented>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<report>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<reportAll>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<trace>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<warnings>()

See L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

See L<documentation in the base class|Mail::Message::Field/"Cleanup">.
 
=over 4

=item $obj-E<gt>B<DESTROY>()

See L<Mail::Reporter/"Cleanup">

=back

=head1 DETAILS

See L<documentation in the base class|Mail::Message::Field/"DETAILS">.
 
=head1 DIAGNOSTICS

=over 4

=item Warning: Field content is not numerical: $content

The numeric value of a field is requested (for instance the C<Lines> or
C<Content-Length> fields should be numerical), however the data contains
weird characters.

=item 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.

=item 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.

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.110,
built on January 05, 2014. Website: F<http://perl.overmeer.net/mailbox/>

=head1 LICENSE

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

