Skip to Content.
Sympa Menu

Documentation for Sympa

NAME

Sympa::Spindle - Base class of subclasses to define Sympa workflows

SYNOPSIS

 package Sympa::Spindle::FOO;
 use base qw(Sympa::Spindle);

 use constant _distaff => 'Sympa::Spool::BAR';
 
 sub _twist {
     my $self = shift;
     my $object = shift;
 
     # Process object...

     return 1;                        # If succeeded.
     return 0;                        # If skipped.
     return undef;                    # If failed.
     return ['Sympa::Spindle::BAZ'];  # Splicing to the other class(es).
 }

 1;

DESCRIPTION

Sympa::Spindle is the base class of subclasses to define particular workflows of Sympa.

A spindle class is a set of features to process objects. If spin() method is called, it retrieves each object from source spool, processes it, at last passes altered object to appropriate destination (another spool or mailer), and removes it as necessity. Processing repeats until source spool is empty.

Public methods

Properties

Instance of Sympa::Spindle may have following properties.

Methods subclass should implement

SEE ALSO

Sympa::Internals::Workflow, Sympa::Spool.

HISTORY

Sympa::Spindle appeared on Sympa 6.2.10.

Top of Page