# Mail::Message::Field::Flex - one line of a message header - perldoc - [phpMan]

## NAME
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown) - one line of a message header

## INHERITANCE
     [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)
       is a [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)
       is a [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

## 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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFast/markdown) is faster (as the name predicts).

    Extends "DESCRIPTION" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

## OVERLOADED
    Extends "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    overload: ""
        Inherited, see "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    overload: 0+
        Inherited, see "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    overload: <=>
        Inherited, see "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    overload: bool
        Inherited, see "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    overload: cmp
        Inherited, see "OVERLOADED" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

## METHODS
    Extends "METHODS" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

### Constructors
    Extends "Constructors" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->clone()
        Inherited, see "Constructors" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->new($data)
        If you stick to this flexible class of header fields, you have a bit more facilities than
        with [Mail::Message::Field::Fast](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFast/markdown). 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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown):

         -Option    --Defined in     --Default
          attributes                   []
          comment                      undef
          log         [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)   'WARNINGS'
          trace       [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)   '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
    Extends "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->isStructured()
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->isStructured()
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->length()
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->nrLines()
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->print( [$fh] )
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->size()
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->string( [$wrap] )
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->toDisclose()
        Inherited, see "The field" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Access to the name
    Extends "Access to the name" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->Name()
        Inherited, see "Access to the name" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->name()
        Inherited, see "Access to the name" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->wellformedName( [STRING] )
        Inherited, see "Access to the name" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Access to the body
    Extends "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->body()
        Inherited, see "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->folded()
        Inherited, see "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->foldedBody( [$body] )
        Inherited, see "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->stripCFWS( [STRING] )
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->stripCFWS( [STRING] )
        Inherited, see "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->unfoldedBody( [$body, [$wrap]] )
        Inherited, see "Access to the body" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Access to the content
    Extends "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->addresses()
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->attribute( $name, [$value] )
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->attributes()
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->comment( [STRING] )
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->study()
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->toDate( [$time] )
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->toDate( [$time] )
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->toInt()
        Inherited, see "Access to the content" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Other methods
    Extends "Other methods" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->dateToTimestamp(STRING)
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->dateToTimestamp(STRING)
        Inherited, see "Other methods" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Internals
    Extends "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->consume( $line | <$name,<$body|$objects>> )
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->defaultWrapLength( [$length] )
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->fold( $name, $body, [$maxchars] )
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->fold( $name, $body, [$maxchars] )
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->setWrapLength( [$length] )
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->stringifyData(STRING|ARRAY|$objects)
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

    $obj->unfold(STRING)
        Inherited, see "Internals" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown)

### Error handling
    Extends "Error handling" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->AUTOLOAD()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->addReport($object)
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback]
    )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->errors()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->log( [$level, [$strings]] )
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->log( [$level, [$strings]] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->logPriority($level)
    [Mail::Message::Field::Flex](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField%3A%3AFlex/markdown)->logPriority($level)
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->logSettings()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->notImplemented()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->report( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->reportAll( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->trace( [$level] )
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

    $obj->warnings()
        Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

### Cleanup
    Extends "Cleanup" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

    $obj->DESTROY()
        Inherited, see "Cleanup" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown)

## DETAILS
    Extends "DETAILS" in [Mail::Message::Field](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AField/markdown).

## 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.

    Error: Field name too long (max $length), in '$name'
        It is not specified in the RFCs how long a field name can be, but at least it should be a
        few characters shorter than the line wrap.

    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-Message distribution version 3.015, built on December 11, 2023.
    Website: <http://perl.overmeer.net/CPAN/>

## LICENSE
    Copyrights 2001-2023 by [Mark Overmeer <<markov@cpan.org>>]. 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://dev.perl.org/licenses/>