OVERLOADED

overload: ""
See "" in Mail::Message::Field.
overload: 0+
See 0+ in Mail::Message::Field.
overload: <=>
See <=> in Mail::Message::Field.
overload: bool
See bool in Mail::Message::Field.
overload: cmp
See cmp in Mail::Message::Field.
overload: stringification
See stringification in Mail::Message::Field::Full.

METHODS

See METHODS in Mail::Reporter

Constructors

$obj->clone
See clone in Mail::Message::Field.
$class->from( FIELD, OPTIONS )
See from in Mail::Message::Field::Full.
$class->new
Option Defined in Default

attributes

Mail::Message::Field::Structured

<ignored>

charset

Mail::Message::Field::Full

undef

datum

Mail::Message::Field::Structured

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
charset => STRING
datum => STRING
encoding => 'q'|'Q'|'b'|'B'
force => BOOLEAN
language => STRING
log => LEVEL
trace => LEVEL

The field

$obj->isStructured
$class->isStructured
See isStructured in Mail::Message::Field.
$obj->length
See length in Mail::Message::Field.
$obj->nrLines
See nrLines in Mail::Message::Field.
$obj->print( [FILEHANDLE] )
See print in Mail::Message::Field.
$obj->size
See size in Mail::Message::Field.
$obj->string( [WRAP] )
See string in Mail::Message::Field.
$obj->toDisclose
See toDisclose in Mail::Message::Field.

Access to the name

$obj->Name
See Name in Mail::Message::Field.
$obj->name
See name in Mail::Message::Field.
$obj->wellformedName( [STRING] )
See wellformedName in Mail::Message::Field.

Access to the body

$obj->body
See body in Mail::Message::Field.
$obj->decodedBody( OPTIONS )
See decodedBody in Mail::Message::Field::Full.
$obj->folded
See folded in Mail::Message::Field.
$obj->foldedBody( [BODY] )
See foldedBody in Mail::Message::Field.
$obj->stripCFWS( [STRING] )
$class->stripCFWS( [STRING] )
See stripCFWS in Mail::Message::Field.
$obj->unfoldedBody( [BODY, [WRAP]] )
See unfoldedBody in Mail::Message::Field.

Access to the content

$obj->addAddress( [ADDRESS], OPTIONS )

Add an ADDRESS to the field. The addresses are organized in groups. If no group is specified, the default group is taken to store the address in. If no ADDRESS is specified, the option must be sufficient to create a Mail::Message::Field::Address from. See the OPTIONS of Mail::Message::Field::Address::new().

Option Default

group

''

group => STRING
$obj->addAttribute( ... )

Attributes are not supported for address fields.

» Error: No attributes for address fields.

Is is not possible to add attributes to address fields: it is not permitted by the RFCs.

$obj->addGroup( GROUP|OPTIONS )

Add a group of addresses to this field. A GROUP can be specified, which is a Mail::Message::Field::AddrGroup object, or one is created for you using the OPTIONS. The group is returned.

Option Default

name

''

name => STRING
$obj->addresses

Returns a list with all addresses defined in any group of addresses: all addresses which are specified on the line. The addresses are Mail::Message::Field::Address objects.

» Example:
 my @addr = $field->addresses;
$obj->attrPairs
See attrPairs in Mail::Message::Field::Structured.
$obj->attribute( OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS) )
See attribute in Mail::Message::Field::Structured.
$obj->attributes
See attributes in Mail::Message::Field::Structured.
$obj->beautify
See beautify in Mail::Message::Field::Full.
$obj->comment( [STRING] )
See comment in Mail::Message::Field.
$obj->createComment( STRING, OPTIONS )
$class->createComment( STRING, OPTIONS )
See createComment in Mail::Message::Field::Full.
$obj->createPhrase( STRING, OPTIONS )
$class->createPhrase( STRING, OPTIONS )
See createPhrase in Mail::Message::Field::Full.
$obj->group( NAME )

Returns the group of addresses with the specified NAME, or undef if it does not exist. If NAME is undef, then the default groep is returned.

$obj->groupNames

Returns a list with all group names which are defined.

$obj->groups

Returns all address groups which are defined in this field. Each element is a Mail::Message::Field::AddrGroup object.

$obj->study
See study in Mail::Message::Field.
$obj->toDate( [TIME] )
$class->toDate( [TIME] )
See toDate in Mail::Message::Field.
$obj->toInt
See toInt in Mail::Message::Field.

Other methods

$obj->dateToTimestamp( STRING )
$class->dateToTimestamp( STRING )
See dateToTimestamp in Mail::Message::Field.

Internals

$obj->consume( LINE | (NAME,BODY|OBJECTS) )
See consume in Mail::Message::Field.
$obj->decode( STRING, OPTIONS )
$class->decode( STRING, OPTIONS )
See decode in Mail::Message::Field::Full.
$obj->defaultWrapLength( [LENGTH] )
See defaultWrapLength in Mail::Message::Field.
$obj->encode( STRING, OPTIONS )
See encode in Mail::Message::Field::Full.
$obj->fold( NAME, BODY, [MAXCHARS] )
$class->fold( NAME, BODY, [MAXCHARS] )
See fold in Mail::Message::Field.
$obj->setWrapLength( [LENGTH] )
See setWrapLength in Mail::Message::Field.
$obj->stringifyData( STRING|ARRAY|OBJECTS )
See stringifyData in Mail::Message::Field.
$obj->unfold( STRING )
See unfold in Mail::Message::Field.

Parsing

$obj->consumeAddress( STRING, OPTIONS )

Try to destilate address information from the STRING. Returned are an address object and the left-over string. If no address was found, the first returned value is undef.

$obj->consumeComment( STRING )
$class->consumeComment( STRING )
See consumeComment in Mail::Message::Field::Full.
$obj->consumeDomain( STRING )

Try to get a valid domain representation from STRING. Returned are the domain string as found (or undef) and the rest of the string.

$obj->consumeDotAtom( STRING )
See consumeDotAtom in Mail::Message::Field::Full.
$obj->consumePhrase( STRING )
$class->consumePhrase( STRING )
See consumePhrase in Mail::Message::Field::Full.
$obj->datum( [VALUE] )
See datum in Mail::Message::Field::Structured.
$obj->parse( STRING )
See parse in Mail::Message::Field::Full.
$obj->produceBody
See produceBody in Mail::Message::Field::Full.

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Reporter.
$obj->addReport( OBJECT )
See addReport in Mail::Reporter.
$obj->defaultTrace( [LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK] )
$class->defaultTrace( [LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK] )
See defaultTrace in Mail::Reporter.
$obj->errors
See errors in Mail::Reporter.
$obj->log( [LEVEL [,STRINGS]] )
$class->log( [LEVEL [,STRINGS]] )
See log in Mail::Reporter.
$obj->logPriority( LEVEL )
$class->logPriority( LEVEL )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->report( [LEVEL] )
See report in Mail::Reporter.
$obj->reportAll( [LEVEL] )
See reportAll in Mail::Reporter.
$obj->trace( [LEVEL] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Reporter.