NAME
Mail::Message::Field::Unstructured - smart unstructured field
INHERITANCE
Mail::Message::Field::Unstructured
is a Mail::Message::Field::Full
is a Mail::Message::Field
is a Mail::ReporterSYNOPSIS
my $f = Mail::Message::Field::Unstructured->new(Comments => 'hi!');DESCRIPTION
Unstructured fields do contain information which is not restricted in any way. RFC2822 defines some unstructured fields, but by default all unknown fields are unstructured as well. Things like attributes and comments have no meaning for unstructured fields, but encoding does.
OVERLOADED
overload: ""
overload: +0
overload: <=>
overload: bool
overload: cmp
overload: stringification
METHODS
Constructors
$obj->clone
Mail::Message::Field::Unstructured->from(FIELD, OPTIONS)
Mail::Message::Field::Unstructured->new(DATA)
When the DATA is specified as single line, the content part is considered to be correcly (character) encoded and escaped. Typically, it is a line as read from file. The folding of the line is kept as is.
In case more than one argument is provided, the second is considered the BODY. Attributes and other special things are not defined for unstructured fields, and therefore not valid options. The BODY can be a single string, a single OBJECT, or an array of OBJECTS. The objects are stringified (into a comma separated list). Each BODY element is interpreted with the specified encoding.
When the BODY is empty, the construction of the object fails: undef is returned.
Option --Defined in --Default
charset Mail::Message::Field::Full 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'. charset => STRING
. encoding => 'q'|'Q'|'b'|'B'
. force => BOOLEAN
. language => STRING
. log => LEVEL
. trace => LEVEL
example:
my $s = Mail::Message::Field::Unstructured->new('Comment', 'Hi!');
# Use autodetect
my $s = Mail::Message::Field::Full->new('Comment', 'Hi!');
my $s = Mail::Message::Field::Full->new('Comment: Hi!');The field
$obj->isStructured
Mail::Message::Field::Unstructured->isStructured
$obj->length
$obj->nrLines
$obj->print([FILEHANDLE])
$obj->size
$obj->string([WRAP])
$obj->toDisclose
Access to the name
$obj->Name
$obj->name
$obj->wellformedName([STRING])
Access to the body
$obj->body
$obj->decodedBody(OPTIONS)
$obj->folded
$obj->foldedBody([BODY])
$obj->stripCFWS([STRING])
Mail::Message::Field::Unstructured->stripCFWS([STRING])
$obj->unfoldedBody([BODY, [WRAP]])
Access to the content
$obj->addresses
$obj->attribute(NAME [, VALUE])
$obj->attributes
$obj->beautify
$obj->comment([STRING])
$obj->createComment(STRING, OPTIONS)
Mail::Message::Field::Unstructured->createComment(STRING, OPTIONS)
$obj->createPhrase(STRING, OPTIONS)
Mail::Message::Field::Unstructured->createPhrase(STRING, OPTIONS)
$obj->study
$obj->toDate([TIME])
Mail::Message::Field::Unstructured->toDate([TIME])
$obj->toInt
Other methods
$obj->dateToTimestamp(STRING)
Mail::Message::Field::Unstructured->dateToTimestamp(STRING)
Internals
$obj->consume(LINE | (NAME,BODY|OBJECTS))
$obj->decode(STRING, OPTIONS)
Mail::Message::Field::Unstructured->decode(STRING, OPTIONS)
$obj->defaultWrapLength([LENGTH])
$obj->encode(STRING, OPTIONS)
$obj->fold(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Unstructured->fold(NAME, BODY, [MAXCHARS])
$obj->setWrapLength([LENGTH])
$obj->stringifyData(STRING|ARRAY|OBJECTS)
$obj->unfold(STRING)
Parsing
$obj->consumeComment(STRING)
Mail::Message::Field::Unstructured->consumeComment(STRING)
$obj->consumeDotAtom(STRING)
$obj->consumePhrase(STRING)
Mail::Message::Field::Unstructured->consumePhrase(STRING)
$obj->parse(STRING)
$obj->produceBody
Error handling
$obj->AUTOLOAD
$obj->addReport(OBJECT)
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Unstructured->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Field::Unstructured->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Message::Field::Unstructured->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
Cleanup
$obj->DESTROY
$obj->inGlobalDestruction
DETAILS
DIAGNOSTICS
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 ALSO
This module is part of Mail-Box distribution version 2.089, built on April 20, 2009. Website: http://perl.overmeer.net/mailbox/
LICENSE
Copyrights 2001-2009 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 http://www.perl.com/perl/misc/Artistic.html