• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• OVERLOADED
• METHODS
  • Constructors
  • The field
  • Access to the name
  • Access to the body
  • Access to the content
  • Other methods
  • Internals
  • Parsing
  • Error handling
  • Cleanup
• DETAILS
• DIAGNOSTICS
• SEE ALSO
• LICENSE

NAME

Mail::Message::Field::URIs - message header field with uris

INHERITANCE

 Mail::Message::Field::URIs
   is a Mail::Message::Field::Structured
   is a Mail::Message::Field::Full
   is a Mail::Message::Field
   is a Mail::Reporter

SYNOPSIS

 my $f = Mail::Message::Field->new('List-Post' => 'http://x.org/');

 my $g = Mail::Message::Field->new('List-Post');
 $g->addURI('http://x.org');

 my $uri = URI->new(...);
 $g->addURI($uri);

 my @uris = $g->URIs;

DESCRIPTION

More recent RFCs prefer uri field notation over the various differentiated syntaxes. Especially the mailing-list RFCs use these fields all the time. This class can maintain these fields.

OVERLOADED

overload: ""

See Mail::Message::Field/"OVERLOADED"

overload: +0

See Mail::Message::Field/"OVERLOADED"

overload: <=>

See Mail::Message::Field/"OVERLOADED"

overload: bool

See Mail::Message::Field/"OVERLOADED"

overload: cmp

See Mail::Message::Field/"OVERLOADED"

overload: stringification

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

METHODS

Constructors

$obj->clone

See Mail::Message::Field/"Constructors"

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

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

Mail::Message::Field::URIs->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

example:

 my $mmfu = 'Mail::Message::Field::URIs;
 my $f = $mmfu->new('List-Post' => 'mailto:x@y.com');
 my $f = $mmfu->new('List-Post' => '<mailto:x@y.com>');
 my $f = $mmfu->new('List-Post: <mailto:x@y.com>');
 my $f = $mmfu->new('List-Post' => [ $uri, 'http://x.org' ]);

The field

$obj->isStructured

Mail::Message::Field::URIs->isStructured

See Mail::Message::Field/"The field"

$obj->length

See Mail::Message::Field/"The field"

$obj->nrLines

See Mail::Message::Field/"The field"

$obj->print([FILEHANDLE])

See Mail::Message::Field/"The field"

$obj->size

See Mail::Message::Field/"The field"

$obj->string([WRAP])

See Mail::Message::Field/"The field"

$obj->toDisclose

See Mail::Message::Field/"The field"

Access to the name

$obj->Name

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

$obj->name

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

$obj->wellformedName([STRING])

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

Access to the body

$obj->body

See Mail::Message::Field/"Access to the body"

$obj->decodedBody(OPTIONS)

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

$obj->folded

See Mail::Message::Field/"Access to the body"

$obj->foldedBody([BODY])

See Mail::Message::Field/"Access to the body"

$obj->stripCFWS([STRING])

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

See Mail::Message::Field/"Access to the body"

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

See Mail::Message::Field/"Access to the body"

Access to the content

$obj->URIs

Returns a list with all URIs defined by the field. Mind the lower-case 's' at the enc of the name.

example:

 my @uris = $field->URIs;

$obj->addAttribute(...)

Attributes are not supported for URI fields.

$obj->addURI(URI)

Add an URI to the field. The URI can be specified as URI object or as string which will be turned into an URI object. The added URI is returned.

example: adding an URI to an URI field

 my $f   = Mail::Message::Field::URI->new('List-Post');

 my $uri = URI->new("http://x.org");
 $f->addURI($uri);

 $f->addURI("http://y.org");  # simpler
 $f->addURI("//y.org", "http");

$obj->addresses

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

$obj->attribute(OBJECT|(STRING, OPTIONS)|(NAME,VALUE,OPTIONS))

See Mail::Message::Field::Structured/"Access to the content"

$obj->attributes

See Mail::Message::Field::Structured/"Access to the content"

$obj->beautify

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

$obj->comment([STRING])

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

$obj->createComment(STRING, OPTIONS)

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

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

$obj->createPhrase(STRING, OPTIONS)

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

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

$obj->study

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

$obj->toDate([TIME])

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

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

$obj->toInt

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

Other methods

$obj->dateToTimestamp(STRING)

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

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

Internals

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

See Mail::Message::Field/"Internals"

$obj->decode(STRING, OPTIONS)

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

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

$obj->defaultWrapLength([LENGTH])

See Mail::Message::Field/"Internals"

$obj->encode(STRING, OPTIONS)

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

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

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

See Mail::Message::Field/"Internals"

$obj->setWrapLength([LENGTH])

See Mail::Message::Field/"Internals"

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

See Mail::Message::Field/"Internals"

$obj->unfold(STRING)

See Mail::Message::Field/"Internals"

Parsing

$obj->consumeComment(STRING)

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

See Mail::Message::Field::Full/"Parsing"

$obj->consumeDotAtom(STRING)

See Mail::Message::Field::Full/"Parsing"

$obj->consumePhrase(STRING)

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

See Mail::Message::Field::Full/"Parsing"

$obj->datum([VALUE])

See Mail::Message::Field::Structured/"Parsing"

$obj->parse(STRING)

See Mail::Message::Field::Full/"Parsing"

$obj->produceBody

See Mail::Message::Field::Full/"Parsing"

Error handling

$obj->AUTOLOAD

See Mail::Reporter/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

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

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Reporter/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

DETAILS

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 charset '$charset'

The field is created with an utf8 string which only contains data from the specified character set. However, that character set can never be a valid name because it contains characters which are not permitted.

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.

Warning: Illegal character in language '$lang'

The field is created with data which is specified to be in a certain language, however, the name of the language cannot be valid: it contains characters which are not permitted by the RFCs.

Warning: Illegal encoding '$encoding', used 'q'

The RFCs only permit base64 (b or B ) or quoted-printable (q or Q) encoding. Other than these four options are illegal.

Error: No attributes for URI fields.

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

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-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2008 by Mark Overmeer. 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://www.perl.com/perl/misc/Artistic.html