User::I...:Emails(3)

📦
version 4.00 · 9 versions
, in fedora 44

✨ NAME ✨

User::Identity::Collection::Emails — a whole collection of email roles, bestie 💌

(also hi, this manual page is User::I...:Emails(3), from the User Contributed Perl Documentation, in case you were wondering who's talking 🫶)

🌸 INHERITANCE 🌸

the family tree is giving legacy code realness, look:

 User::Identity::Collection::Emails
   is a User::Identity::Collection
   is a User::Identity::Item

🎀 SYNOPSIS 🎀

okay so… there is genuinely nothing here. the SYNOPSIS section is empty. no code, no example, nothing. it's giving "we ran out of time" 💀 the docs just get straight to business below.

🦋 DESCRIPTION 🦋

The User::Identity::Collection::Emails object maintains a set Mail::Identity objects, each describing a role which the user has in e-mail traffic. ✨

Extends "DESCRIPTION" in User::Identity::Collection.

💅 OVERLOADED 💅

Extends "OVERLOADED" in User::Identity::Collection.

  • overload: "" stringification — inherited, see "OVERLOADED" in User::Identity::Collection
  • overload: @{} array dereference — inherited, see "OVERLOADED" in User::Identity::Collection

👑 METHODS 👑

Extends "METHODS" in User::Identity::Collection.

🧚 Constructors

Extends "Constructors" in User::Identity::Collection.

$class->new( [$name], %options )

here's the options table, exactly as the elders wrote it (yes, including the header line, no we do not skip it 🙈):

-Option     --Defined in                --Default
 description  User::Identity::Item        undef
 item_type    User::Identity::Collection  Mail::Identity
 name         User::Identity::Item        'emails'
 parent       User::Identity::Item        undef
 roles        User::Identity::Collection  undef

and here's each one in chat form, same facts, more sparkle:

  • description => STRING — defined in User::Identity::Item, default undef
  • item_type => CLASS — defined in User::Identity::Collection, default Mail::Identity
  • name => STRING — defined in User::Identity::Item, default 'emails'
  • parent => OBJECT — defined in User::Identity::Item, default undef
  • roles => $role|@roles — defined in User::Identity::Collection, default undef

⭐ Attributes

Extends "Attributes" in User::Identity::Collection.

  • $obj->description() — inherited, see "Attributes" in User::Identity::Item
  • $obj->itemType() — inherited, see "Attributes" in User::Identity::Collection
  • $obj->name( [$newname] ) — inherited, see "Attributes" in User::Identity::Item
  • $obj->roles() — inherited, see "Attributes" in User::Identity::Collection

🌈 Collections

Extends "Collections" in User::Identity::Collection.

  • $obj->add($collection, $role) — inherited, see "Collections" in User::Identity::Item
  • $obj->addCollection( $object | <[$type], %options> ) — inherited, see "Collections" in User::Identity::Item
  • $obj->collection($name) — inherited, see "Collections" in User::Identity::Item
  • $obj->parent( [$parent] ) — inherited, see "Collections" in User::Identity::Item
  • $obj->removeCollection($object|$name) — inherited, see "Collections" in User::Identity::Item
  • $any->type() — inherited, see "Collections" in User::Identity::Item
  • $obj->user() — inherited, see "Collections" in User::Identity::Item

💜 Maintaining roles

Extends "Maintaining roles" in User::Identity::Collection.

  • $obj->addRole($role|([$name], %options)) — inherited, see "Maintaining roles" in User::Identity::Collection
  • $obj->removeRole($role|$name) — inherited, see "Maintaining roles" in User::Identity::Collection
  • $obj->renameRole( <$role|$oldname>, $newname ) — inherited, see "Maintaining roles" in User::Identity::Collection
  • $obj->sorted() — inherited, see "Maintaining roles" in User::Identity::Collection

🔍 Searching

Extends "Searching" in User::Identity::Collection.

  • $obj->find($name|CODE|undef) — inherited, see "Searching" in User::Identity::Collection

💀 DIAGNOSTICS 💀

the error messages, and what they're actually trying to tell you:

  • Error: cannot create a $type to add this to my collection. Some options are specified to create a $type object, which is native to this collection. However, for some reason this failed. Cast by addRole()
  • Error: cannot load collection module for $type ($class): $@ Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname. Cast by addCollection()
  • Error: cannot rename $from into $to: already exists. Cast by renameRole()
  • Error: cannot rename $from into $to: doesn't exist. Cast by renameRole()
  • Error: nvalid collection $name. The collection with $name does not exist and can not be created. Cast by add()
  • Error: this $object is not a collection. Cast by addCollection()
  • Error: wrong type of role for $collection: requires a $expect but got a $type. Each $collection groups sets of roles of one specific type ($expect). You cannot add objects of a different $type. Cast by addRole()
ngl that fifth one really does say nvalid, not invalid. it's in the original, so it stays. iykyk 🫠

🍓 SEE ALSO 🍓

This module is part of User-Identity version 4.00, built on December 12, 2025. Website: http://perl.overmeer.net/CPAN/

🧚 LICENSE 🧚

For contributors see file ChangeLog.

This software is copyright (c) 2003-2025 by Mark Overmeer.

This is free software; 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 💖 you made it to the end, main character energy fr fr — this was perl v5.42.0, dated 2026-01-17, and the manual name is User::I...:Emails(3). go forth and collect those email roles 👑✨

📦 where this page comes from