Sympa::Spool::Held(3Sympa)

💖 Sympa::Spool::Held(3Sympa) 💖

okay bestie, gather round, because today we're talking about Sympa::Spool::Held — the spool for held messages waiting for confirmation. yes, that kind of spool. the "hold up, are you SURE you wanna send this" pile. it's giving bouncer-at-the-club energy and honestly? iconic.

this page lives in the sympa manual, section 3, and it's shipping in version 6.2.80. periodt.

---

✨ SYNOPSIS ✨

use Sympa::Spool::Held;

my $spool = Sympa::Spool::Held->new;
my $authkey = $spool->store($message);

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

so you use it, you make a new one, you store a message and get an $authkey back 💅 then later you spin up another spool with a context and an authkey and pull the thing back out with next. the circle of life, fr fr.

---

🌸 DESCRIPTION 🌸

Sympa::Spool::Held implements the spool for held messages waiting for confirmation. that's the whole vibe: messages that got put on hold and are sitting there like "hello?? am i going out or not??" 🥺

🎀 Methods

also peep "Public methods" in Sympa::Spool for the family lore, bestie.

• new ( [ context => $list ], [ authkey => $authkey ] )

constructor time 🫶 you can hand it a context (a list, i.e. $list) and/or an authkey if you want it to be locked on to one specific held message.

• next ( [ no_lock => 1 ] )

grabs the next thing off the spool. if the pairs describing metadatas are specified, contents returned by next() are filtered by them. also: you can pass no_lock => 1 if you're feeling spicy and don't want the lock. 🔥

• quarantine ( )

does nothing. literally nothing. it's the "i'm just gonna stand here and look pretty" method 💀 no cap.

• store ( $message, [ original => $original ] )

puts a message into the spool. if storing succeeded, returns authentication key — so like, keep that $authkey, you're gonna need it later 😭 you can also pass original => $original if you've got an original to hand over.

🦋 Context and metadata

also check "Marshaling and unmarshaling metadata" in Sympa::Spool — that's where the metadata mechanics live.

this class particularly gives following metadata:

• {authkey} — authentication key generated automatically when the message is stored to spool. it's born the moment the message lands. no you don't make it, the spool does. slay ✨

---

💜 CONFIGURATION PARAMETERS 💜

Following site configuration parameters in sympa.conf will be referred.

• queueauth — directory path of held message spool.

note: named such by historical reason. yeah. we don't ask questions around here, we just vibe with the legacy naming 🙈

---

🌈 SEE ALSO 🌈

sympa_msg(8), wwsympa(8), Sympa::Message, Sympa::Spool.

go read those too, iykyk 👑

---

📜 HISTORY 📜

Sympa::Spool::Held appeared on Sympa 6.2.8. a little baby spool who grew up into a whole module 🥹

---

aaaaand that's the page, bestie!! 💖 this was Sympa::Spool::Held(3Sympa) from sympa version 6.2.80, dated 2026-10-19 — go hold some messages, stay hydrated, and remember: quarantine() does absolutely nothing and that's okay 🌸🫶✨