Mail::M...d::URIs(3)

🌸 Mail::M...d::URIs(3) 🌸

User Contributed Perl Documentation β€” Mail::M...d::URIs(3)

okay bestie, this is Mail::Message::Field::URIs β€” the module for message header fields that are full of 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

the family tree is giving legacy royalty, no cap πŸ‘‘


πŸŽ€ 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;

four lil ways to build the same vibe, pick ur fighter πŸ’–


πŸ¦‹ DESCRIPTION πŸ¦‹

So like, the more recent RFCs are obsessed with uri field notation instead of the whole buffet of differentiated syntaxes. And the mailing-list RFCs?? They use these fields all. the. time. ✨ This class is literally here to maintain those fields for you.

Extends "DESCRIPTION" in Mail::Message::Field::Structured.


πŸ’… OVERLOADED πŸ’…

Extends "OVERLOADED" in Mail::Message::Field::Structured.

  • "" stringification β€” Inherited, see "OVERLOADED" in Mail::Message::Field::Full
  • '""' stringification β€” Inherited, see "OVERLOADED" in Mail::Message::Field
  • '0+' numification β€” Inherited, see "OVERLOADED" in Mail::Message::Field
  • '<='> numeric comparison β€” Inherited, see "OVERLOADED" in Mail::Message::Field
  • bool boolean β€” Inherited, see "OVERLOADED" in Mail::Message::Field
  • cmp string comparison β€” Inherited, see "OVERLOADED" in Mail::Message::Field

every operator said "we learned it from our ancestors" πŸ™ˆ


⭐ METHODS ⭐

Extends "METHODS" in Mail::Message::Field::Structured.

πŸŽ€ Constructors πŸŽ€

Extends "Constructors" in Mail::Message::Field::Structured.

  • $obj->clone() β€” Inherited, see "Constructors" in Mail::Message::Field
  • $class->from($field, %options) β€” Inherited, see "Constructors" in Mail::Message::Field::Full
  • $class->new($data) β€” Inherited, see "METHODS" in Mail::Message::Field::Structured

here's the whole option menu, bestie β€” which option comes from which class, and what it defaults to:

 -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
  • attributes => \@attributes|\%attributes
  • charset => $charset
  • datum => $date
  • encoding => 'q'|'Q'|'b'|'B'
  • force => BOOLEAN
  • language => $language

Β» 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' ]);
lowkey note: that first line in the example is written exactly like that in the docs β€” missing quote and all. copying it verbatim, periodt πŸ’€

🌸 Attributes 🌸

Extends "Attributes" in Mail::Message::Field::Structured.

  • $obj->Name() β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->body() β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->folded() β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->foldedBody( [$body] ) β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->name() β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->unfoldedBody( [$body, [$wrap]] ) β€” Inherited, see "Attributes" in Mail::Message::Field
  • $obj->wellformedName( [STRING] ) β€” Inherited, see "Attributes" in Mail::Message::Field

🧚 The field 🧚

Extends "The field" in Mail::Message::Field::Structured.

  • $any->isStructured( [$name] ) β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->length() β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->nrLines() β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->print( [$fh] ) β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->size() β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->string( [$wrap] ) β€” Inherited, see "The field" in Mail::Message::Field
  • $obj->toDisclose() β€” Inherited, see "The field" in Mail::Message::Field

πŸ’œ Access to the body πŸ’œ

Extends "Access to the body" in Mail::Message::Field::Structured.

  • $obj->decodedBody(%options) β€” Inherited, see "Access to the body" in Mail::Message::Field::Full

✨ Access to the content ✨

Extends "Access to the content" in Mail::Message::Field::Structured.

  • $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;

yes bestie, lowercase s β€” the docs say "enc" not "end" and we're keeping it exactly, iykyk 🫢

  • $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() β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $obj->attrPairs() β€” Inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->attribute( $object|<STRING, %options>|<$name,$value,%options> ) β€” Inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->attributes() β€” Inherited, see "Access to the content" in Mail::Message::Field::Structured
  • $obj->beautify() β€” Inherited, see "Access to the content" in Mail::Message::Field::Full
  • $obj->comment( [STRING] ) β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $any->createComment(STRING, %options) β€” Inherited, see "Access to the content" in Mail::Message::Field::Full
  • $any->createPhrase(STRING, %options) β€” Inherited, see "Access to the content" in Mail::Message::Field::Full
  • $any->dateToTimestamp(STRING) β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $any->stripCFWS( [STRING] ) β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $obj->study() β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $any->toDate( [$time] ) β€” Inherited, see "Access to the content" in Mail::Message::Field
  • $obj->toInt() β€” Inherited, see "Access to the content" in Mail::Message::Field

