.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::Message::Field::Flex 3"
.TH Mail::Message::Field::Flex 3 2024-01-06 "perl v5.38.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mail::Message::Field::Flex \- one line of a message header
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\& Mail::Message::Field::Flex
\&   is a Mail::Message::Field
\&   is a Mail::Reporter
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "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
(\f(CW\*(C`new\*(C'\fR) and initializer (\f(CW\*(C`init\*(C'\fR) are split.  However, you pay the
price in performance.  Mail::Message::Field::Fast is faster (as the
name predicts).
.PP
Extends "DESCRIPTION" in Mail::Message::Field.
.SH OVERLOADED
.IX Header "OVERLOADED"
Extends "OVERLOADED" in Mail::Message::Field.
.IP "overload: \fB""""\fR" 4
.IX Item "overload: """""
Inherited, see "OVERLOADED" in Mail::Message::Field
.IP "overload: \fB0+\fR" 4
.IX Item "overload: 0+"
Inherited, see "OVERLOADED" in Mail::Message::Field
.IP "overload: \fB<=\fR>" 4
.IX Item "overload: <=>"
Inherited, see "OVERLOADED" in Mail::Message::Field
.IP "overload: \fBbool\fR" 4
.IX Item "overload: bool"
Inherited, see "OVERLOADED" in Mail::Message::Field
.IP "overload: \fBcmp\fR" 4
.IX Item "overload: cmp"
Inherited, see "OVERLOADED" in Mail::Message::Field
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Mail::Message::Field.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Mail::Message::Field.
.ie n .IP $obj\->\fBclone\fR() 4
.el .IP \f(CW$obj\fR\->\fBclone\fR() 4
.IX Item "$obj->clone()"
Inherited, see "Constructors" in Mail::Message::Field
.IP Mail::Message::Field::Flex\->\fBnew\fR($data) 4
.IX Item "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:
.RS 4
.IP \(bu 4
\&\fBnew\fR LINE
.Sp
ass a LINE as it could be found in a file: a (possibly folded) line
which is terminated by a new-line.
.IP \(bu 4
\&\fBnew\fR NAME, (BODY|OBJECTS), [ATTRIBUTES], OPTIONS
.Sp
A set of values which shape the line.
.RE
.RS 4
.Sp
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:
.Sp
.Vb 5
\& \-Option    \-\-Defined in     \-\-Default
\&  attributes                   []
\&  comment                      undef
\&  log         Mail::Reporter   \*(AqWARNINGS\*(Aq
\&  trace       Mail::Reporter   \*(AqWARNINGS\*(Aq
.Ve
.IP "attributes => ATTRS" 2
.IX Item "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.
.IP "comment => STRING" 2
.IX Item "comment => STRING"
A pre-formatted list of attributes.
.IP "log => LEVEL" 2
.IX Item "log => LEVEL"
.PD 0
.IP "trace => LEVEL" 2
.IX Item "trace => LEVEL"
.RE
.RS 4
.RE
.PD
.SS "The field"
.IX Subsection "The field"
Extends "The field" in Mail::Message::Field.
.ie n .IP $obj\->\fBisStructured\fR() 4
.el .IP \f(CW$obj\fR\->\fBisStructured\fR() 4
.IX Item "$obj->isStructured()"
.PD 0
.IP Mail::Message::Field::Flex\->\fBisStructured\fR() 4
.IX Item "Mail::Message::Field::Flex->isStructured()"
.PD
Inherited, see "The field" in Mail::Message::Field
.ie n .IP $obj\->\fBlength\fR() 4
.el .IP \f(CW$obj\fR\->\fBlength\fR() 4
.IX Item "$obj->length()"
Inherited, see "The field" in Mail::Message::Field
.ie n .IP $obj\->\fBnrLines\fR() 4
.el .IP \f(CW$obj\fR\->\fBnrLines\fR() 4
.IX Item "$obj->nrLines()"
Inherited, see "The field" in Mail::Message::Field
.ie n .IP "$obj\->\fBprint\fR( [$fh] )" 4
.el .IP "\f(CW$obj\fR\->\fBprint\fR( [$fh] )" 4
.IX Item "$obj->print( [$fh] )"
Inherited, see "The field" in Mail::Message::Field
.ie n .IP $obj\->\fBsize\fR() 4
.el .IP \f(CW$obj\fR\->\fBsize\fR() 4
.IX Item "$obj->size()"
Inherited, see "The field" in Mail::Message::Field
.ie n .IP "$obj\->\fBstring\fR( [$wrap] )" 4
.el .IP "\f(CW$obj\fR\->\fBstring\fR( [$wrap] )" 4
.IX Item "$obj->string( [$wrap] )"
Inherited, see "The field" in Mail::Message::Field
.ie n .IP $obj\->\fBtoDisclose\fR() 4
.el .IP \f(CW$obj\fR\->\fBtoDisclose\fR() 4
.IX Item "$obj->toDisclose()"
Inherited, see "The field" in Mail::Message::Field
.SS "Access to the name"
.IX Subsection "Access to the name"
Extends "Access to the name" in Mail::Message::Field.
.ie n .IP $obj\->\fBName\fR() 4
.el .IP \f(CW$obj\fR\->\fBName\fR() 4
.IX Item "$obj->Name()"
Inherited, see "Access to the name" in Mail::Message::Field
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Access to the name" in Mail::Message::Field
.ie n .IP "$obj\->\fBwellformedName\fR( [STRING] )" 4
.el .IP "\f(CW$obj\fR\->\fBwellformedName\fR( [STRING] )" 4
.IX Item "$obj->wellformedName( [STRING] )"
Inherited, see "Access to the name" in Mail::Message::Field
.SS "Access to the body"
.IX Subsection "Access to the body"
Extends "Access to the body" in Mail::Message::Field.
.ie n .IP $obj\->\fBbody\fR() 4
.el .IP \f(CW$obj\fR\->\fBbody\fR() 4
.IX Item "$obj->body()"
Inherited, see "Access to the body" in Mail::Message::Field
.ie n .IP $obj\->\fBfolded\fR() 4
.el .IP \f(CW$obj\fR\->\fBfolded\fR() 4
.IX Item "$obj->folded()"
Inherited, see "Access to the body" in Mail::Message::Field
.ie n .IP "$obj\->\fBfoldedBody\fR( [$body] )" 4
.el .IP "\f(CW$obj\fR\->\fBfoldedBody\fR( [$body] )" 4
.IX Item "$obj->foldedBody( [$body] )"
Inherited, see "Access to the body" in Mail::Message::Field
.ie n .IP "$obj\->\fBstripCFWS\fR( [STRING] )" 4
.el .IP "\f(CW$obj\fR\->\fBstripCFWS\fR( [STRING] )" 4
.IX Item "$obj->stripCFWS( [STRING] )"
.PD 0
.IP "Mail::Message::Field::Flex\->\fBstripCFWS\fR( [STRING] )" 4
.IX Item "Mail::Message::Field::Flex->stripCFWS( [STRING] )"
.PD
Inherited, see "Access to the body" in Mail::Message::Field
.ie n .IP "$obj\->\fBunfoldedBody\fR( [$body, [$wrap]] )" 4
.el .IP "\f(CW$obj\fR\->\fBunfoldedBody\fR( [$body, [$wrap]] )" 4
.IX Item "$obj->unfoldedBody( [$body, [$wrap]] )"
Inherited, see "Access to the body" in Mail::Message::Field
.SS "Access to the content"
.IX Subsection "Access to the content"
Extends "Access to the content" in Mail::Message::Field.
.ie n .IP $obj\->\fBaddresses\fR() 4
.el .IP \f(CW$obj\fR\->\fBaddresses\fR() 4
.IX Item "$obj->addresses()"
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP "$obj\->\fBattribute\fR( $name, [$value] )" 4
.el .IP "\f(CW$obj\fR\->\fBattribute\fR( \f(CW$name\fR, [$value] )" 4
.IX Item "$obj->attribute( $name, [$value] )"
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP $obj\->\fBattributes\fR() 4
.el .IP \f(CW$obj\fR\->\fBattributes\fR() 4
.IX Item "$obj->attributes()"
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP "$obj\->\fBcomment\fR( [STRING] )" 4
.el .IP "\f(CW$obj\fR\->\fBcomment\fR( [STRING] )" 4
.IX Item "$obj->comment( [STRING] )"
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP $obj\->\fBstudy\fR() 4
.el .IP \f(CW$obj\fR\->\fBstudy\fR() 4
.IX Item "$obj->study()"
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP "$obj\->\fBtoDate\fR( [$time] )" 4
.el .IP "\f(CW$obj\fR\->\fBtoDate\fR( [$time] )" 4
.IX Item "$obj->toDate( [$time] )"
.PD 0
.IP "Mail::Message::Field::Flex\->\fBtoDate\fR( [$time] )" 4
.IX Item "Mail::Message::Field::Flex->toDate( [$time] )"
.PD
Inherited, see "Access to the content" in Mail::Message::Field
.ie n .IP $obj\->\fBtoInt\fR() 4
.el .IP \f(CW$obj\fR\->\fBtoInt\fR() 4
.IX Item "$obj->toInt()"
Inherited, see "Access to the content" in Mail::Message::Field
.SS "Other methods"
.IX Subsection "Other methods"
Extends "Other methods" in Mail::Message::Field.
.ie n .IP $obj\->\fBdateToTimestamp\fR(STRING) 4
.el .IP \f(CW$obj\fR\->\fBdateToTimestamp\fR(STRING) 4
.IX Item "$obj->dateToTimestamp(STRING)"
.PD 0
.IP Mail::Message::Field::Flex\->\fBdateToTimestamp\fR(STRING) 4
.IX Item "Mail::Message::Field::Flex->dateToTimestamp(STRING)"
.PD
Inherited, see "Other methods" in Mail::Message::Field
.SS Internals
.IX Subsection "Internals"
Extends "Internals" in Mail::Message::Field.
.ie n .IP "$obj\->\fBconsume\fR( $line | <$name,<$body|$objects>> )" 4
.el .IP "\f(CW$obj\fR\->\fBconsume\fR( \f(CW$line\fR | <$name,<$body|$objects>> )" 4
.IX Item "$obj->consume( $line | <$name,<$body|$objects>> )"
Inherited, see "Internals" in Mail::Message::Field
.ie n .IP "$obj\->\fBdefaultWrapLength\fR( [$length] )" 4
.el .IP "\f(CW$obj\fR\->\fBdefaultWrapLength\fR( [$length] )" 4
.IX Item "$obj->defaultWrapLength( [$length] )"
Inherited, see "Internals" in Mail::Message::Field
.ie n .IP "$obj\->\fBfold\fR( $name, $body, [$maxchars] )" 4
.el .IP "\f(CW$obj\fR\->\fBfold\fR( \f(CW$name\fR, \f(CW$body\fR, [$maxchars] )" 4
.IX Item "$obj->fold( $name, $body, [$maxchars] )"
.PD 0
.ie n .IP "Mail::Message::Field::Flex\->\fBfold\fR( $name, $body, [$maxchars] )" 4
.el .IP "Mail::Message::Field::Flex\->\fBfold\fR( \f(CW$name\fR, \f(CW$body\fR, [$maxchars] )" 4
.IX Item "Mail::Message::Field::Flex->fold( $name, $body, [$maxchars] )"
.PD
Inherited, see "Internals" in Mail::Message::Field
.ie n .IP "$obj\->\fBsetWrapLength\fR( [$length] )" 4
.el .IP "\f(CW$obj\fR\->\fBsetWrapLength\fR( [$length] )" 4
.IX Item "$obj->setWrapLength( [$length] )"
Inherited, see "Internals" in Mail::Message::Field
.ie n .IP $obj\->\fBstringifyData\fR(STRING|ARRAY|$objects) 4
.el .IP \f(CW$obj\fR\->\fBstringifyData\fR(STRING|ARRAY|$objects) 4
.IX Item "$obj->stringifyData(STRING|ARRAY|$objects)"
Inherited, see "Internals" in Mail::Message::Field
.ie n .IP $obj\->\fBunfold\fR(STRING) 4
.el .IP \f(CW$obj\fR\->\fBunfold\fR(STRING) 4
.IX Item "$obj->unfold(STRING)"
Inherited, see "Internals" in Mail::Message::Field
.SS "Error handling"
.IX Subsection "Error handling"
Extends "Error handling" in Mail::Message::Field.
.ie n .IP $obj\->\fBAUTOLOAD\fR() 4
.el .IP \f(CW$obj\fR\->\fBAUTOLOAD\fR() 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBaddReport\fR($object) 4
.el .IP \f(CW$obj\fR\->\fBaddReport\fR($object) 4
.IX Item "$obj->addReport($object)"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP "$obj\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "\f(CW$obj\fR\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD 0
.ie n .IP "Mail::Message::Field::Flex\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "Mail::Message::Field::Flex\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "Mail::Message::Field::Flex->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBerrors\fR() 4
.el .IP \f(CW$obj\fR\->\fBerrors\fR() 4
.IX Item "$obj->errors()"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP "$obj\->\fBlog\fR( [$level, [$strings]] )" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "$obj->log( [$level, [$strings]] )"
.PD 0
.IP "Mail::Message::Field::Flex\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "Mail::Message::Field::Flex->log( [$level, [$strings]] )"
.PD
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBlogPriority\fR($level) 4
.el .IP \f(CW$obj\fR\->\fBlogPriority\fR($level) 4
.IX Item "$obj->logPriority($level)"
.PD 0
.IP Mail::Message::Field::Flex\->\fBlogPriority\fR($level) 4
.IX Item "Mail::Message::Field::Flex->logPriority($level)"
.PD
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBlogSettings\fR() 4
.el .IP \f(CW$obj\fR\->\fBlogSettings\fR() 4
.IX Item "$obj->logSettings()"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBnotImplemented\fR() 4
.el .IP \f(CW$obj\fR\->\fBnotImplemented\fR() 4
.IX Item "$obj->notImplemented()"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP "$obj\->\fBreport\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreport\fR( [$level] )" 4
.IX Item "$obj->report( [$level] )"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP "$obj\->\fBreportAll\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreportAll\fR( [$level] )" 4
.IX Item "$obj->reportAll( [$level] )"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP "$obj\->\fBtrace\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBtrace\fR( [$level] )" 4
.IX Item "$obj->trace( [$level] )"
Inherited, see "Error handling" in Mail::Reporter
.ie n .IP $obj\->\fBwarnings\fR() 4
.el .IP \f(CW$obj\fR\->\fBwarnings\fR() 4
.IX Item "$obj->warnings()"
Inherited, see "Error handling" in Mail::Reporter
.SS Cleanup
.IX Subsection "Cleanup"
Extends "Cleanup" in Mail::Message::Field.
.ie n .IP $obj\->\fBDESTROY\fR() 4
.el .IP \f(CW$obj\fR\->\fBDESTROY\fR() 4
.IX Item "$obj->DESTROY()"
Inherited, see "Cleanup" in Mail::Reporter
.SH DETAILS
.IX Header "DETAILS"
Extends "DETAILS" in Mail::Message::Field.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.ie n .IP "Warning: Field content is not numerical: $content" 4
.el .IP "Warning: Field content is not numerical: \f(CW$content\fR" 4
.IX Item "Warning: Field content is not numerical: $content"
The numeric value of a field is requested (for instance the \f(CW\*(C`Lines\*(C'\fR or
\&\f(CW\*(C`Content\-Length\*(C'\fR fields should be numerical), however the data contains
weird characters.
.ie n .IP "Error: Field name too long (max $length), in '$name'" 4
.el .IP "Error: Field name too long (max \f(CW$length\fR), in '$name'" 4
.IX Item "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.
.ie n .IP "Warning: Illegal character in field name $name" 4
.el .IP "Warning: Illegal character in field name \f(CW$name\fR" 4
.IX Item "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.
.ie n .IP "Error: Package $package does not implement $method." 4
.el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4
.IX Item "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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail-Message distribution version 3.015,
built on December 11, 2023. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
Copyrights 2001\-2023 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR