Mail::Message::Field::Unstructured - smart unstructured field
Mail::Message::Field::Unstructured is a Mail::Message::Field::Full is a Mail::Message::Field is a Mail::Reporter
my $f = Mail::Message::Field::Unstructured->new(Comments => 'hi!');
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.
overload: ""
See Mail::Message::Field/"OVERLOADED"
overload: +0
See Mail::Message::Field/"OVERLOADED"
overload: <=>
See Mail::Message::Field/"OVERLOADED"
overload: bool
See Mail::Message::Field/"OVERLOADED"
overload: cmp
See Mail::Message::Field/"OVERLOADED"
overload: stringification
See Mail::Message::Field::Full/"OVERLOADED"
$obj->clone
See Mail::Message::Field/"Constructors"
Mail::Message::Field::Unstructured->from(FIELD, OPTIONS)
See Mail::Message::Field::Full/"Constructors"
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!');
$obj->isStructured
Mail::Message::Field::Unstructured->isStructured
See Mail::Message::Field/"The field"
$obj->length
See Mail::Message::Field/"The field"
$obj->nrLines
See Mail::Message::Field/"The field"
$obj->print([FILEHANDLE])
See Mail::Message::Field/"The field"
$obj->size
See Mail::Message::Field/"The field"
$obj->string([WRAP])
See Mail::Message::Field/"The field"
$obj->toDisclose
See Mail::Message::Field/"The field"
$obj->Name
See Mail::Message::Field/"Access to the name"
$obj->name
See Mail::Message::Field/"Access to the name"
$obj->wellformedName([STRING])
See Mail::Message::Field/"Access to the name"
$obj->body
See Mail::Message::Field/"Access to the body"
$obj->decodedBody(OPTIONS)
See Mail::Message::Field::Full/"Access to the body"
$obj->folded
See Mail::Message::Field/"Access to the body"
$obj->foldedBody([BODY])
See Mail::Message::Field/"Access to the body"
$obj->stripCFWS([STRING])
Mail::Message::Field::Unstructured->stripCFWS([STRING])
See Mail::Message::Field/"Access to the body"
$obj->unfoldedBody([BODY, [WRAP]])
See Mail::Message::Field/"Access to the body"
$obj->addresses
See Mail::Message::Field/"Access to the content"
$obj->attribute(NAME [, VALUE])
See Mail::Message::Field/"Access to the content"
$obj->attributes
See Mail::Message::Field/"Access to the content"
$obj->beautify
See Mail::Message::Field::Full/"Access to the content"
$obj->comment([STRING])
See Mail::Message::Field/"Access to the content"
$obj->createComment(STRING, OPTIONS)
Mail::Message::Field::Unstructured->createComment(STRING, OPTIONS)
See Mail::Message::Field::Full/"Access to the content"
$obj->createPhrase(STRING, OPTIONS)
Mail::Message::Field::Unstructured->createPhrase(STRING, OPTIONS)
See Mail::Message::Field::Full/"Access to the content"
$obj->study
See Mail::Message::Field/"Access to the content"
$obj->toDate([TIME])
Mail::Message::Field::Unstructured->toDate([TIME])
See Mail::Message::Field/"Access to the content"
$obj->toInt
See Mail::Message::Field/"Access to the content"
$obj->dateToTimestamp(STRING)
Mail::Message::Field::Unstructured->dateToTimestamp(STRING)
See Mail::Message::Field/"Other methods"
$obj->consume(LINE | (NAME,BODY|OBJECTS))
See Mail::Message::Field/"Internals"
$obj->decode(STRING, OPTIONS)
Mail::Message::Field::Unstructured->decode(STRING, OPTIONS)
See Mail::Message::Field::Full/"Internals"
$obj->defaultWrapLength([LENGTH])
See Mail::Message::Field/"Internals"
$obj->encode(STRING, OPTIONS)
See Mail::Message::Field::Full/"Internals"
$obj->fold(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Unstructured->fold(NAME, BODY, [MAXCHARS])
See Mail::Message::Field/"Internals"
$obj->setWrapLength([LENGTH])
See Mail::Message::Field/"Internals"
$obj->stringifyData(STRING|ARRAY|OBJECTS)
See Mail::Message::Field/"Internals"
$obj->unfold(STRING)
See Mail::Message::Field/"Internals"
$obj->consumeComment(STRING)
Mail::Message::Field::Unstructured->consumeComment(STRING)
See Mail::Message::Field::Full/"Parsing"
$obj->consumeDotAtom(STRING)
See Mail::Message::Field::Full/"Parsing"
$obj->consumePhrase(STRING)
Mail::Message::Field::Unstructured->consumePhrase(STRING)
See Mail::Message::Field::Full/"Parsing"
$obj->parse(STRING)
See Mail::Message::Field::Full/"Parsing"
$obj->produceBody
See Mail::Message::Field::Full/"Parsing"
$obj->AUTOLOAD
See Mail::Reporter/"Error handling"
$obj->addReport(OBJECT)
See Mail::Reporter/"Error handling"
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Unstructured->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See Mail::Reporter/"Error handling"
$obj->errors
See Mail::Reporter/"Error handling"
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Field::Unstructured->log([LEVEL [,STRINGS]])
See Mail::Reporter/"Error handling"
$obj->logPriority(LEVEL)
Mail::Message::Field::Unstructured->logPriority(LEVEL)
See Mail::Reporter/"Error handling"
$obj->logSettings
See Mail::Reporter/"Error handling"
$obj->notImplemented
See Mail::Reporter/"Error handling"
$obj->report([LEVEL])
See Mail::Reporter/"Error handling"
$obj->reportAll([LEVEL])
See Mail::Reporter/"Error handling"
$obj->trace([LEVEL])
See Mail::Reporter/"Error handling"
$obj->warnings
See Mail::Reporter/"Error handling"
$obj->DESTROY
$obj->inGlobalDestruction
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.
This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/
Copyrights 2001-2008 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