NAME

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

SYNOPSIS

  use Sympa::Spindle::ProcessHeld;

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

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.

Public methods

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