logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Sympa::Spindle::ProcessHeld - Workflow of message confirmation

Description

       Sympa::Spindle::ProcessHeld defines workflow for confirmation of held messages.

       When spin() method is invoked, it reads a message in held message spool, authorizes it and distribute it
       if possible.  Either authorization and distribution failed or not, spin() will terminate processing.
       Failed message will be kept in spool and wait for confirmation again.

   Publicmethods
       See also "Public methods" in Sympa::Spindle.

       new ( confirmed_by => $email, context => $context, authkey => $key, [ quiet => 1 ] )
       spin ( )
           new() must take following options:

           confirmed_by => $email
               E-mail address of the user who confirmed the message.  It is given by CONFIRM command and used by
               Sympa::Spindle::AuthorizeMessage to execute "send" scenario.

           context => $context
           authkey => $key
               Context (List or Robot) and authorization key to specify the message in spool.

           quiet => 1
               If  this  option  is  set,  automatic  replies  reporting  result  of processing to the user (see
               "confirmed_by") will not be sent.

   Properties
       See also "Properties" in Sympa::Spindle.

       {distaff}
           Instance of Sympa::Spool::Held class.

       {finish}
           'success' is set if processing succeeded.  'failure' is set if processing failed.

History

       Sympa::Spindle::ProcessHeld appeared on Sympa 6.2.13.

6.2.76                                             2025-02-12                Sympa::Spindle::ProcessHeld(3Sympa)

Name

       Sympa::Spindle::ProcessHeld - Workflow of message confirmation

See Also

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

Synopsis

         use Sympa::Spindle::ProcessHeld;

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

See Also