GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SYMPA::SPINDLE::PROCESSHELD (3)

.ds Aq ’

NAME

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

CONTENTS

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 replys 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.

SEE ALSO

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

HISTORY

Sympa::Spindle::ProcessHeld appeared on Sympa 6.2.13.
Search for    or go to Top of page |  Section 3 |  Main Index


6.2.14 SYMPA::SPINDLE::PROCESSHELD (3Sympa) 2016-01-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.