GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::FIELD::UNSTRUCTURED (3)

.ds Aq ’

NAME

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

CONTENTS

INHERITANCE



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



SYNOPSIS



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



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 documentation in the base class.

OVERLOADED

See documentation in the base class.
overload: <B>‘‘’’B>() See OVERLOADED in Mail::Message::Field
overload: <B>0+B>() See OVERLOADED in Mail::Message::Field
overload: <B><=B>>() See OVERLOADED in Mail::Message::Field
overload: <B>boolB>() See OVERLOADED in Mail::Message::Field
overload: <B>cmpB>() See OVERLOADED in Mail::Message::Field
overload: <B>stringificationB>() See OVERLOADED in Mail::Message::Field::Full

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>() See Constructors in Mail::Message::Field
Mail::Message::Field::Unstructured-><B>fromB>(FIELD, OPTIONS) See Constructors in Mail::Message::Field::Full
Mail::Message::Field::Unstructured-><B>newB>(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: 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



charset => STRING
encoding => ’q’|’Q’|’b’|’B
force => BOOLEAN
language => STRING
log => LEVEL
trace => LEVEL

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!);



    The field

See documentation in the base class.
$obj-><B>isStructuredB>()
Mail::Message::Field::Unstructured-><B>isStructuredB>() See The field in Mail::Message::Field
$obj-><B>lengthB>() See The field in Mail::Message::Field
$obj-><B>nrLinesB>() See The field in Mail::Message::Field
$obj-><B>printB>([FILEHANDLE]) See The field in Mail::Message::Field
$obj-><B>sizeB>() See The field in Mail::Message::Field
$obj-><B>stringB>([WRAP]) See The field in Mail::Message::Field
$obj-><B>toDiscloseB>() See The field in Mail::Message::Field

    Access to the name

See documentation in the base class.
$obj-><B>NameB>() See Access to the name in Mail::Message::Field
$obj-><B>nameB>() See Access to the name in Mail::Message::Field
$obj-><B>wellformedNameB>([STRING]) See Access to the name in Mail::Message::Field

    Access to the body

See documentation in the base class.
$obj-><B>bodyB>() See Access to the body in Mail::Message::Field
$obj-><B>decodedBodyB>(OPTIONS) See Access to the body in Mail::Message::Field::Full
$obj-><B>foldedB>() See Access to the body in Mail::Message::Field
$obj-><B>foldedBodyB>([BODY]) See Access to the body in Mail::Message::Field
$obj-><B>stripCFWSB>([STRING])
Mail::Message::Field::Unstructured-><B>stripCFWSB>([STRING]) See Access to the body in Mail::Message::Field
$obj-><B>unfoldedBodyB>([BODY, [WRAP]]) See Access to the body in Mail::Message::Field

    Access to the content

See documentation in the base class.
$obj-><B>addressesB>() See Access to the content in Mail::Message::Field
$obj-><B>attributeB>(NAME [, VALUE]) See Access to the content in Mail::Message::Field
$obj-><B>attributesB>() See Access to the content in Mail::Message::Field
$obj-><B>beautifyB>() See Access to the content in Mail::Message::Field::Full
$obj-><B>commentB>([STRING]) See Access to the content in Mail::Message::Field
$obj-><B>createCommentB>(STRING, OPTIONS)
Mail::Message::Field::Unstructured-><B>createCommentB>(STRING, OPTIONS) See Access to the content in Mail::Message::Field::Full
$obj-><B>createPhraseB>(STRING, OPTIONS)
Mail::Message::Field::Unstructured-><B>createPhraseB>(STRING, OPTIONS) See Access to the content in Mail::Message::Field::Full
$obj-><B>studyB>() See Access to the content in Mail::Message::Field
$obj-><B>toDateB>([TIME])
Mail::Message::Field::Unstructured-><B>toDateB>([TIME]) See Access to the content in Mail::Message::Field
$obj-><B>toIntB>() See Access to the content in Mail::Message::Field

    Other methods

See documentation in the base class.
$obj-><B>dateToTimestampB>(STRING)
Mail::Message::Field::Unstructured-><B>dateToTimestampB>(STRING) See Other methods in Mail::Message::Field

    Internals

See documentation in the base class.
$obj-><B>consumeB>(LINE | (NAME,BODY|OBJECTS)) See Internals in Mail::Message::Field
$obj-><B>decodeB>(STRING, OPTIONS)
Mail::Message::Field::Unstructured-><B>decodeB>(STRING, OPTIONS) See Internals in Mail::Message::Field::Full
$obj-><B>defaultWrapLengthB>([LENGTH]) See Internals in Mail::Message::Field
$obj-><B>encodeB>(STRING, OPTIONS) See Internals in Mail::Message::Field::Full
$obj-><B>foldB>(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Unstructured-><B>foldB>(NAME, BODY, [MAXCHARS]) See Internals in Mail::Message::Field
$obj-><B>setWrapLengthB>([LENGTH]) See Internals in Mail::Message::Field
$obj-><B>stringifyDataB>(STRING|ARRAY|OBJECTS) See Internals in Mail::Message::Field
$obj-><B>unfoldB>(STRING) See Internals in Mail::Message::Field

    Parsing

See documentation in the base class.
$obj-><B>consumeCommentB>(STRING)
Mail::Message::Field::Unstructured-><B>consumeCommentB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>consumeDotAtomB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>consumePhraseB>(STRING)
Mail::Message::Field::Unstructured-><B>consumePhraseB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>parseB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>produceBodyB>() See Parsing in Mail::Message::Field::Full

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Field::Unstructured-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Field::Unstructured-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Field::Unstructured-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DETAILS

See documentation in the base class.

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 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.
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.
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.
Warning: Illegal encoding ’$encoding’, used ’q’ The RFCs only permit base64 (b or B ) or quoted-printable (q or Q) encoding. Other than these four options are illegal.
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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

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 http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::FIELD::UNSTRUCTURED (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.