πŸ”₯ Internals πŸ”₯

Extends "Internals" in Mail::Message::Field::Structured.

  • $any->decode(STRING, %options) β€” Inherited, see "Internals" in Mail::Message::Field::Full
  • $obj->encode(STRING, %options) β€” Inherited, see "Internals" in Mail::Message::Field::Full

πŸ“ Parsing πŸ“

Extends "Parsing" in Mail::Message::Field::Structured.

  • $obj->consume( $line | <$name,<$body|$objects>> ) β€” Inherited, see "Parsing" in Mail::Message::Field
  • $any->consumeComment(STRING) β€” Inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->consumeDotAtom(STRING) β€” Inherited, see "Parsing" in Mail::Message::Field::Full
  • $any->consumePhrase(STRING) β€” Inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->datum( [$value] ) β€” Inherited, see "Parsing" in Mail::Message::Field::Structured
  • $obj->defaultWrapLength( [$length] ) β€” Inherited, see "Parsing" in Mail::Message::Field
  • $any->fold( $name, $body, [$maxchars] ) β€” Inherited, see "Parsing" in Mail::Message::Field
  • $obj->parse(STRING) β€” Inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->produceBody() β€” Inherited, see "Parsing" in Mail::Message::Field::Full
  • $obj->setWrapLength( [$length] ) β€” Inherited, see "Parsing" in Mail::Message::Field
  • $obj->stringifyData(STRING|ARRAY|$objects) β€” Inherited, see "Parsing" in Mail::Message::Field
  • $obj->unfold(STRING) β€” Inherited, see "Parsing" in Mail::Message::Field

😭 Error handling 😭

Extends "Error handling" in Mail::Message::Field::Structured.

  • $obj->AUTOLOAD() β€” Inherited, see "Error handling" in Mail::Reporter
  • $obj->notImplemented() β€” Inherited, see "Error handling" in Mail::Reporter

πŸ’€ Cleanup πŸ’€

Extends "Cleanup" in Mail::Message::Field::Structured.

  • $obj->DESTROY() β€” Inherited, see "Cleanup" in Mail::Reporter

πŸ‘‘ DETAILS πŸ‘‘

Extends "DETAILS" in Mail::Message::Field::Structured.


🚨 DIAGNOSTICS 🚨

  • Error: class $package does not implement method $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. Cast by notImplemented()
  • 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. Cast by toInt()
  • Error: field name too long (max $count), in '$name'. It is not specified in the RFCs how long a field name can be, but at least it should be a few characters shorter than the line wrap. Cast by fold()
  • Warning: illegal character in charset '$name'. 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. Cast by encode()
  • 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. Cast by consume()
bestie this one is literally the "your email might get eaten" warning, do not ignore it 😭
  • Warning: illegal character in language '$name'. 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. Cast by encode()
  • Warning: illegal encoding '$name', using 'q'. The RFCs only permit base64 ("b " or "B ") or quoted-printable ("q" or "Q") encoding. Other than these four options are illegal. Cast by encode()

(yep, "b " with that lil space β€” keeping it exactly as written πŸ’–)

  • Error: no attributes for URI fields. Is is not possible to add attributes to URI fields: it is not permitted by the RFCs. Cast by addAttribute()

🌈 SEE ALSO 🌈

This module is part of Mail-Message version 4.04, built on February 04, 2026. Website: http://perl.overmeer.net/CPAN/


...and there's more, bestie, don't go anywhere πŸ’…

πŸ’– LICENSE πŸ’–

okay bestie, legal era, but make it cute ✨

  • if you've been contributing (or wanna peek at who did what), go look at the file ChangeLog 🫢

This software is copyright (c) 2001-2026 by Mark Overmeer. πŸ‘‘

It's free software, fr fr β€” you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. 🌈


and that's the whole page, bestie!! πŸ’… this gorgeous lil manpage is from perl v5.42.0, dated 2026-02-05, and it lives at Mail::M...d::URIs(3) β€” iconic, no cap. go forth and read it again whenever you forget a flag, ily πŸŽ€πŸ¦‹πŸ’œ

πŸ“¦ where this page comes from