man Mail::Message::Field::Flex () - one line of a message header
NAME
Mail::Message::Field::Flex - one line of a message header
INHERITANCE
Mail::Message::Field::Flex is a Mail::Message::Field is a Mail::Reporter
SYNOPSIS
DESCRIPTION
This is the flexible implementation of a field: it can easily be extended because it stores its data in a hash and the constructor (CWnew) and initializer (CWinit) are split. However, you pay the price in performance. Mail::Message::Field::Fast is faster (as the name predicts).
OVERLOADED
overload: "" See OVERLOADED in Mail::Message::Field
overload: +0 See OVERLOADED in Mail::Message::Field
overload: <=> See OVERLOADED in Mail::Message::Field
overload: bool See OVERLOADED in Mail::Message::Field
overload: cmp See OVERLOADED in Mail::Message::Field
METHODS
Constructors
$obj->clone See Constructors in Mail::Message::Field
Mail::Message::Field::Flex->new(DATA) If you stick to this flexible class of header fields, you have a bit more facilities than with Mail::Message::Field::Fast. Amongst it, you can specify options with the creation. Possible arguments:
- * new LINE
- ass a LINE as it could be found in a file: a (possibly folded) line which is terminated by a new-line.
- * new NAME, (BODY|OBJECTS), [ATTRIBUTES], OPTIONS
-
A set of values which shape the line.
To be able to distinguish the different parameters, you will have
to specify the OPTIONS as ARRAY of option pairs, or HASH of options.
The ATTRIBUTES are a flat list of key-value pairs. The body is
specified as one BODY string, one OBJECT, or a reference to an array
of OBJECTS. See Mail::Message::Field:
Option Defined in Default attributes C<[]> comment undef log L<Mail::Reporter> C<'WARNINGS'> trace L<Mail::Reporter> C<'WARNINGS'>
. attributes ATTRS Reference to array with list of key-value pairs representing attributes, or reference to a hash containing these pairs. This is an alternative notation for specifying ATTRIBUTES directly as method arguments. . comment STRING A pre-formatted list of attributes. . log LEVEL . trace LEVEL
The field
$obj->isStructured
Mail::Message::Field::Flex->isStructured See The field in Mail::Message::Field
$obj->length See The field in Mail::Message::Field
$obj->nrLines See The field in Mail::Message::Field
$obj->print([FILEHANDLE]) See The field in Mail::Message::Field
$obj->size See The field in Mail::Message::Field
$obj->string([WRAP]) See The field in Mail::Message::Field
$obj->toDisclose See The field in Mail::Message::Field
Access to the name
$obj->Name See Access to the name in Mail::Message::Field
$obj->name See Access to the name in Mail::Message::Field
$obj->wellformedName([STRING]) See Access to the name in Mail::Message::Field
Access to the body
$obj->body See Access to the body in Mail::Message::Field
$obj->folded See Access to the body in Mail::Message::Field
$obj->foldedBody([BODY]) See Access to the body in Mail::Message::Field
$obj->stripCFWS([STRING])
Mail::Message::Field::Flex->stripCFWS([STRING]) See Access to the body in Mail::Message::Field
$obj->unfoldedBody([BODY, [WRAP]]) See Access to the body in Mail::Message::Field
Access to the content
$obj->addresses See Access to the content in Mail::Message::Field
$obj->attribute(NAME [, VALUE]) See Access to the content in Mail::Message::Field
$obj->attributes See Access to the content in Mail::Message::Field
$obj->comment([STRING]) See Access to the content in Mail::Message::Field
$obj->study See Access to the content in Mail::Message::Field
$obj->toDate([TIME])
Mail::Message::Field::Flex->toDate([TIME]) See Access to the content in Mail::Message::Field
$obj->toInt See Access to the content in Mail::Message::Field
Other methods
$obj->dateToTimestamp(STRING)
Mail::Message::Field::Flex->dateToTimestamp(STRING) See Other methods in Mail::Message::Field
Internals
$obj->consume(LINE | (NAME,BODY|OBJECTS)) See Internals in Mail::Message::Field
$obj->defaultWrapLength([LENGTH]) See Internals in Mail::Message::Field
$obj->fold(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Flex->fold(NAME, BODY, [MAXCHARS]) See Internals in Mail::Message::Field
$obj->setWrapLength([LENGTH]) See Internals in Mail::Message::Field
$obj->stringifyData(STRING|ARRAY|OBJECTS) See Internals in Mail::Message::Field
$obj->unfold(STRING) See Internals in Mail::Message::Field
Error handling
$obj->AUTOLOAD See Error handling in Mail::Reporter
$obj->addReport(OBJECT) See Error handling in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Flex->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj->errors See Error handling in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Field::Flex->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Message::Field::Flex->logPriority(LEVEL) See Error handling in Mail::Reporter
$obj->logSettings See Error handling in Mail::Reporter
$obj->notImplemented See Error handling in Mail::Reporter
$obj->report([LEVEL]) See Error handling in Mail::Reporter
$obj->reportAll([LEVEL]) See Error handling in Mail::Reporter
$obj->trace([LEVEL]) See Error handling in Mail::Reporter
$obj->warnings See Error handling in Mail::Reporter
Cleanup
$obj->DESTROY See Cleanup in Mail::Reporter
$obj->inGlobalDestruction See Cleanup in Mail::Reporter
DIAGNOSTICS
Warning: Field content is not numerical: CW$content
The numeric value of a field is requested (for instance the CWLines or CWContent-Length fields should be numerical), however the data contains weird characters.
Warning: Illegal character in field name CW$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.
Error: Package CW$package does not implement CW$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.063. 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.