Sympa::User(3Sympa)

πŸ’– NAME πŸ’–

Sympa::User β€” literally every single user that Sympa knows about, all of them, no cap πŸ‘‘


✨ DESCRIPTION ✨

okay bestie so this is the class that handles all the users identified by Sympa. it's giving very important, very main character. let's get into it 🫢

πŸŽ€ CONSTRUCTOR πŸŽ€

  • new ( EMAIL, [ KEY => VAL, ... ] ) β€” makes you a brand new Sympa::User object. fresh out the box, iconic behavior fr fr πŸ’…

🌸 METHODS 🌸

  • expire β€” yeets the user's info right out of user_table. gone. not me being dramatic, it really does that 😭
  • get_id β€” hands you the unique identifier of the object. their little ID badge, if you will ✨
  • moveto β€” changes the email of the user. glow-up, but for an email address πŸ¦‹
  • save β€” writes the user's info into user_table. saving your work is self care, periodt πŸ’–

πŸ’œ ACCESSORS πŸ’œ

  • <attribute>
  • <attribute>"( VALUE )"

these are the getters/setters, bestie β€” they get or set the user's attributes. for example, $user->gecos returns the gecos parameter of the user, and $user->gecos("foo") changes it too. two jobs, one method, we love a multitasker πŸ’…

heads up tho: the basic user profile email only has a getter, so it's read-only. look but don't touch, okay? πŸ™ˆ

πŸ¦‹ FUNCTIONS πŸ¦‹

  • get_users ( ... ) β€” not yet implemented. she's not here yet, still getting ready πŸ’€
  • password_fingerprint ( ) β€” returns the password finger print. yes, finger print, not fingerprint, that's literally what it says πŸ“
  • hash_type ( ) β€” detects the type of password fingerprint used for a hashed password. returns undef if no supported hash type is detected. no match = undef, simple as that ✨
  • update_password_hash ( ) β€” if needed, updates the hash used for the user's encrypted password entry. only if needed tho, she's not doing extra work for free πŸ’…

🌈 OLD STYLE FUNCTIONS 🌈

  • add_global_user
  • delete_global_user
  • is_global_user
  • get_global_user
  • get_all_global_user

obsoleted. yeah. they're giving vintage, and not in a cute way πŸ‘‘πŸ’€

  • update_global_user

⭐ Miscellaneous ⭐

  • clean_user ( USER_OR_HASH )
  • clean_users ( ARRAYREF_OF_USERS_OR_HASHES )

function. warns if the argument is not a Sympa::User object. returns Sympa::User object, if any. so like, she'll call you out AND she'll hand you the object back if there is one β€” generous queen 🫢

TENTATIVE. these functions will be used during transition between old and object-oriented styles. at last modifications have been done, they shall be removed. so enjoy them while they last bestie, they're on borrowed time 😭⏳


and that's the page!! sending you off with the vibe check: this is from sympa 6.2.80, the Sympa::User(3Sympa) page, dated 2026-10-19 πŸŒΈπŸ’– go forth and manage your users, you're gonna slay βœ¨πŸ¦‹

πŸ“¦ where this page comes from