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

.ds Aq ’

NAME

Mail::Message::Field::Flex - one line of a message header

CONTENTS

INHERITANCE



 Mail::Message::Field::Flex
   is a Mail::Message::Field
   is a Mail::Reporter



SYNOPSIS

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 (new) and initializer (init) are split. However, you pay the price in performance. Mail::Message::Field::Fast is faster (as the name predicts).

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

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::Flex-><B>newB>(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:
o <B>newB> LINE

ass 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|OBJECTS), [ATTRIBUTES], OPTIONS

A set of values which shape the line.

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:



 -Option    --Defined in     --Default
  attributes                   []
  comment                      undef
  log         Mail::Reporter   WARNINGS
  trace       Mail::Reporter   WARNINGS



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.
comment => STRING A pre-formatted list of attributes.
log => LEVEL
trace => LEVEL

    The field

See documentation in the base class.
$obj-><B>isStructuredB>()
Mail::Message::Field::Flex-><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>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::Flex-><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>commentB>([STRING]) See Access to the content in Mail::Message::Field
$obj-><B>studyB>() See Access to the content in Mail::Message::Field
$obj-><B>toDateB>([TIME])
Mail::Message::Field::Flex-><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::Flex-><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>defaultWrapLengthB>([LENGTH]) See Internals in Mail::Message::Field
$obj-><B>foldB>(NAME, BODY, [MAXCHARS])
Mail::Message::Field::Flex-><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

    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::Flex-><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::Flex-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Field::Flex-><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 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.
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::FLEX (3) 2013-08-19

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