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( $data )
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->addAttribute( ... )

Attributes are not supported here.

» Error: No attributes for DKIM headers

Is is not possible to add attributes to this field.

$obj->addTag( $name, $value|@values )

Add a tag to the set. When the tag already exists, it is replaced. Names are (converted to) lower-case. When multiple values are given, they will be concatenated with a blank (and may get folded there later)

$obj->addresses
See addresses in Mail::Message::Field.
$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->study
See study in Mail::Message::Field.
$obj->tag( $name )

Returns the value for the named tag.

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

DKIM-Signature tags

The tag methods return the tag-value content without any validation or modification. For many situations, the actual content does not need (expensive) validation and interpretation.

$obj->tagAgentID

The Agent or User Identifier (AUID). Defaults to @$domain

$obj->tagAlgorithm

Signature algorithm. Should be rsa-sha(1|256): check before use. Required.

$obj->tagBodyLength

The number of octets which where used to calculate the hash. By default, the whole body was used.

$obj->tagC14N

The canonicalization method used. Defaults to 'simple/simple'.

$obj->tagDomain

The sub-domain (SDID) which claims responsibility for this signature. Required.

$obj->tagExpires

The timestamp when the signature will expire. Recommended.

$obj->tagExtract

Some headers from the original message packed together.

$obj->tagQueryMethods

A colon-separated list of method which can be used to retrieve the public key. The default is "dns/txt" (currently the only valid option)

$obj->tagSelector

The selector subdividing the $domain tag. Required.

$obj->tagSignData
$obj->tagSignature

Message signature in base64, with whitespaces removed. Required.

$obj->tagSignedHeaders

The colon separated list of headers which need to be included in the signature. Required.

$obj->tagTimestamp

When the signature was created in UNIX-like seconds (since 1970). Recommended.

$obj->tagVersion

Signature header syntax version (usually 1)

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

See Parsing in Mail::Message::Field::Full

$obj->consumeComment( STRING )
$class->consumeComment( STRING )
See consumeComment in Mail::Message::Field::Full.
$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.