/ 
Mail-Box-2.093
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Field::Flex

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 (new) and initializer (init) are split. However, you pay the price in performance. Mail::Message::Field::Fast is faster (as the name predicts).

OVERLOADED

overload: ""

overload: +0

overload: <=>

overload: bool

overload: cmp

METHODS

Constructors

$obj->clone

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                   []
comment                      undef
log         Mail::Reporter   'WARNINGS'
trace       Mail::Reporter   '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

$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->folded

$obj->foldedBody([BODY])

$obj->stripCFWS([STRING])

Mail::Message::Field::Flex->stripCFWS([STRING])

$obj->unfoldedBody([BODY, [WRAP]])

Access to the content

$obj->addresses

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

$obj->attributes

$obj->comment([STRING])

$obj->study

$obj->toDate([TIME])

Mail::Message::Field::Flex->toDate([TIME])

$obj->toInt

Other methods

$obj->dateToTimestamp(STRING)

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

Internals

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

$obj->defaultWrapLength([LENGTH])

$obj->fold(NAME, BODY, [MAXCHARS])

Mail::Message::Field::Flex->fold(NAME, BODY, [MAXCHARS])

$obj->setWrapLength([LENGTH])

$obj->stringifyData(STRING|ARRAY|OBJECTS)

$obj->unfold(STRING)

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Field::Flex->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Field::Flex->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

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

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.093, built on December 24, 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