.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::Message::Field::Structured 3pm"
.TH Mail::Message::Field::Structured 3pm "2014-08-24" "perl v5.20.0" "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::Structured \- one line of a structured message header
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 4
\& Mail::Message::Field::Structured
\&   is a Mail::Message::Field::Full
\&   is a Mail::Message::Field
\&   is a Mail::Reporter
\&
\& Mail::Message::Field::Structured is extended by
\&   Mail::Message::Field::Addresses
\&   Mail::Message::Field::Date
\&   Mail::Message::Field::URIs
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& my $f = Mail::Message::Field::Full
\&            \->new(\*(AqContent\-Type\*(Aq => \*(Aqtext/html\*(Aq);
\&
\& my @encode = (charset => \*(Aqjp\*(Aq, use_continuations => 1);
\& $f\->attribute(\*(Aqfilename=passwd\*(Aq);
\& $f\->attribute(filename => \*(Aqpasswd\*(Aq, @encode);
\&
\& my $attr = Mail::Message::Field::Attribute\->new(...);
\& $f\->attribute($attr);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Message::Field::Full.
.SH "OVERLOADED"
.IX Header "OVERLOADED"
Extends \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field::Full.
.ie n .IP "overload: \fB""""\fR" 4
.el .IP "overload: \fB``''\fR" 4
.IX Item "overload: """""
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field
.IP "overload: \fB0+\fR" 4
.IX Item "overload: 0+"
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field
.IP "overload: \fB<=\fR>" 4
.IX Item "overload: <=>"
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field
.IP "overload: \fBbool\fR" 4
.IX Item "overload: bool"
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field
.IP "overload: \fBcmp\fR" 4
.IX Item "overload: cmp"
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field
.IP "overload: \fBstringification\fR" 4
.IX Item "overload: stringification"
Inherited, see \*(L"\s-1OVERLOADED\*(R"\s0 in Mail::Message::Field::Full
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Message::Field::Full.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBclone\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBclone\fR()" 4
.IX Item "$obj->clone()"
Inherited, see \*(L"Constructors\*(R" in Mail::Message::Field
.ie n .IP "Mail::Message::Field::Structured\->\fBfrom\fR($field, %options)" 4
.el .IP "Mail::Message::Field::Structured\->\fBfrom\fR($field, \f(CW%options\fR)" 4
.IX Item "Mail::Message::Field::Structured->from($field, %options)"
Inherited, see \*(L"Constructors\*(R" in Mail::Message::Field::Full
.IP "Mail::Message::Field::Structured\->\fBnew\fR($data)" 4
.IX Item "Mail::Message::Field::Structured->new($data)"
.RS 4
.PD 0
.IP "\(bu" 4
.PD
\&\fBnew\fR \s-1LINE\s0
.Sp
Pass a \s-1LINE\s0 as it could be found in a file: a (possibly folded) line
which is terminated by a new-line.
.IP "\(bu" 4
\&\fBnew\fR \s-1NAME, BODY, OPTIONS\s0
.Sp
A set of values which shape the line.
.RE
.RS 4
.Sp
The \s-1NAME\s0 is a wellformed header name (you may use \fIwellformedName()\fR) to
be sure about the casing.  The \s-1BODY\s0 is a string, one object, or an
ref-array of objects.  In case of objects, they must fit to the
constructor of the field: the types which are accepted may differ.
The optional \s-1ATTRIBUTE\s0 list contains Mail::Message::Field::Attribute
objects.  Finally, there are some \s-1OPTIONS.\s0
.Sp
.Vb 9
\& \-Option    \-\-Defined in                \-\-Default
\&  attributes                              []
\&  charset     Mail::Message::Field::Full  undef
\&  datum                                   undef
\&  encoding    Mail::Message::Field::Full  \*(Aqq\*(Aq
\&  force       Mail::Message::Field::Full  false
\&  language    Mail::Message::Field::Full  undef
\&  log         Mail::Reporter              \*(AqWARNINGS\*(Aq
\&  trace       Mail::Reporter              \*(AqWARNINGS\*(Aq
.Ve
.IP "attributes => \s-1ATTRS\s0" 2
.IX Item "attributes => ATTRS"
There are various ways to specify these attributes: pass a reference
to an array which list of key-value pairs representing attributes,
or reference to a hash containing these pairs, or an array with
Mail::Message::Field::Attribute objects.
.IP "charset => \s-1STRING\s0" 2
.IX Item "charset => STRING"
.PD 0
.IP "datum => \s-1STRING\s0" 2
.IX Item "datum => STRING"
.PD
The method name \fIbody\fR is very confusing, even in the \s-1RFC. \s0 In MailBox,
for historical reasons, \fIbody()\fR returns the part of the field contents
before the first semi-colon.  \fIfoldedBody()\fR and \fIunfoldedBody()\fR
address the whole field.
.Sp
There is no common name for the piece of data before the parameters
(attributes) in the field-content mentioned in the RFCs, so let's call
it \fBdatum\fR.
.IP "encoding => 'q'|'Q'|'b'|'B'" 2
.IX Item "encoding => 'q'|'Q'|'b'|'B'"
.PD 0
.IP "force => \s-1BOOLEAN\s0" 2
.IX Item "force => BOOLEAN"
.IP "language => \s-1STRING\s0" 2
.IX Item "language => STRING"
.IP "log => \s-1LEVEL\s0" 2
.IX Item "log => LEVEL"
.IP "trace => \s-1LEVEL\s0" 2
.IX Item "trace => LEVEL"
.RE
.RS 4
.PD
.Sp
example: of a structured field
.Sp
.Vb 3
\& my @attrs   = (Mail::Message::Field::Attribute\->new(...), ...);
\& my @options = (extra => \*(Aqthe color blue\*(Aq);
\& my $t = Mail::Message::Field::Full\->new(To => \e@addrs, @attrs, @options);
.Ve
.RE
.SS "The field"
.IX Subsection "The field"
Extends \*(L"The field\*(R" in Mail::Message::Field::Full.
.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::Structured\->\fBisStructured\fR()" 4
.IX Item "Mail::Message::Field::Structured->isStructured()"
.PD
Inherited, see \*(L"The field\*(R" 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 \*(L"The field\*(R" 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 \*(L"The field\*(R" 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 \*(L"The field\*(R" 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 \*(L"The field\*(R" 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 \*(L"The field\*(R" 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 \*(L"The field\*(R" in Mail::Message::Field
.SS "Access to the name"
.IX Subsection "Access to the name"
Extends \*(L"Access to the name\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBName\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBName\fR()" 4
.IX Item "$obj->Name()"
Inherited, see \*(L"Access to the name\*(R" 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 \*(L"Access to the name\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBwellformedName\fR( [\s-1STRING\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBwellformedName\fR( [\s-1STRING\s0] )" 4
.IX Item "$obj->wellformedName( [STRING] )"
Inherited, see \*(L"Access to the name\*(R" in Mail::Message::Field
.SS "Access to the body"
.IX Subsection "Access to the body"
Extends \*(L"Access to the body\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBbody\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBbody\fR()" 4
.IX Item "$obj->body()"
Inherited, see \*(L"Access to the body\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBdecodedBody\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBdecodedBody\fR(%options)" 4
.IX Item "$obj->decodedBody(%options)"
Inherited, see \*(L"Access to the body\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBfolded\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBfolded\fR()" 4
.IX Item "$obj->folded()"
Inherited, see \*(L"Access to the body\*(R" 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 \*(L"Access to the body\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBstripCFWS\fR( [\s-1STRING\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBstripCFWS\fR( [\s-1STRING\s0] )" 4
.IX Item "$obj->stripCFWS( [STRING] )"
.PD 0
.IP "Mail::Message::Field::Structured\->\fBstripCFWS\fR( [\s-1STRING\s0] )" 4
.IX Item "Mail::Message::Field::Structured->stripCFWS( [STRING] )"
.PD
Inherited, see \*(L"Access to the body\*(R" 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 \*(L"Access to the body\*(R" in Mail::Message::Field
.SS "Access to the content"
.IX Subsection "Access to the content"
Extends \*(L"Access to the content\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBaddresses\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBaddresses\fR()" 4
.IX Item "$obj->addresses()"
Inherited, see \*(L"Access to the content\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBattrPairs\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBattrPairs\fR()" 4
.IX Item "$obj->attrPairs()"
Returns a list with attribute name and value pairs.
.ie n .IP "$obj\->\fBattribute\fR( $object|<\s-1STRING,\s0 %options>|<$name,$value,%options> )" 4
.el .IP "\f(CW$obj\fR\->\fBattribute\fR( \f(CW$object\fR|<\s-1STRING,\s0 \f(CW%options\fR>|<$name,$value,%options> )" 4
.IX Item "$obj->attribute( $object|<STRING, %options>|<$name,$value,%options> )"
Add an attribute to the field.  The attributes are added left-to-right into
the string representation of the field, although the order of the attributes
is un-important, according to the RFCs.
.Sp
You may pass a fully prepared Mail::Message::Field::Attribute \f(CW$object\fR,
if you like to do all preparations for correct representation of the
data yourself.  You may also pass one \s-1STRING,\s0 which is a fully prepared
attribute.  This \s-1STRING\s0 will not be changed, so be careful about quoting
and encodings.
.Sp
As third possibility, you can specify an attribute \f(CW$name\fR and its \f(CW$value\fR.
An attribute object will be created for you implicitly in both
cases where such object is not supplied, passing the \f(CW%options\fR.  See
\&\fIMail::Message::Field::Attribute::new()\fR about the available \f(CW%options\fR.
.Sp
The attribute object is returned, however, when continuations are used this
may be an object you already know about.  \f(CW\*(C`undef\*(C'\fR is returned when
construction fails (when the attribute is incorrect).
.Sp
example:
.Sp
.Vb 2
\& $f\->attribute(filename => \*(Aqpasswd\*(Aq);
\& $f\->attribute(filename => \*(Aqpasswd\*(Aq, use_continuations => 0);
\&
\& my $attr = Mail::Message::Field::Attribute\->new(...);
\& $f\->attribute($attr);
.Ve
.ie n .IP "$obj\->\fBattributes\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBattributes\fR()" 4
.IX Item "$obj->attributes()"
Returns a list with all attributes, which are all
Mail::Message::Field::Attribute objects.  The attributes are not
ordered in any way.  The list may be empty.  Double attributes or
continuations are folded into one.
.ie n .IP "$obj\->\fBbeautify\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBbeautify\fR()" 4
.IX Item "$obj->beautify()"
Inherited, see \*(L"Access to the content\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBcomment\fR( [\s-1STRING\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBcomment\fR( [\s-1STRING\s0] )" 4
.IX Item "$obj->comment( [STRING] )"
Inherited, see \*(L"Access to the content\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBcreateComment\fR(\s-1STRING,\s0 %options)" 4
.el .IP "\f(CW$obj\fR\->\fBcreateComment\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "$obj->createComment(STRING, %options)"
.PD 0
.ie n .IP "Mail::Message::Field::Structured\->\fBcreateComment\fR(\s-1STRING,\s0 %options)" 4
.el .IP "Mail::Message::Field::Structured\->\fBcreateComment\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "Mail::Message::Field::Structured->createComment(STRING, %options)"
.PD
Inherited, see \*(L"Access to the content\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBcreatePhrase\fR(\s-1STRING,\s0 %options)" 4
.el .IP "\f(CW$obj\fR\->\fBcreatePhrase\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "$obj->createPhrase(STRING, %options)"
.PD 0
.ie n .IP "Mail::Message::Field::Structured\->\fBcreatePhrase\fR(\s-1STRING,\s0 %options)" 4
.el .IP "Mail::Message::Field::Structured\->\fBcreatePhrase\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "Mail::Message::Field::Structured->createPhrase(STRING, %options)"
.PD
Inherited, see \*(L"Access to the content\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBstudy\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBstudy\fR()" 4
.IX Item "$obj->study()"
Inherited, see \*(L"Access to the content\*(R" 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::Structured\->\fBtoDate\fR( [$time] )" 4
.IX Item "Mail::Message::Field::Structured->toDate( [$time] )"
.PD
Inherited, see \*(L"Access to the content\*(R" 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 \*(L"Access to the content\*(R" in Mail::Message::Field
.SS "Other methods"
.IX Subsection "Other methods"
Extends \*(L"Other methods\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBdateToTimestamp\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBdateToTimestamp\fR(\s-1STRING\s0)" 4
.IX Item "$obj->dateToTimestamp(STRING)"
.PD 0
.IP "Mail::Message::Field::Structured\->\fBdateToTimestamp\fR(\s-1STRING\s0)" 4
.IX Item "Mail::Message::Field::Structured->dateToTimestamp(STRING)"
.PD
Inherited, see \*(L"Other methods\*(R" in Mail::Message::Field
.SS "Internals"
.IX Subsection "Internals"
Extends \*(L"Internals\*(R" in Mail::Message::Field::Full.
.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 \*(L"Internals\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBdecode\fR(\s-1STRING,\s0 %options)" 4
.el .IP "\f(CW$obj\fR\->\fBdecode\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "$obj->decode(STRING, %options)"
.PD 0
.ie n .IP "Mail::Message::Field::Structured\->\fBdecode\fR(\s-1STRING,\s0 %options)" 4
.el .IP "Mail::Message::Field::Structured\->\fBdecode\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "Mail::Message::Field::Structured->decode(STRING, %options)"
.PD
Inherited, see \*(L"Internals\*(R" in Mail::Message::Field::Full
.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 \*(L"Internals\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBencode\fR(\s-1STRING,\s0 %options)" 4
.el .IP "\f(CW$obj\fR\->\fBencode\fR(\s-1STRING,\s0 \f(CW%options\fR)" 4
.IX Item "$obj->encode(STRING, %options)"
Inherited, see \*(L"Internals\*(R" in Mail::Message::Field::Full
.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::Structured\->\fBfold\fR( $name, $body, [$maxchars] )" 4
.el .IP "Mail::Message::Field::Structured\->\fBfold\fR( \f(CW$name\fR, \f(CW$body\fR, [$maxchars] )" 4
.IX Item "Mail::Message::Field::Structured->fold( $name, $body, [$maxchars] )"
.PD
Inherited, see \*(L"Internals\*(R" 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 \*(L"Internals\*(R" 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 \*(L"Internals\*(R" in Mail::Message::Field
.ie n .IP "$obj\->\fBunfold\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBunfold\fR(\s-1STRING\s0)" 4
.IX Item "$obj->unfold(STRING)"
Inherited, see \*(L"Internals\*(R" in Mail::Message::Field
.SS "Parsing"
.IX Subsection "Parsing"
Extends \*(L"Parsing\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fBconsumeComment\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBconsumeComment\fR(\s-1STRING\s0)" 4
.IX Item "$obj->consumeComment(STRING)"
.PD 0
.IP "Mail::Message::Field::Structured\->\fBconsumeComment\fR(\s-1STRING\s0)" 4
.IX Item "Mail::Message::Field::Structured->consumeComment(STRING)"
.PD
Inherited, see \*(L"Parsing\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBconsumeDotAtom\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBconsumeDotAtom\fR(\s-1STRING\s0)" 4
.IX Item "$obj->consumeDotAtom(STRING)"
Inherited, see \*(L"Parsing\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBconsumePhrase\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBconsumePhrase\fR(\s-1STRING\s0)" 4
.IX Item "$obj->consumePhrase(STRING)"
.PD 0
.IP "Mail::Message::Field::Structured\->\fBconsumePhrase\fR(\s-1STRING\s0)" 4
.IX Item "Mail::Message::Field::Structured->consumePhrase(STRING)"
.PD
Inherited, see \*(L"Parsing\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBdatum\fR( [$value] )" 4
.el .IP "\f(CW$obj\fR\->\fBdatum\fR( [$value] )" 4
.IX Item "$obj->datum( [$value] )"
The part of the field before the semi-colon (\f(CW\*(C`;\*(C'\fR).
.ie n .IP "$obj\->\fBparse\fR(\s-1STRING\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBparse\fR(\s-1STRING\s0)" 4
.IX Item "$obj->parse(STRING)"
Inherited, see \*(L"Parsing\*(R" in Mail::Message::Field::Full
.ie n .IP "$obj\->\fBproduceBody\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBproduceBody\fR()" 4
.IX Item "$obj->produceBody()"
Inherited, see \*(L"Parsing\*(R" in Mail::Message::Field::Full
.SS "Error handling"
.IX Subsection "Error handling"
Extends \*(L"Error handling\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fB\s-1AUTOLOAD\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1AUTOLOAD\s0\fR()" 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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::Structured\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "Mail::Message::Field::Structured\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "Mail::Message::Field::Structured->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD
Inherited, see \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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::Structured\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "Mail::Message::Field::Structured->log( [$level, [$strings]] )"
.PD
Inherited, see \*(L"Error handling\*(R" 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::Structured\->\fBlogPriority\fR($level)" 4
.IX Item "Mail::Message::Field::Structured->logPriority($level)"
.PD
Inherited, see \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" 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 \*(L"Error handling\*(R" in Mail::Reporter
.SS "Cleanup"
.IX Subsection "Cleanup"
Extends \*(L"Cleanup\*(R" in Mail::Message::Field::Full.
.ie n .IP "$obj\->\fB\s-1DESTROY\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1DESTROY\s0\fR()" 4
.IX Item "$obj->DESTROY()"
Inherited, see \*(L"Cleanup\*(R" in Mail::Reporter
.SH "DETAILS"
.IX Header "DETAILS"
Extends \*(L"\s-1DETAILS\*(R"\s0 in Mail::Message::Field::Full.
.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.
.IP "Warning: Illegal character in charset '$charset'" 4
.IX Item "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.
.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.
.IP "Warning: Illegal character in language '$lang'" 4
.IX Item "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.
.IP "Warning: Illegal encoding '$encoding', used 'q'" 4
.IX Item "Warning: Illegal encoding '$encoding', used 'q'"
The RFCs only permit base64 (\f(CW\*(C`b \*(C'\fR or \f(CW\*(C`B \*(C'\fR) or quoted-printable
(\f(CW\*(C`q\*(C'\fR or \f(CW\*(C`Q\*(C'\fR) encoding.  Other than these four options are illegal.
.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-Box distribution version 2.117,
built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2001\-2014 by [Mark Overmeer]. 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://www.perl.com/perl/misc/Artistic.html\fR