CiderW...::Root(3pm)

πŸ“¦
version 1.05+20240702 Β· 5 versions
, in debian trixie, ubuntu resolute

πŸ’– CiderW...::Root β€” the vibe check ✨

okay so bestie, real talk: this is CiderW...::Root, the Root Controller for CiderWebmail. it lives in the User Contributed Perl Documentation section of the manual, and it's filed under section 3pm (that's Perl module docs, iykyk). 🫢


πŸŽ€ NAME πŸŽ€

CiderW...::Root β€” the Root Controller for CiderWebmail. that's it, that's the name, she's iconic and she knows it πŸ’…


🌸 DESCRIPTION 🌸

[enter your description here]

no fr that's literally what it says. the description is a placeholder, a lil TODO sitting there in the docs like an unmade bed. not me reading it and going 😭. so bestie, if you came here hoping for lore, the lore is: nobody wrote it yet. πŸ’€


✨ METHODS ✨

these are the actions the root controller can do. one bullet-less subsection each, so let's gooo πŸ¦‹

🧚 auto

okay so listen β€” only logged in users may use this product. that's the whole rule. auto is the gatekeeper, the bouncer at the club door, the vibe check before you get in. no login, no entry. periodt. πŸ”₯

πŸ”‘ login

the Login action! but plot twist: it's a private action that auto-forwards, which means the devs can prepend it and therefore do a login on any URI β€” literally any one β€” and once the login actually succeeds, you get shown the page you were asking for all along. it's giving "sneak the login in first, then deliver the goods." ✨

πŸšͺ logout

Logout action: it drops the current session and logs the user out, full stop. then it redirects to / so we can start a fresh new session, like closing the group chat and opening a new one. bye bestie, clean slate, no cap. πŸ’œ

πŸ“₯ index

Redirects you to the INBOX view. that's it. simple. she knows what you want and she takes you there. πŸ‘‘

πŸ“ mailboxes

Lists the folders of this user. it's used by AJAX to update the folder tree, so when the sidebar refreshes itself all smooth and cute, this is the method doing the work behind the scenes. 🌈

πŸ†• create_folder

Create a top level folder. boom, new folder, top level only, that's the assignment. πŸŽ€

⚠️ error

Display an error message found on the stash. something went wrong, the message got stashed, and this method pulls it out and shows it to you. dramatic reveal energy, but for errors. πŸ™ˆ

🎨 render

Attempt to render a view, if needed. note the "if needed" bestie β€” she's not out here rendering for no reason. lowkey efficient. πŸ’…

🧹 end

Cleanup after a request is rendered. the little tidy-up at the end of the party β€” cups in the bin, lights off, request complete. so satisfying. ✨


πŸ‘‘ AUTHOR πŸ‘‘

Stefan Seifert Mathias Reitinger <mathias.reitinger@loop0.org>

shoutout to the authors, they wrote this whole thing and then left the description blank, which honestly? relatable. 🫢


πŸ“œ LICENSE πŸ“œ

This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself. so go off, remix it, slay responsibly. πŸ¦‹


and that's the whole page, bestie!! 🌸

cute lil sign-off: this doc came from perl v5.40.1 and it's dated 2025-03-02. go forth and control that root, you main character πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from