/ 
Mail-Box-2.090
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Field::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: ""

overload: +0

overload: <=>

overload: bool

overload: cmp

overload: stringification

METHODS

Constructors

$obj->clone

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

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

$obj->length

$obj->nrLines

$obj->print([FILEHANDLE])

$obj->size

$obj->string([WRAP])

$obj->toDisclose

Access to the name

$obj->Name

$obj->name

$obj->wellformedName([STRING])

Access to the body

$obj->body

$obj->decodedBody(OPTIONS)

$obj->folded

$obj->foldedBody([BODY])

$obj->stripCFWS([STRING])

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

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

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

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

$obj->attributes

$obj->beautify

$obj->comment([STRING])

$obj->createComment(STRING, OPTIONS)

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

$obj->createPhrase(STRING, OPTIONS)

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

$obj->study

$obj->toDate([TIME])

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

$obj->toInt

Other methods

$obj->dateToTimestamp(STRING)

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

Internals

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

$obj->decode(STRING, OPTIONS)

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

$obj->defaultWrapLength([LENGTH])

$obj->encode(STRING, OPTIONS)

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

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

$obj->setWrapLength([LENGTH])

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

$obj->unfold(STRING)

Parsing

$obj->consumeComment(STRING)

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

$obj->consumeDotAtom(STRING)

$obj->consumePhrase(STRING)

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

$obj->datum([VALUE])

$obj->parse(STRING)

$obj->produceBody

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

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.090, built on June 02, 2009. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2009 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