Sympa::Spool::Held.3Sympa - Man Page
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.