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( [$fh] )
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.