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 "OVERLOADED" in Mail::Message::Field
overload: +0
overload: <=>
overload: bool
overload: cmp
overload: stringification
See "OVERLOADED" in Mail::Message::Field::Full
$obj->clone
See "Constructors" in Mail::Message::Field
Mail::Message::Field::Unstructured->from(FIELD, OPTIONS)
See "Constructors" in Mail::Message::Field::Full
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.
undef
-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'
'q'
'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 "The field" in Mail::Message::Field
$obj->length
$obj->nrLines
$obj->print([FILEHANDLE])
$obj->size
$obj->string([WRAP])
$obj->toDisclose
$obj->Name
See "Access to the name" in Mail::Message::Field
$obj->name
$obj->wellformedName([STRING])
$obj->body
See "Access to the body" in Mail::Message::Field
$obj->decodedBody(OPTIONS)
See "Access to the body" in Mail::Message::Field::Full
$obj->folded
$obj->foldedBody([BODY])
$obj->stripCFWS([STRING])
Mail::Message::Field::Unstructured->stripCFWS([STRING])
$obj->unfoldedBody([BODY, [WRAP]])
$obj->addresses
See "Access to the content" in Mail::Message::Field
$obj->attribute(NAME [, VALUE])
$obj->attributes
$obj->beautify
See "Access to the content" in Mail::Message::Field::Full
$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
$obj->dateToTimestamp(STRING)
Mail::Message::Field::Unstructured->dateToTimestamp(STRING)
See "Other methods" in Mail::Message::Field
$obj->consume(LINE | (NAME,BODY|OBJECTS))
See "Internals" in Mail::Message::Field
$obj->decode(STRING, OPTIONS)
Mail::Message::Field::Unstructured->decode(STRING, OPTIONS)
See "Internals" in Mail::Message::Field::Full
$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)
$obj->consumeComment(STRING)
Mail::Message::Field::Unstructured->consumeComment(STRING)
See "Parsing" in Mail::Message::Field::Full
$obj->consumeDotAtom(STRING)
$obj->consumePhrase(STRING)
Mail::Message::Field::Unstructured->consumePhrase(STRING)
$obj->parse(STRING)
$obj->produceBody
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$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
$obj->DESTROY
See "Cleanup" in Mail::Reporter
$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.
Lines
Content-Length
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.
b
B
q
Q
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.066. 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.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.