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

FreeBSD Manual Pages

  
 
  

home | help
Sympa::Spool::Held(3Sympa)	 sympa 6.2.56	    Sympa::Spool::Held(3Sympa)

NAME
       Sympa::Spool::Held - Spool for held messages waiting for	confirmation

SYNOPSIS
	 use Sympa::Spool::Held;

	 my $spool = Sympa::Spool::Held->new;
	 my $authkey = $spool->store($message);

	 my $spool =
	     Sympa::Spool::Held->new(context =>	$list, authkey => $authkey);
	 my ($message, $handle)	= $spool->next;

DESCRIPTION
       Sympa::Spool::Held implements the spool for held	messages waiting for
       confirmation.

   Methods
       See also	"Public	methods" in Sympa::Spool.

       new ( [ context => $list	], [ authkey =>	$authkey ] )
       next ( [	no_lock	=> 1 ] )
	   If the pairs	describing metadatas are specified, contents returned
	   by next() are filtered by them.

       quarantine ( )
	   Does	nothing.

       store ( $message, [ original => $original ] )
	   If storing succeeded, returns authentication	key.

   Context and metadata
       See also	"Marshaling and	unmarshaling metadata" in Sympa::Spool.

       This class particularly gives following metadata:

       {authkey}
	   Authentication key generated	automatically when the message is
	   stored to spool.

CONFIGURATION PARAMETERS
       Following site configuration parameters in sympa.conf will be referred.

       queueauth
	   Directory path of held message spool.

	   Note: Named such by historical reason.

SEE ALSO
       sympa_msg(8), wwsympa(8), Sympa::Message, Sympa::Spool.

HISTORY
       Sympa::Spool::Held appeared on Sympa 6.2.8.

6.2.56				  2020-05-24	    Sympa::Spool::Held(3Sympa)

NAME | SYNOPSIS | DESCRIPTION | CONFIGURATION PARAMETERS | SEE ALSO | HISTORY

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

home | help