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

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 OVERLOADED in the Mail::Message::Field manpage

overload: +0

See OVERLOADED in the Mail::Message::Field manpage

overload: <=>

See OVERLOADED in the Mail::Message::Field manpage

overload: bool

See OVERLOADED in the Mail::Message::Field manpage

overload: cmp

See OVERLOADED in the Mail::Message::Field manpage

overload: stringification

See OVERLOADED in the Mail::Message::Field::Full manpage

METHODS

Constructors

$obj->clone

See Constructors in the Mail::Message::Field manpage

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

See Constructors in the Mail::Message::Field::Full manpage

Mail::Message::Field::URIs->new(DATA)

 Option      Defined in       Default      
 attributes  L<Mail::Message::Field::Structured>  <ignored>    
 charset     L<Mail::Message::Field::Full>  undef        
 datum       L<Mail::Message::Field::Structured>  C<undef>     
 encoding    L<Mail::Message::Field::Full>  C<'q'>       
 force       L<Mail::Message::Field::Full>  false        
 language    L<Mail::Message::Field::Full>  undef        
 log         L<Mail::Reporter>  C<'WARNINGS'>
 trace       L<Mail::Reporter>  C<'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 The field in the Mail::Message::Field manpage

$obj->length

See The field in the Mail::Message::Field manpage

$obj->nrLines

See The field in the Mail::Message::Field manpage

$obj->print([FILEHANDLE])

See The field in the Mail::Message::Field manpage

$obj->size

See The field in the Mail::Message::Field manpage

$obj->string([WRAP])

See The field in the Mail::Message::Field manpage

$obj->toDisclose

See The field in the Mail::Message::Field manpage

Access to the name

$obj->Name

See Access to the name in the Mail::Message::Field manpage

$obj->name

See Access to the name in the Mail::Message::Field manpage

$obj->wellformedName([STRING])

See Access to the name in the Mail::Message::Field manpage

Access to the body

$obj->body

See Access to the body in the Mail::Message::Field manpage

$obj->decodedBody(OPTIONS)

See Access to the body in the Mail::Message::Field::Full manpage

$obj->folded

See Access to the body in the Mail::Message::Field manpage

$obj->foldedBody([BODY])

See Access to the body in the Mail::Message::Field manpage

$obj->stripCFWS([STRING])

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

See Access to the body in the Mail::Message::Field manpage

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

See Access to the body in the Mail::Message::Field manpage

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 Access to the content in the Mail::Message::Field manpage

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

See Access to the content in the Mail::Message::Field::Structured manpage

$obj->attributes

See Access to the content in the Mail::Message::Field::Structured manpage

$obj->beautify

See Access to the content in the Mail::Message::Field::Full manpage

$obj->comment([STRING])

See Access to the content in the Mail::Message::Field manpage

$obj->createComment(STRING, OPTIONS)

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

See Access to the content in the Mail::Message::Field::Full manpage

$obj->createPhrase(STRING, OPTIONS)

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

See Access to the content in the Mail::Message::Field::Full manpage

$obj->study

See Access to the content in the Mail::Message::Field manpage

$obj->toDate([TIME])

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

See Access to the content in the Mail::Message::Field manpage

$obj->toInt

See Access to the content in the Mail::Message::Field manpage

Other methods

$obj->dateToTimestamp(STRING)

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

See Other methods in the Mail::Message::Field manpage

Internals

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

See Internals in the Mail::Message::Field manpage

$obj->decode(STRING, OPTIONS)

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

See Internals in the Mail::Message::Field::Full manpage

$obj->defaultWrapLength([LENGTH])

See Internals in the Mail::Message::Field manpage

$obj->encode(STRING, OPTIONS)

See Internals in the Mail::Message::Field::Full manpage

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

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

See Internals in the Mail::Message::Field manpage

$obj->setWrapLength([LENGTH])

See Internals in the Mail::Message::Field manpage

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

See Internals in the Mail::Message::Field manpage

$obj->unfold(STRING)

See Internals in the Mail::Message::Field manpage

Parsing

$obj->consumeComment(STRING)

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

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

$obj->consumeDotAtom(STRING)

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

$obj->consumePhrase(STRING)

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

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

$obj->datum([VALUE])

See Parsing in the Mail::Message::Field::Structured manpage

$obj->parse(STRING)

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

$obj->produceBody

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

Error handling

$obj->AUTOLOAD

See Error handling in the Mail::Reporter manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

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

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

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

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

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Reporter manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

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