/usr/share/perl5/Mail/Message/Field/Attribute.pod is in libmail-box-perl 2.099-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 | =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.
=head1 METHODS
=head2 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 possiblity 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
=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::Attribute-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::Attribute-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Message::Field::Attribute-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
=over 4
=item $obj-E<gt>B<DESTROY>
See L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>
See L<Mail::Reporter/"Cleanup">
=back
=head2 The attribute
=over 4
=item $obj-E<gt>B<addComponent>(STRING)
A component is a parameter as defined by RFC2045, optionally using
encoding or continuations as defined by RFC2231. Components of an
attribute are found when a field is being parsed. The RFCs are
very strict on valid characters, but we cannot be: you have to accept
what is coming in if you can.
example:
my $param = Mail::Message::Field::Attribute->new;
$param->addComponent("filename*=iso10646'nl-BE'%Re\47u");
=item $obj-E<gt>B<charset>
Returns the character set which is used for this parameter. If any component
is added which contains character set information, this is directly
available. Be warned that a character-set is case insensitive.
=item $obj-E<gt>B<language>
Returns the language which is defined in the argument. If no language is
defined C<undef> is returned, which should be interpreted as "ANY"
=item $obj-E<gt>B<name>
Returns the name of this attribute.
=item $obj-E<gt>B<string>
Returns the parameter as reference to an array of lines. When only one line
is returned, it may be short enough to fit on the same line with other
components of the header field.
=item $obj-E<gt>B<value>([STRING])
Returns the value of this parameter, optionally after setting it first.
=back
=head2 Attribute encoding
=over 4
=item $obj-E<gt>B<decode>
Translate all known continuations into a value. The produced value is
returned and may be utf-8 encoded or a plain string.
=item $obj-E<gt>B<encode>
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<mergeComponent>(ATTRIBUTE)
Merge the components from the specified attribute in this attribute. This is
needed when components of the same attribute are created separately. Merging
is required by the field parsing.
=back
=head1 DIAGNOSTICS
=over 4
=item Warning: Illegal character in parameter name '$name'
The specified parameter name contains characters which are not permitted by
the RFCs. You can better change the name into something which is accepted,
or risk applications to corrupt or ignore the 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.
=item Error: Too late to merge: value already changed.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2011 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>
|