lib/Mail/Message/Field/Unstructured.pod

=encoding utf8

=head1 NAME

Mail::Message::Field::Unstructured - smart unstructured field

=head1 INHERITANCE

 Mail::Message::Field::Unstructured
   is a Mail::Message::Field::Full
   is a Mail::Message::Field
   is a Mail::Reporter

=head1 SYNOPSIS

 my $f = Mail::Message::Field::Unstructured->new(Comments => 'hi!');

=head1 DESCRIPTION

Unstructured fields do contain information which is not restricted in
any way.  RFC2822 defines some unstructured fields, but by default all
unknown fields are unstructured as well.  Things like attributes and
comments have no meaning for unstructured fields, but encoding does.

See L<documentation in base class|Mail::Message::Field::Full/"DESCRIPTION">.
 
=head1 OVERLOADED

See L<documentation in base class|Mail::Message::Field::Full/"OVERLOADED">.
 
=over 4

=item overload: B<"">()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<0+>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<<=>>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<bool>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<cmp>()

See L<Mail::Message::Field/"OVERLOADED">

=item overload: B<stringification>()

See L<Mail::Message::Field::Full/"OVERLOADED">

=back

=head1 METHODS

See L<documentation in base class|Mail::Message::Field::Full/"METHODS">.
 
=head2 Constructors

See L<documentation in base class|Mail::Message::Field::Full/"Constructors">.
 
=over 4

=item $obj-E<gt>B<clone>()

See L<Mail::Message::Field/"Constructors">

=item Mail::Message::Field::Unstructured-E<gt>B<from>(FIELD, OPTIONS)

See L<Mail::Message::Field::Full/"Constructors">

=item Mail::Message::Field::Unstructured-E<gt>B<new>(DATA)

When the DATA is specified as single line, the content part is considered to
be correcly (character) encoded and escaped.  Typically, it is a line as
read from file.  The folding of the line is kept as is.

In case more than one argument is provided, the second is considered the BODY.
Attributes and other special things are not defined for unstructured fields,
and therefore not valid options.  The BODY can be a single string, a single
OBJECT, or an array of OBJECTS.  The objects are stringified (into a comma
separated list).  Each BODY element is interpreted with the specified encoding.

When the BODY is empty, the construction of the object fails: C<undef> is
returned.

 -Option  --Defined in                --Default
  charset   Mail::Message::Field::Full  undef
  encoding  Mail::Message::Field::Full  'q'
  force     Mail::Message::Field::Full  false
  language  Mail::Message::Field::Full  undef
  log       Mail::Reporter              'WARNINGS'
  trace     Mail::Reporter              'WARNINGS'

=over 2

=item charset => STRING

=item encoding => 'q'|'Q'|'b'|'B'

=item force => BOOLEAN

=item language => STRING

=item log => LEVEL

=item trace => LEVEL

=back

example: 

 my $s = Mail::Message::Field::Unstructured->new('Comment', 'Hi!');

 # Use autodetect
 my $s = Mail::Message::Field::Full->new('Comment', 'Hi!');
 my $s = Mail::Message::Field::Full->new('Comment: Hi!');

=back

=head2 The field

See L<documentation in base class|Mail::Message::Field::Full/"The field">.
 
=over 4

=item $obj-E<gt>B<isStructured>()

=item Mail::Message::Field::Unstructured-E<gt>B<isStructured>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<length>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<nrLines>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<print>([FILEHANDLE])

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<size>()

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<string>([WRAP])

See L<Mail::Message::Field/"The field">

=item $obj-E<gt>B<toDisclose>()

See L<Mail::Message::Field/"The field">

=back

=head2 Access to the name

See L<documentation in base class|Mail::Message::Field::Full/"Access to the name">.
 
=over 4

=item $obj-E<gt>B<Name>()

See L<Mail::Message::Field/"Access to the name">

=item $obj-E<gt>B<name>()

See L<Mail::Message::Field/"Access to the name">

=item $obj-E<gt>B<wellformedName>([STRING])

See L<Mail::Message::Field/"Access to the name">

=back

=head2 Access to the body

See L<documentation in base class|Mail::Message::Field::Full/"Access to the body">.
 
=over 4

=item $obj-E<gt>B<body>()

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<decodedBody>(OPTIONS)

See L<Mail::Message::Field::Full/"Access to the body">

=item $obj-E<gt>B<folded>()

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<foldedBody>([BODY])

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<stripCFWS>([STRING])

=item Mail::Message::Field::Unstructured-E<gt>B<stripCFWS>([STRING])

See L<Mail::Message::Field/"Access to the body">

=item $obj-E<gt>B<unfoldedBody>([BODY, [WRAP]])

See L<Mail::Message::Field/"Access to the body">

=back

=head2 Access to the content

See L<documentation in base class|Mail::Message::Field::Full/"Access to the content">.
 
=over 4

=item $obj-E<gt>B<addresses>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<attribute>(NAME [, VALUE])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<attributes>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<beautify>()

See L<Mail::Message::Field::Full/"Access to the content">

