Mail::...:Plugin(3pm)

🌸 NAME 🌸

okay bestie, so like β€” this is Mail::MtPolicyd::Plugin, a base class for plugins πŸ’… it's from the User Contributed Perl Documentation section, and the manual name on the page is Mail::...:Plugin(3pm) (iykyk, the title gets truncated in the header, it's giving mysterious). It's the lil parent class that other MtPolicyd plugins inherit from. Very main character, very foundational. πŸ‘‘


✨ VERSION ✨

version 2.05 πŸŽ€


πŸ’– ATTRIBUTES πŸ’–

  • name β€” holds a string, and that string is the name of this plugin, exactly as you typed it in the configuration. no cap. πŸ“
  • log_level (default: 4) β€” this is the log_level that gets used whenever the plugin calls $self->log( $r, $msg ). so like, it decides how chatty your plugin is when it's journaling its lil feelings. πŸ—’οΈβœ¨

πŸ¦‹ METHODS πŸ¦‹

run( $r )

this one HAS to be implemented by the plugin that inherits from this base class. like, it's not optional, bestie β€” the base class is just vibes, run is where the actual work happens. 🫢

log( $r, $msg )

the plugin can use this one to log something. it's giving "dear diary" energy. πŸ““πŸ’œ

since this is mostly for debugging, the default is to log plugin-specific messages with log_level=4. (peep the log_level attribute above, it's all connected, it's a whole ecosystem πŸ”₯)


πŸ‘‘ AUTHOR πŸ‘‘

Markus Benning <ich@markusbenning.de> β€” the icon, the legend, the moment. πŸ’–


This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>. 🫢

This is free software, licensed under:

The GNU General Public License, Version 2, June 1991

okay that's the whole page bestie, slay πŸ’… this was perl v5.38.2, dated 2024-05-26, manual Mail::...:Plugin(3pm) β€” go forth and subclass responsibly πŸŒˆβœ¨πŸ’–

πŸ“¦ where this page comes from