Sympa::Spi...ProcessHeld(3Sympa)

✨ NAME ✨

Sympa::Spindle::ProcessHeld β€” the workflow of message confirmation, aka the bouncer at the door of your held-message spool πŸ’…

okay so real quick, this is a Perl module from sympa 6.2.80 and it's literally the thing that handles "hey bestie, you gotta confirm this message before it goes out" energy. no cap.


🌸 SYNOPSIS 🌸

use Sympa::Spindle::ProcessHeld;

my $spindle = Sympa::Spindle::ProcessHeld->new(
    confirmed_by => $email, context => $robot, authkey => $key);
$spindle->spin;

look at that. so clean. so iconic. 🫢


πŸ’– DESCRIPTION πŸ’–

Sympa::Spindle::ProcessHeld defines the workflow for confirmation of held messages. that's the whole vibe. it's the module that runs the confirm-and-release pipeline.

When the spin() method gets invoked, here's the tea: it reads a message from the held message spool, authorizes it, and distributes it if possible. πŸŽ€

Now β€” either authorization and distribution failed or not, spin() will terminate processing. like, it's done after that, periodt. and a failed message? it stays kept in the spool and just waits for confirmation again. lowkey patient of it honestly πŸ™ˆ


🌈 Public methods

also go peek at "Public methods" in Sympa::Spindle for the full lore.

πŸ’œ new ( confirmed_by => $email, context => $context, authkey => $key, [ quiet => 1 ] )

πŸ¦‹ spin ( )

okay so new() must take the following options (not optional besties, must):

  • confirmed_by => $email β€” the e-mail address of the user who confirmed the message. it's given by the CONFIRM command and it's used by Sympa::Spindle::AuthorizeMessage to execute the "send" scenario. she's doing double duty fr fr.
  • context => $context β€” and like, paired with:
  • authkey => $key β€” Context (List or Robot) and authorization key, used together to specify the message in the spool. these two are a duo, a package deal, the main character energy pair πŸ‘‘
  • quiet => 1 β€” if you set this option, the automatic replies that report the result of processing back to the user (see "confirmed_by", yeah her again) will not be sent. so like, silence mode. stealth mode. 🀫

πŸ‘‘ Properties

also see "Properties" in Sympa::Spindle.

  • {distaff} β€” an instance of the Sympa::Spool::Held class. that's the spool bestie.
  • {finish} β€” gets set to 'success' if processing succeeded, and set to 'failure' if processing failed. a little report card, if you will πŸ’€

πŸ”₯ SEE ALSO πŸ”₯

Sympa::Message, Sympa::Spindle, Sympa::Spindle::AuthorizeMessage, Sympa::Spool::Held.

(the whole friend group, love that for them 🫢)


⭐ HISTORY ⭐

Sympa::Spindle::ProcessHeld appeared on Sympa 6.2.13. a legend was born ✨


okay that's the whole page bestie, you're so welcome πŸ’– this was written for sympa 6.2.80, dated 2026-10-19 β€” sending you off with kisses, Sympa::Spi...ProcessHeld(3Sympa), slay πŸŽ€πŸ’…πŸŒˆ

πŸ“¦ where this page comes from