NAME

overload: +0

overload: <=>

overload: bool

overload: cmp

See "OVERLOADED" in Mail::Message::Field::Full

overload: stringification

METHODS

Constructors

$obj->clone

See "Constructors" in Mail::Message::Field

Mail::Message::Field::Structured->from(FIELD, OPTIONS)

See "Constructors" in Mail::Message::Field::Full

Mail::Message::Field::Structured->new(DATA)

new LINE

Pass a LINE as it could be found in a file: a (possibly folded) line which is terminated by a new-line.
new 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 past 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 datum.

. 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

$obj->isStructured

Mail::Message::Field::Structured->isStructured

$obj->length

$obj->nrLines

$obj->print([FILEHANDLE])

$obj->size

$obj->string([WRAP])

$obj->toDisclose

See "Access to the name" in Mail::Message::Field

Access to the name

$obj->Name

$obj->name

See "Access to the name" in Mail::Message::Field

$obj->wellformedName([STRING])

See "Access to the name" in Mail::Message::Field

Access to the body

$obj->body

See "Access to the body" in Mail::Message::Field::Full

$obj->decodedBody(OPTIONS)

$obj->folded

$obj->foldedBody([BODY])

$obj->stripCFWS([STRING])

Mail::Message::Field::Structured->stripCFWS([STRING])

$obj->unfoldedBody([BODY, [WRAP]])

See "Access to the content" in Mail::Message::Field

Access to the content

$obj->addresses

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

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

$obj->beautify

See "Access to the content" in Mail::Message::Field::Full

$obj->comment([STRING])

See "Access to the content" in Mail::Message::Field

$obj->createComment(STRING, OPTIONS)

Mail::Message::Field::Structured->createComment(STRING, OPTIONS)

See "Access to the content" in Mail::Message::Field::Full

$obj->createPhrase(STRING, OPTIONS)

Mail::Message::Field::Structured->createPhrase(STRING, OPTIONS)

See "Access to the content" in Mail::Message::Field::Full

$obj->study

See "Access to the content" in Mail::Message::Field

$obj->toDate([TIME])

Mail::Message::Field::Structured->toDate([TIME])

See "Access to the content" in Mail::Message::Field

$obj->toInt

See "Access to the content" in Mail::Message::Field

Other methods

$obj->dateToTimestamp(STRING)

Mail::Message::Field::Structured->dateToTimestamp(STRING)

See "Other methods" in Mail::Message::Field

Internals

$obj->consume(LINE | (NAME,BODY|OBJECTS))

See "Internals" in Mail::Message::Field::Full

$obj->decode(STRING, OPTIONS)

Mail::Message::Field::Structured->decode(STRING, OPTIONS)

$obj->defaultWrapLength([LENGTH])

See "Internals" in Mail::Message::Field::Full

$obj->encode(STRING, OPTIONS)

$obj->fold(NAME, BODY, [MAXCHARS])

Mail::Message::Field::Structured->fold(NAME, BODY, [MAXCHARS])

$obj->setWrapLength([LENGTH])

$obj->stringifyData(STRING|ARRAY|OBJECTS)

$obj->unfold(STRING)

Parsing

$obj->consumeComment(STRING)

Mail::Message::Field::Structured->consumeComment(STRING)

$obj->consumeDotAtom(STRING)

$obj->consumePhrase(STRING)

Mail::Message::Field::Structured->consumePhrase(STRING)

$obj->datum([VALUE])

Equivalent to body(), but maybe less confusing.

$obj->parse(STRING)

$obj->produceBody

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Field::Structured->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Field::Structured->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Field::Structured->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings