Mail::Message::Field::Structured - one line of a structured message header |
Mail::Message::Field::Structured - one line of a structured message header
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::URIs
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);
overload: ``''
See OVERLOADED in the Mail::Message::Field manpage
overload: +0
See OVERLOADED in the Mail::Message::Field manpage
overload: <=>
See OVERLOADED in the Mail::Message::Field manpage
overload: bool
See OVERLOADED in the Mail::Message::Field manpage
overload: cmp
See OVERLOADED in the Mail::Message::Field manpage
overload: stringification
See OVERLOADED in the Mail::Message::Field::Full manpage
$obj->clone
See Constructors in the Mail::Message::Field manpage
Mail::Message::Field::Structured->from(FIELD, OPTIONS)
See Constructors in the Mail::Message::Field::Full manpage
Mail::Message::Field::Structured->new(DATA)
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 Mail::Message::Field::Attribute
objects. Finally, there are some OPTIONS.
Option Defined in Default attributes C<[]> charset L<Mail::Message::Field::Full> undef datum C<undef> encoding L<Mail::Message::Field::Full> C<'q'> force L<Mail::Message::Field::Full> false language L<Mail::Message::Field::Full> undef log L<Mail::Reporter> C<'WARNINGS'> trace L<Mail::Reporter> C<'WARNINGS'>
. 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 Mail::Message::Field::Attribute objects.
. charset STRING
. datum STRING
The method name body is very confusing, even in the RFC. In MailBox, for historical reasons, body() returns the past of the field contents before the first semi-colon. foldedBody() and unfoldedBody() 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 datum.
. encoding 'q'|'Q'|'b'|'B'
. force BOOLEAN
. language STRING
. log LEVEL
. trace LEVEL
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);
$obj->isStructured
Mail::Message::Field::Structured->isStructured
See The field in the Mail::Message::Field manpage
$obj->length
See The field in the Mail::Message::Field manpage
$obj->nrLines
See The field in the Mail::Message::Field manpage
$obj->print([FILEHANDLE])
See The field in the Mail::Message::Field manpage
$obj->size
See The field in the Mail::Message::Field manpage
$obj->string([WRAP])
See The field in the Mail::Message::Field manpage
$obj->toDisclose
See The field in the Mail::Message::Field manpage
$obj->Name
See Access to the name in the Mail::Message::Field manpage
$obj->name
See Access to the name in the Mail::Message::Field manpage
$obj->wellformedName([STRING])
See Access to the name in the Mail::Message::Field manpage
$obj->body
See Access to the body in the Mail::Message::Field manpage
$obj->decodedBody(OPTIONS)
See Access to the body in the Mail::Message::Field::Full manpage
$obj->folded
See Access to the body in the Mail::Message::Field manpage
$obj->foldedBody([BODY])
See Access to the body in the Mail::Message::Field manpage
$obj->stripCFWS([STRING])
Mail::Message::Field::Structured->stripCFWS([STRING])
See Access to the body in the Mail::Message::Field manpage
$obj->unfoldedBody([BODY, [WRAP]])
See Access to the body in the Mail::Message::Field manpage
$obj->addresses
See Access to the content in the Mail::Message::Field manpage
$obj->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 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 Mail::Message::Field::Attribute::new() about the available OPTIONS.
The attribute object is returned, however, when continuations are used this
may be an object you already know about. 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);
$obj->attributes
Returns a list with all attributes, which are all 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.
$obj->beautify
See Access to the content in the Mail::Message::Field::Full manpage
$obj->comment([STRING])
See Access to the content in the Mail::Message::Field manpage
$obj->createComment(STRING, OPTIONS)
Mail::Message::Field::Structured->createComment(STRING, OPTIONS)
See Access to the content in the Mail::Message::Field::Full manpage
$obj->createPhrase(STRING, OPTIONS)
Mail::Message::Field::Structured->createPhrase(STRING, OPTIONS)
See Access to the content in the Mail::Message::Field::Full manpage
$obj->study
See Access to the content in the Mail::Message::Field manpage
$obj->toDate([TIME])
Mail::Message::Field::Structured->toDate([TIME])
See Access to the content in the Mail::Message::Field manpage
$obj->toInt
See Access to the content in the Mail::Message::Field manpage
$obj->dateToTimestamp(STRING)
Mail::Message::Field::Structured->dateToTimestamp(STRING)
See Other methods in the Mail::Message::Field manpage
$obj->consume(LINE | (NAME,BODY|OBJECTS))
See Internals in the Mail::Message::Field manpage
$obj->decode(STRING, OPTIONS)
Mail::Message::Field::Structured->decode(STRING, OPTIONS)
See Internals in the Mail::Message::Field::Full manpage
$obj->defaultWrapLength([LENGTH])
See Internals in the Mail::Message::Field manpage
$obj->encode(STRING, OPTIONS)
See Internals in the Mail::Message::Field::Full manpage
$obj->fold(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Structured->fold(NAME, BODY, [MAXCHARS])
See Internals in the Mail::Message::Field manpage
$obj->setWrapLength([LENGTH])
See Internals in the Mail::Message::Field manpage
$obj->stringifyData(STRING|ARRAY|OBJECTS)
See Internals in the Mail::Message::Field manpage
$obj->unfold(STRING)
See Internals in the Mail::Message::Field manpage
$obj->consumeComment(STRING)
Mail::Message::Field::Structured->consumeComment(STRING)
See Parsing in the Mail::Message::Field::Full manpage
$obj->consumeDotAtom(STRING)
See Parsing in the Mail::Message::Field::Full manpage
$obj->consumePhrase(STRING)
Mail::Message::Field::Structured->consumePhrase(STRING)
See Parsing in the Mail::Message::Field::Full manpage
$obj->datum([VALUE])
Equivalent to body(), but maybe less confusing.
$obj->parse(STRING)
See Parsing in the Mail::Message::Field::Full manpage
$obj->produceBody
See Parsing in the Mail::Message::Field::Full manpage
$obj->AUTOLOAD
See Error handling in the Mail::Reporter manpage
$obj->addReport(OBJECT)
See Error handling in the Mail::Reporter manpage
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Structured->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See Error handling in the Mail::Reporter manpage
$obj->errors
See Error handling in the Mail::Reporter manpage
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Field::Structured->log([LEVEL [,STRINGS]])
See Error handling in the Mail::Reporter manpage
$obj->logPriority(LEVEL)
Mail::Message::Field::Structured->logPriority(LEVEL)
See Error handling in the Mail::Reporter manpage
$obj->logSettings
See Error handling in the Mail::Reporter manpage
$obj->notImplemented
See Error handling in the Mail::Reporter manpage
$obj->report([LEVEL])
See Error handling in the Mail::Reporter manpage
$obj->reportAll([LEVEL])
See Error handling in the Mail::Reporter manpage
$obj->trace([LEVEL])
See Error handling in the Mail::Reporter manpage
$obj->warnings
See Error handling in the Mail::Reporter manpage
$obj->DESTROY
See Cleanup in the Mail::Reporter manpage
$obj->inGlobalDestruction
See Cleanup in the Mail::Reporter manpage
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 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.
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.
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.
Warning: Illegal encoding '$encoding', used 'q'
The RFCs only permit base64 (b
or B
) or quoted-printable
(q
or Q
) encoding. Other than these four options are illegal.
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 the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Mail::Message::Field::Structured - one line of a structured message header |