man > Mail::Message::Field::Flex

man perldoc info pydoc3 ri search

📛 NAME

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

🚀 Quick Reference

Use Case	Command	Description
Create field from line	Mail::Message::Field::Flex->new('Subject: Hello')	Parse a raw header line
Create field with attributes	Mail::Message::Field::Flex->new('Content-Type', 'text/plain', charset => 'utf-8')	Set MIME type with attributes
Get body text	$field->body	Return unfolded body
Get attributes	$field->attributes	Return hash of attributes
Unfold body	$field->unfoldedBody	Remove line folding
Clone a field	$field->clone	Deep copy
Convert to date	$field->toDate	Parse date field
Study structured content	$field->study	Parse complex field
Strip comments/whitespace	$field->stripCFWS	Remove CFWS from field

🧬 INHERITANCE

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

📋 SYNOPSIS

(No content)

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

Extends "DESCRIPTION" in Mail::Message::Field.

⚡ OVERLOADED

Extends "OVERLOADED" in Mail::Message::Field.

• overload: "" — Inherited, see "OVERLOADED" in Mail::Message::Field
• overload: 0+ — Inherited, see "OVERLOADED" in Mail::Message::Field
• overload: <=> — Inherited, see "OVERLOADED" in Mail::Message::Field
• overload: bool — Inherited, see "OVERLOADED" in Mail::Message::Field
• overload: cmp — Inherited, see "OVERLOADED" in Mail::Message::Field

🛠️ METHODS

Extends "METHODS" in Mail::Message::Field.

🔨 Constructors

Extends "Constructors" in Mail::Message::Field.

• $obj->clone() — Inherited, see "Constructors" in Mail::Message::Field
• Mail::Message::Field::Flex->new($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.
  • 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|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

Extends "The field" in Mail::Message::Field.

• $obj->isStructured() / Mail::Message::Field::Flex->isStructured() — Inherited, see "The field" in Mail::Message::Field
• $obj->length() — Inherited, see "The field" in Mail::Message::Field
• $obj->nrLines() — Inherited, see "The field" in Mail::Message::Field
• $obj->print( [$fh] ) — Inherited, see "The field" in Mail::Message::Field
• $obj->size() — Inherited, see "The field" in Mail::Message::Field
• $obj->string( [$wrap] ) — Inherited, see "The field" in Mail::Message::Field
• $obj->toDisclose() — Inherited, see "The field" in Mail::Message::Field

🏷️ Access to the Name

Extends "Access to the name" in Mail::Message::Field.

• $obj->Name() — Inherited, see "Access to the name" in Mail::Message::Field
• $obj->name() — Inherited, see "Access to the name" in Mail::Message::Field
• $obj->wellformedName( [STRING] ) — Inherited, see "Access to the name" in Mail::Message::Field

📦 Access to the Body

Extends "Access to the body" in Mail::Message::Field.

• $obj->body() — Inherited, see "Access to the body" in Mail::Message::Field
• $obj->folded() — Inherited, see "Access to the body" in Mail::Message::Field
• $obj->foldedBody( [$body] ) — Inherited, see "Access to the body" in Mail::Message::Field
• $obj->stripCFWS( [STRING] ) / Mail::Message::Field::Flex->stripCFWS( [STRING] ) — Inherited, see "Access to the body" in Mail::Message::Field
• $obj->unfoldedBody( [$body, [$wrap]] ) — Inherited, see "Access to the body" in Mail::Message::Field

📬 Access to the Content

Extends "Access to the content" in Mail::Message::Field.

• $obj->addresses() — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->attribute( $name, [$value] ) — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->attributes() — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->comment( [STRING] ) — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->study() — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->toDate( [$time] ) / Mail::Message::Field::Flex->toDate( [$time] ) — Inherited, see "Access to the content" in Mail::Message::Field
• $obj->toInt() — Inherited, see "Access to the content" in Mail::Message::Field

🔧 Other Methods

Extends "Other methods" in Mail::Message::Field.

• $obj->dateToTimestamp(STRING) / Mail::Message::Field::Flex->dateToTimestamp(STRING) — Inherited, see "Other methods" in Mail::Message::Field

⚙️ Internals

Extends "Internals" in Mail::Message::Field.

• $obj->consume( $line | <$name,<$body|$objects>> ) — Inherited, see "Internals" in Mail::Message::Field
• $obj->defaultWrapLength( [$length] ) — Inherited, see "Internals" in Mail::Message::Field
• $obj->fold( $name, $body, [$maxchars] ) / Mail::Message::Field::Flex->fold( $name, $body, [$maxchars] ) — Inherited, see "Internals" in Mail::Message::Field
• $obj->setWrapLength( [$length] ) — Inherited, see "Internals" in Mail::Message::Field
• $obj->stringifyData(STRING|ARRAY|$objects) — Inherited, see "Internals" in Mail::Message::Field
• $obj->unfold(STRING) — Inherited, see "Internals" in Mail::Message::Field

⚠️ Error Handling

Extends "Error handling" in Mail::Message::Field.

• $obj->AUTOLOAD() — Inherited, see "Error handling" in Mail::Reporter
• $obj->addReport($object) — Inherited, see "Error handling" in Mail::Reporter
• $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) / Mail::Message::Field::Flex->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) — Inherited, see "Error handling" in Mail::Reporter
• $obj->errors() — Inherited, see "Error handling" in Mail::Reporter
• $obj->log( [$level, [$strings]] ) / Mail::Message::Field::Flex->log( [$level, [$strings]] ) — Inherited, see "Error handling" in Mail::Reporter
• $obj->logPriority($level) / Mail::Message::Field::Flex->logPriority($level) — Inherited, see "Error handling" in Mail::Reporter
• $obj->logSettings() — Inherited, see "Error handling" in Mail::Reporter
• $obj->notImplemented() — Inherited, see "Error handling" in Mail::Reporter
• $obj->report( [$level] ) — Inherited, see "Error handling" in Mail::Reporter
• $obj->reportAll( [$level] ) — Inherited, see "Error handling" in Mail::Reporter
• $obj->trace( [$level] ) — Inherited, see "Error handling" in Mail::Reporter
• $obj->warnings() — Inherited, see "Error handling" in Mail::Reporter

🧹 Cleanup

Extends "Cleanup" in Mail::Message::Field.

• $obj->DESTROY() — Inherited, see "Cleanup" in Mail::Reporter

🔍 DETAILS

Extends "DETAILS" in Mail::Message::Field.

🩺 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-Message distribution version 3.012, built on February 11, 2022. Website: http://perl.overmeer.net/CPAN/

📜 LICENSE

Copyrights 2001-2022 by [Mark Overmeer <markov AT cpan.org>]. 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://dev.perl.org/licenses/

📛 NAME 🚀 Quick Reference 🧬 INHERITANCE 📋 SYNOPSIS 📝 DESCRIPTION ⚡ OVERLOADED 🛠️ METHODS 🔍 DETAILS 🩺 DIAGNOSTICS 📚 SEE ALSO 📜 LICENSE