Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
AddrGroup.pm	1.68 KB	-rw-r--r--
AddrGroup.pod	7.61 KB	-rw-r--r--
Address.pm	2.07 KB	-rw-r--r--
Address.pod	6.72 KB	-rw-r--r--
Addresses.pm	5.95 KB	-rw-r--r--
Addresses.pod	14.97 KB	-rw-r--r--
Attribute.pm	5.25 KB	-rw-r--r--
Attribute.pod	8.39 KB	-rw-r--r--
AuthResults.pm	5.3 KB	-rw-r--r--
AuthResults.pod	13.46 KB	-rw-r--r--
DKIM.pm	2.02 KB	-rw-r--r--
DKIM.pod	14.28 KB	-rw-r--r--
Date.pm	2.73 KB	-rw-r--r--
Date.pod	12.5 KB	-rw-r--r--
Fast.pm	2.03 KB	-rw-r--r--
Fast.pod	10.85 KB	-rw-r--r--
Flex.pm	2.59 KB	-rw-r--r--
Flex.pod	9.61 KB	-rw-r--r--
Full.pm	10.86 KB	-rw-r--r--
Full.pod	19.77 KB	-rw-r--r--
Structured.pm	3.53 KB	-rw-r--r--
Structured.pod	15.04 KB	-rw-r--r--
URIs.pm	1.73 KB	-rw-r--r--
URIs.pod	13.24 KB	-rw-r--r--
Unstructured.pm	1018 B	-rw-r--r--
Unstructured.pod	12.47 KB	-rw-r--r--

Code Editor : Attribute.pod

=encoding utf8

=head1 NAME

Mail::Message::Field::Attribute - one attribute of a full field

=head1 INHERITANCE

Mail::Message::Field::Attribute
   is a Mail::Reporter

=head1 SYNOPSIS

my $field    = $msg->head->get('Content-Disposition') or return;
 my $full     = $field->study;   # full understanding in unicode
 my $filename = $full->attribute('filename')           or return;

print ref $filename;     # this class name
 print $filename;         # the attributes content in utf-8
 print $filename->value;  # same
 print $filename->string; # print string as was found in the file
 $filename->print(\*OUT); # print as was found in the file

=head1 DESCRIPTION

Attributes within MIME fields can be quite complex, and therefore be slow
and consumes a lot of memory.  The L<Mail::Message::Field::Fast|Mail::Message::Field::Fast> and
L<Mail::Message::Field::Flex|Mail::Message::Field::Flex> simplify them the attributes a lot, which
may result in erroneous behavior in rare cases.  With the increase of
non-western languages on Internet, the need for the complex headers
becomes more and more in demand.

A C<Mail::Message::Field::Attribute> can be found in any structured
L<Mail::Message::Field::Full|Mail::Message::Field::Full> header field.

Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
 
=head1 OVERLOADED

=over 4

=item overload: B<comparison>

When the second argument is a field, then both attribute name (case-sensitive)
and the decoded value must be the same.  Otherwise, the value is compared.

=item overload: B<stringification>

Returns the decoded content of the attribute.

=back

=head1 METHODS

Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
 
=over 4

=item Mail::Message::Field::Attribute-E<gt>B<new>( <$name, [$value] | STRING>, %options )

Create a new attribute $name with the optional $value.  If no $value is specified,
the first argument of this method is inspected for an equals sign C<'='>.
If that character is present, the argument is taken as STRING, containing
a preformatted attribute which is processed.  Otherwise, the argument is
taken as name without $value: set the value later with value().

Whether encoding takes place depends on the %options and the existence
of non-ascii characters in the $value.  The $name can only contain ascii
characters, hence is never encoded.

To speed things up, attributes are not derived from the L<Mail::Reporter|Mail::Reporter>
base-class.

-Option           --Defined in     --Default
  charset                             'us-ascii'
  language                            undef
  log                Mail::Reporter   'WARNINGS'
  trace              Mail::Reporter   'WARNINGS'
  use_continuations                   <true>

=over 2

=item charset => STRING

The $value is translated from utf-8 (Perl internal) to this character set,
and the resulting string is encoded if required.  C<us-ascii> is the normal
encoding for e-mail.  Valid character sets can be found with 
Encode::encodings(':all').

=item language => STRING

RFC2231 adds the possibility to specify a language with the field.  When no
language is specified, none is included in the encoding.  Valid language
names are defined by RFC2130.  This module has only limited support for
this feature.

=item log => LEVEL

=item trace => LEVEL

=item use_continuations => BOOLEAN

Continuations are used to break-up long parameters into pieces which
are no longer than 76 characters. Encodings are specified in RFC2231,
but not supported by some Mail User Agents.

=back

example:

my $fn    = Mail::Message::Field::Attribute
                ->new(filename => 'xyz');

my $fattr = 'Mail::Message::Field::Attribute';  # abbrev
 my $fn    = $fattr->new
   ( filename => "Re\xC7u"
   , charset  => 'iso-8859-15'
   , language => 'nl-BE'
   );
 print $fn;
   # -->  filename*=iso-8859-15'nl-BE'Re%C7u

=back

=head2 Error handling

Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
 
=over 4

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