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::STRUCTURED (3)

.ds Aq ’

NAME

Mail::Message::Field::Structured - one line of a structured message header

CONTENTS

INHERITANCE



 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



SYNOPSIS



 my $f = Mail::Message::Field::Full
            ->new(Content-Type => text/html);

 my @encode = (charset => jp, use_continuations => 1);
 $f->attribute(filename=passwd);
 $f->attribute(filename => passwd, @encode);

 my $attr = Mail::Message::Field::Attribute->new(...);
 $f->attribute($attr);



DESCRIPTION

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::Structured-><B>fromB>(FIELD, OPTIONS) See Constructors in Mail::Message::Field::Full
Mail::Message::Field::Structured-><B>newB>(DATA)
o <B>newB> LINE

Pass a LINE as it could be found in a file: a (possibly folded) line which is terminated by a new-line.

o <B>newB> NAME, BODY, OPTIONS

A set of values which shape the line.

The NAME is a wellformed header name (you may use wellformedName()) to be sure about the casing. The BODY 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 ATTRIBUTE list contains Mail::Message::Field::Attribute objects. Finally, there are some OPTIONS.



 -Option    --Defined in                --Default
  attributes                              []
  charset     Mail::Message::Field::Full  undef
  datum                                   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



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.
charset => STRING
datum => STRING The method name body is very confusing, even in the RFC. In MailBox, for historical reasons, body() returns the part of the field contents before the first semi-colon. foldedBody() and unfoldedBody() address the whole field.

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 <B>datumB>.

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

example: of a structured field



 my @attrs   = (Mail::Message::Field::Attribute->new(...), ...);
 my @options = (extra => the color blue);
 my $t = Mail::Message::Field::Full->new(To => \@addrs, @attrs, @options);



    The field

See documentation in the base class.
$obj-><B>isStructuredB>()
Mail::Message::Field::Structured-><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::Structured-><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>attrPairsB>() Returns a list with attribute name and value pairs.
$obj-><B>attributeB>(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.

You may pass a fully prepared Mail::Message::Field::Attribute OBJECT, if you like to do all preparations for correct representation of the data yourself. You may also pass one STRING, which is a fully prepared attribute. This STRING will not be changed, so be careful about quoting and encodings.

As third possibility, you can specify an attribute NAME and its VALUE. An attribute object will be created for you implicitly in both cases where such object is not supplied, passing the OPTIONS. See Mail::Message::Field::Attribute::new() about the available OPTIONS.

The attribute object is returned, however, when continuations are used this may be an object you already know about. undef is returned when construction fails (when the attribute is incorrect).

example:



 $f->attribute(filename => passwd);
 $f->attribute(filename => passwd, use_continuations => 0);

 my $attr = Mail::Message::Field::Attribute->new(...);
 $f->attribute($attr);



$obj-><B>attributesB>() 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.
$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::Structured-><B>createCommentB>(STRING, OPTIONS) See Access to the content in Mail::Message::Field::Full
$obj-><B>createPhraseB>(STRING, OPTIONS)
Mail::Message::Field::Structured-><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::Structured-><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::Structured-><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::Structured-><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::Structured-><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::Structured-><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::Structured-><B>consumePhraseB>(STRING) See Parsing in Mail::Message::Field::Full
$obj-><B>datumB>([VALUE]) The part of the field before the semi-colon (;).
$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::Structured-><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::Structured-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Field::Structured-><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::STRUCTURED (3) 2013-08-19

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