Sympa::Spool::Listmaster(3Sympa)

πŸ’– Sympa::Spool::Listmaster πŸ’–

okay bestie, welcome to the Sympa::Spool::Listmaster(3Sympa) page β€” yes she's a section-3 manual page, she's from sympa 6.2.80, and she is so much chiller than she sounds. she's the on-memory spool that holds onto your listmaster notifications. let's get into it 🫢


✨ NAME ✨

Sympa::Spool::Listmaster β€” the spool that lives on memory for listmaster notification. lowkey iconic, highkey simple πŸ’…


🌸 SYNOPSIS 🌸

use Sympa::Spool::Listmaster;
my $alarm = Sympa::Spool::Listmaster->instance;

$alarm->store($message, $rcpt, $operation);

$alarm->flush();
$alarm->flush(purge => 1);

see how cute that is? grab the singleton, store a thing, flush the thing. that's the whole vibe 🌈


πŸ¦‹ DESCRIPTION πŸ¦‹

Sympa::Spool::Listmaster implements an on-memory spool for listmaster notification. (yes, "on-memory" β€” she keeps it in RAM, not on disk, no cap).

πŸŽ€ Methods πŸŽ€

🧚 instance ( )

Constructor energy ✨ she creates a singleton instance of the Sympa::Spool::Listmaster object.

Note: unlike the other spool classes, the instance of this class is singleton. one of her. only one. main character rules πŸ’…

Returns:

A new Sympa::Spool::Listmaster instance, or undef if it fails 😭

πŸ“ store ( $message, $rcpt, operation => $operation )

Instance method. Stores a message of a operation to spool. (put the message in the lil box, basically 🎁)

Parameters:

  • $message β€” the Sympa::Message object to be stored. precious cargo fr fr
  • $rcpt β€” arrayref or scalar. the recipient of the notification πŸ‘‘
  • operation => $operation β€” a string that specifies the tag of the message 🏷️

Returns:

True value if succeed, otherwise undef. that's it, that's the whole deal πŸ’€

πŸ’œ flush ( [ purge => $purge ] )

Instance method. Sends compiled messages in spool. she's letting them go, bye bestie πŸ¦‹βœ¨

If a true value is given as the optional argument, all messages in the spool will be sent. all of them. every single one πŸ”₯

⭐ Attribute ⭐

The instance of Sympa::Spool::Listmaster has the following attribute.

  • {use_bulk} β€” if set to be true, messages to be sent will be stored into spool instead of being stored to sendmail. default is false. (so she only goes the bulk route if you ask her to, no assumptions πŸ’…)

⚠️ CAVEAT ⚠️

Sympa::Spool::Listmaster is not a real subsclass of Sympa::Spool. she is her own thing. she said "I'm not like other spools" and meant it πŸ˜­πŸ‘‘


πŸ“œ HISTORY πŸ“œ

  • The feature to compile notification to listmaster in group appeared on Sympa 6.2 ✨
  • Sympa::Alarm appeared on Sympa 6.2. It was renamed to Sympa::Spool::Listmaster on Sympa 6.2.45b.3. glow-up of the century, honestly πŸŽ€

k that's the whole page, bestie β€” go forth and spool responsibly πŸ«ΆπŸ’–βœ¨

mwah πŸ’‹ β€” signed, sealed, and shipped with 6.2.80 on 2026-10-19, from the Sympa::Spool::Listmaster(3Sympa) girlies πŸ’…πŸŒΈ

πŸ“¦ where this page comes from