• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• OVERLOADED
• METHODS
• Constructors
• The field
• Access to the name
• Access to the body
• Access to the content
• Other methods
• Internals
• Parsing
• Error handling
• Cleanup
• DIAGNOSTICS
• DETAILS
• REFERENCES
• COPYRIGHTS

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::Reporter

SYNOPSIS

 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: ``''

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

METHODS

Constructors

$obj->clone

See Constructors in the Mail::Message::Field manpage

Mail::Message::Field::Unstructured->from(FIELD, OPTIONS)

See Constructors in the Mail::Message::Field::Full manpage

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   L<Mail::Message::Field::Full>  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'>

. 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

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

Access to the name

$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

Access to the body

$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::Unstructured->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

Access to the content

$obj->addresses

See Access to the content in the Mail::Message::Field manpage

$obj->attribute(NAME [, VALUE])

See Access to the content in the Mail::Message::Field manpage

$obj->attributes

See Access to the content in the Mail::Message::Field manpage

$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::Unstructured->createComment(STRING, OPTIONS)

See Access to the content in the Mail::Message::Field::Full manpage

$obj->createPhrase(STRING, OPTIONS)

Mail::Message::Field::Unstructured->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::Unstructured->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

Other methods

$obj->dateToTimestamp(STRING)

Mail::Message::Field::Unstructured->dateToTimestamp(STRING)

See Other methods in the Mail::Message::Field manpage

Internals

$obj->consume(LINE | (NAME,BODY|OBJECTS))

See Internals in the Mail::Message::Field manpage

$obj->decode(STRING, OPTIONS)

Mail::Message::Field::Unstructured->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::Unstructured->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

Parsing

$obj->consumeComment(STRING)

Mail::Message::Field::Unstructured->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::Unstructured->consumePhrase(STRING)

See Parsing in the Mail::Message::Field::Full manpage

$obj->parse(STRING)

See Parsing in the Mail::Message::Field::Full manpage

$obj->produceBody

See Parsing in the Mail::Message::Field::Full manpage

Error handling

$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::Unstructured->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::Unstructured->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Message::Field::Unstructured->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

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Reporter manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

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.