=item $obj-E<gt>B<comment>([STRING])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<createComment>(STRING, OPTIONS)

=item Mail::Message::Field::Unstructured-E<gt>B<createComment>(STRING, OPTIONS)

See L<Mail::Message::Field::Full/"Access to the content">

=item $obj-E<gt>B<createPhrase>(STRING, OPTIONS)

=item Mail::Message::Field::Unstructured-E<gt>B<createPhrase>(STRING, OPTIONS)

See L<Mail::Message::Field::Full/"Access to the content">

=item $obj-E<gt>B<study>()

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<toDate>([TIME])

=item Mail::Message::Field::Unstructured-E<gt>B<toDate>([TIME])

See L<Mail::Message::Field/"Access to the content">

=item $obj-E<gt>B<toInt>()

See L<Mail::Message::Field/"Access to the content">

=back

=head2 Other methods

See L<documentation in base class|Mail::Message::Field::Full/"Other methods">.
 
=over 4

=item $obj-E<gt>B<dateToTimestamp>(STRING)

=item Mail::Message::Field::Unstructured-E<gt>B<dateToTimestamp>(STRING)

See L<Mail::Message::Field/"Other methods">

=back

=head2 Internals

See L<documentation in base class|Mail::Message::Field::Full/"Internals">.
 
=over 4

=item $obj-E<gt>B<consume>(LINE | (NAME,BODY|OBJECTS))

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<decode>(STRING, OPTIONS)

=item Mail::Message::Field::Unstructured-E<gt>B<decode>(STRING, OPTIONS)

See L<Mail::Message::Field::Full/"Internals">

=item $obj-E<gt>B<defaultWrapLength>([LENGTH])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<encode>(STRING, OPTIONS)

See L<Mail::Message::Field::Full/"Internals">

=item $obj-E<gt>B<fold>(NAME, BODY, [MAXCHARS])

=item Mail::Message::Field::Unstructured-E<gt>B<fold>(NAME, BODY, [MAXCHARS])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<setWrapLength>([LENGTH])

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<stringifyData>(STRING|ARRAY|OBJECTS)

See L<Mail::Message::Field/"Internals">

=item $obj-E<gt>B<unfold>(STRING)

See L<Mail::Message::Field/"Internals">

=back

=head2 Parsing

See L<documentation in base class|Mail::Message::Field::Full/"Parsing">.
 
=over 4

=item $obj-E<gt>B<consumeComment>(STRING)

=item Mail::Message::Field::Unstructured-E<gt>B<consumeComment>(STRING)

See L<Mail::Message::Field::Full/"Parsing">

=item $obj-E<gt>B<consumeDotAtom>(STRING)

See L<Mail::Message::Field::Full/"Parsing">

=item $obj-E<gt>B<consumePhrase>(STRING)

=item Mail::Message::Field::Unstructured-E<gt>B<consumePhrase>(STRING)

See L<Mail::Message::Field::Full/"Parsing">

=item $obj-E<gt>B<parse>(STRING)

See L<Mail::Message::Field::Full/"Parsing">

=item $obj-E<gt>B<produceBody>()

See L<Mail::Message::Field::Full/"Parsing">

=back

=head2 Error handling

See L<documentation in base class|Mail::Message::Field::Full/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<addReport>(OBJECT)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

=item Mail::Message::Field::Unstructured-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<errors>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])

=item Mail::Message::Field::Unstructured-E<gt>B<log>([LEVEL [,STRINGS]])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logPriority>(LEVEL)

=item Mail::Message::Field::Unstructured-E<gt>B<logPriority>(LEVEL)

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<logSettings>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<notImplemented>()

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<report>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<reportAll>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<trace>([LEVEL])

See L<Mail::Reporter/"Error handling">

=item $obj-E<gt>B<warnings>()

See L<Mail::Reporter/"Error handling">

=back

=head2 Cleanup

See L<documentation in base class|Mail::Message::Field::Full/"Cleanup">.
 
=over 4

=item $obj-E<gt>B<DESTROY>()

See L<Mail::Reporter/"Cleanup">

=back

=head1 DETAILS

See L<documentation in base class|Mail::Message::Field::Full/"DETAILS">.
 
=head1 DIAGNOSTICS

=over 4

=item Warning: Field content is not numerical: $content

The numeric value of a field is requested (for instance the C<Lines> or
C<Content-Length> fields should be numerical), however the data contains
weird characters.

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

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

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

=item Warning: Illegal encoding '$encoding', used 'q'

The RFCs only permit base64 (C<b > or C<B >) or quoted-printable
(C<q> or C<Q>) encoding.  Other than these four options are illegal.

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

=back

=head1 SEE ALSO

This module is part of Mail-Box distribution version 2.108,
built on June 25, 2013. Website: F<http://perl.overmeer.net/mailbox/>

=head1 LICENSE

Copyrights 2001-2013 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 F<http://www.perl.com/perl/misc/Artistic.html>
	Global
`s`	Focus search bar
`?`	Bring up this help dialog
	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)
	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse
	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)