Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Sympa::Spindle::ProcessHeld(3Sympsympa 6.2.Sympa::Spindle::ProcessHeld(3Sympa)

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.

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

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

6.2.56				  2020-05-2Sympa::Spindle::ProcessHeld(3Sympa)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Sympa::Spindle::ProcessHeld&sektion=3sympa&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help