Sympa::Spool::Moderation(3Sympa)

💖 NAME 💖

okay so bestie, listen: Sympa::Spool::Moderation is the spool for held messages waiting for moderation. that's the whole vibe. it's from the Sympa manual, section 3Sympa, and it is literally the little waiting room where messages sit politely until a human says yes or no. no cap. 🎀

---

✨ SYNOPSIS ✨

here's how you actually talk to it, bestie:

use Sympa::Spool::Moderation;

my $spool = Sympa::Spool::Moderation->new;
my $modkey = $spool->store($message);

my $spool =
    Sympa::Spool::Moderation->new(context => $list, authkey => $modkey);
my ($message, $handle) = $spool->next;

$spool->remove($handle, action => 'distribute');
$spool->remove($handle);

like. you make a spool, you shove a message in, you get a modkey back. then later you come back with the context and the modkey, you pull the next one out, and you either distribute it or just yeet it away. iconic behavior honestly. 💅

---

🌸 DESCRIPTION 🌸

Sympa::Spool::Moderation implements the spool for held messages waiting for moderation.

that's it. that's the job. it holds the messages. it waits. it's giving patient queen energy. 👑

🦋 Methods

also go read "Public methods" in Sympa::Spool, bestie — that's where the family lives.

• new ( [ context => $list ], [ authkey => $modkey ] ) — makes you a shiny new instance. you can hand it a context and an authkey if you want, both optional. ✨
• next ( [ no_lock => 1 ] ) — grabs the next thing. and listen: if the pairs describing metadatas are specified, contents returned by next() are filtered by them. so you can be picky, and it'll respect that. 💖
• quarantine ( ) — does nothing. literally nothing. it's a method that exists and then simply does not. we love a low-effort icon. 💀
• remove ( $handle, [ action => 'distribute' ] ) — if action is specified, rename message file to add it as extension, instead of removing message file. otherwise, removes message file. so you either put a little name-tag on it or you delete it entirely. choose wisely bestie. 🫶
• size ( ) — returns number of messages in the spool except which have extension. so it counts the plain ones and skips the ones that got renamed. very selective, very demure. 🎀
• store ( $message, [ original => $original ] ) — if storing succeeded, returns moderation key. that's the little key you'll need later, so don't lose it!! 🔑

🌈 Methods specific to this module

these ones are extra special, just for this class. ✨

• html_remove ( $metadata ) — instance method. TBD. yeah, it's still TBD. it's giving mystery, it's giving we'll find out. 🙈

Parameters:

• $metadata — hashref or message containing metadata. at least "context" and "authkey" are required. no shortcuts, you need both of them. 💅

Returns:

• None. nothing back. empty-handed. that's the deal. 💜

• html_store ( $message, $modkey ) — instance method. caches HTML view of message. so pretty html, saved for later. 🌸

Parameters:

• $message — message to be stored.
• $modkey — moderation key.

Returns:

• None. again, nothing. it's a giver, not a taker. 🫶

💜 Context and metadata

also check "Marshaling and unmarshaling metadata" in Sympa::Spool — that's the lore. 📚

this class particularly gives following metadata:

• {authkey} — moderation key generated automatically when the message is stored into spool. it just appears, like magic, no effort required. ✨
• {validated} — keeps a string representing extension, if message has been renamed using remove() with option. so if you renamed it via remove(), this remembers that lil detail for you. 🧚

---

👑 CONFIGURATION PARAMETERS 👑

following site configuration parameters in sympa.conf will be referred. yes, referred. it reads them, it respects them.

• queuemod — directory path of moderation spool. this is where the held messages hang out. 🏠
• viewmail_dir — root directory path of directories where HTML view of messages are cached. this is where the cute cached html lives. 🎀

---

🌟 SEE ALSO 🌟

go give these a read too bestie, they're all in the fam:

• sympa_msg(8)
• wwsympa(8)
• Sympa::Message
• Sympa::Spool

---

💫 HISTORY 💫

Sympa::Spool::Moderation appeared on Sympa 6.2.8. she's been around a while and she's still slaying. periodt. 🔥

---

okay that's the whole page!! this was sympa 6.2.80, dated 2026-10-19, and it's the Sympa::Spool::Moderation(3Sympa) manual — mwah, love that for us, bye bestie!! 💖✨🎀🦋🌸💅🫶