/usr/share/perl5/Mail/Message/Field/Structured.pod is in libmail-box-perl 2.110-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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | =encoding utf8
=head1 NAME
Mail::Message::Field::Structured - one line of a structured message header
=head1 INHERITANCE
Mail::Message::Field::Structured
is a Mail::Message::Field::Full
is a Mail::Message::Field
is a Mail::Reporter
Mail::Message::Field::Structured is extended by
Mail::Message::Field::Addresses
Mail::Message::Field::Date
Mail::Message::Field::URIs
=head1 SYNOPSIS
my $f = Mail::Message::Field::Full
->new('Content-Type' => 'text/html');
my @encode = (charset => 'jp', use_continuations => 1);
$f->attribute('filename=passwd');
$f->attribute(filename => 'passwd', @encode);
my $attr = Mail::Message::Field::Attribute->new(...);
$f->attribute($attr);
=head1 DESCRIPTION
See L<documentation in the base class|Mail::Message::Field::Full/"DESCRIPTION">.
=head1 OVERLOADED
See L<documentation in the base class|Mail::Message::Field::Full/"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">
=item overload: B<stringification>()
See L<Mail::Message::Field::Full/"OVERLOADED">
=back
=head1 METHODS
See L<documentation in the base class|Mail::Message::Field::Full/"METHODS">.
=head2 Constructors
See L<documentation in the base class|Mail::Message::Field::Full/"Constructors">.
=over 4
=item $obj-E<gt>B<clone>()
See L<Mail::Message::Field/"Constructors">
=item Mail::Message::Field::Structured-E<gt>B<from>(FIELD, OPTIONS)
See L<Mail::Message::Field::Full/"Constructors">
=item Mail::Message::Field::Structured-E<gt>B<new>(DATA)
=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, OPTIONS
A set of values which shape the line.
=back
The NAME is a wellformed header name (you may use wellformedName()) to
be sure about the casing. The BODY is a string, one object, or an
ref-array of objects. In case of objects, they must fit to the
constructor of the field: the types which are accepted may differ.
The optional ATTRIBUTE list contains L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute>
objects. Finally, there are some OPTIONS.
-Option --Defined in --Default
attributes []
charset Mail::Message::Field::Full undef
datum undef
encoding Mail::Message::Field::Full 'q'
force Mail::Message::Field::Full false
language Mail::Message::Field::Full undef
log Mail::Reporter 'WARNINGS'
trace Mail::Reporter 'WARNINGS'
=over 2
=item attributes => ATTRS
There are various ways to specify these attributes: pass a reference
to an array which list of key-value pairs representing attributes,
or reference to a hash containing these pairs, or an array with
L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute> objects.
=item charset => STRING
=item datum => STRING
The method name I<body> is very confusing, even in the RFC. In MailBox,
for historical reasons, L<body()|Mail::Message::Field/"Access to the body"> returns the part of the field contents
before the first semi-colon. L<foldedBody()|Mail::Message::Field/"Access to the body"> and L<unfoldedBody()|Mail::Message::Field/"Access to the body">
address the whole field.
There is no common name for the piece of data before the parameters
(attributes) in the field-content mentioned in the RFCs, so let's call
it B<datum>.
=item encoding => 'q'|'Q'|'b'|'B'
=item force => BOOLEAN
=item language => STRING
=item log => LEVEL
=item trace => LEVEL
=back
example: of a structured field
my @attrs = (Mail::Message::Field::Attribute->new(...), ...);
my @options = (extra => 'the color blue');
my $t = Mail::Message::Field::Full->new(To => \@addrs, @attrs, @options);
=back
=head2 The field
See L<documentation in the base class|Mail::Message::Field::Full/"The field">.
=over 4
=item $obj-E<gt>B<isStructured>()
=item Mail::Message::Field::Structured-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::Full/"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::Full/"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<decodedBody>(OPTIONS)
See L<Mail::Message::Field::Full/"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::Structured-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::Full/"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<attrPairs>()
Returns a list with attribute name and value pairs.
=item $obj-E<gt>B<attribute>(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))
Add an attribute to the field. The attributes are added left-to-right into
the string representation of the field, although the order of the attributes
is un-important, according to the RFCs.
You may pass a fully prepared L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute> OBJECT,
if you like to do all preparations for correct representation of the
data yourself. You may also pass one STRING, which is a fully prepared
attribute. This STRING will not be changed, so be careful about quoting
and encodings.
As third possibility, you can specify an attribute NAME and its VALUE.
An attribute object will be created for you implicitly in both
cases where such object is not supplied, passing the OPTIONS. See
L<Mail::Message::Field::Attribute::new()|Mail::Message::Field::Attribute/"Constructors"> about the available OPTIONS.
The attribute object is returned, however, when continuations are used this
may be an object you already know about. C<undef> is returned when
construction fails (when the attribute is incorrect).
example:
$f->attribute(filename => 'passwd');
$f->attribute(filename => 'passwd', use_continuations => 0);
my $attr = Mail::Message::Field::Attribute->new(...);
$f->attribute($attr);
=item $obj-E<gt>B<attributes>()
Returns a list with all attributes, which are all
L<Mail::Message::Field::Attribute|Mail::Message::Field::Attribute> objects. The attributes are not
ordered in any way. The list may be empty. Double attributes or
continuations are folded into one.
=item $obj-E<gt>B<beautify>()
See L<Mail::Message::Field::Full/"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<createComment>(STRING, OPTIONS)
=item Mail::Message::Field::Structured-E<gt>B<createComment>(STRING, OPTIONS)
See L<Mail::Message::Field::Full/"Access to the content">
=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)
=item Mail::Message::Field::Structured-E<gt>B<createPhrase>(STRING, OPTIONS)
See L<Mail::Message::Field::Full/"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::Structured-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::Full/"Other methods">.
=over 4
=item $obj-E<gt>B<dateToTimestamp>(STRING)
=item Mail::Message::Field::Structured-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::Full/"Internals">.
=over 4
=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))
See L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<decode>(STRING, OPTIONS)
=item Mail::Message::Field::Structured-E<gt>B<decode>(STRING, OPTIONS)
See L<Mail::Message::Field::Full/"Internals">
=item $obj-E<gt>B<defaultWrapLength>([LENGTH])
See L<Mail::Message::Field/"Internals">
=item $obj-E<gt>B<encode>(STRING, OPTIONS)
See L<Mail::Message::Field::Full/"Internals">
=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])
=item Mail::Message::Field::Structured-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 Parsing
See L<documentation in the base class|Mail::Message::Field::Full/"Parsing">.
=over 4
=item $obj-E<gt>B<consumeComment>(STRING)
=item Mail::Message::Field::Structured-E<gt>B<consumeComment>(STRING)
See L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumeDotAtom>(STRING)
See L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<consumePhrase>(STRING)
=item Mail::Message::Field::Structured-E<gt>B<consumePhrase>(STRING)
See L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<datum>([VALUE])
The part of the field before the semi-colon (C<;>).
=item $obj-E<gt>B<parse>(STRING)
See L<Mail::Message::Field::Full/"Parsing">
=item $obj-E<gt>B<produceBody>()
See L<Mail::Message::Field::Full/"Parsing">
=back
=head2 Error handling
See L<documentation in the base class|Mail::Message::Field::Full/"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::Structured-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::Structured-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Message::Field::Structured-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::Full/"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::Full/"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 charset '$charset'
The field is created with an utf8 string which only contains data from the
specified character set. However, that character set can never be a valid
name because it contains characters which are not permitted.
=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 Warning: Illegal character in language '$lang'
The field is created with data which is specified to be in a certain language,
however, the name of the language cannot be valid: it contains characters
which are not permitted by the RFCs.
=item Warning: Illegal encoding '$encoding', used 'q'
The RFCs only permit base64 (C<b > or C<B >) or quoted-printable
(C<q> or C<Q>) encoding. Other than these four options are illegal.
=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>
|