View on
MetaCPAN
Richard Clamp > Siesta-0.66 > Siesta::List

Download:
Siesta-0.66.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Source  

NAME ^

Siesta::List - manipulate a list

METHODS ^

->new ( %hash )

->name

the short name of the list

->owner

the owner (a Siesta::Member)

->post_address

the email address that people post to send to this list.

->return_path

the email address that bounces should come back to

->members

all of the Siesta::Members subscribed to this list

->prefs

all of the preferences associated with this list

->is_member( $member )

Returns true or false depending if member is a member of this list. This can take either a Member object or an email address.

->add_member( $member )

Adds a member to a list. This can take either a Member object or an email address.

->remove_member( $member )

Removes a member from a list. This can take either a Member object or an email address.

->members

Returns a list of all the members in the list (as Member objects)

->queues

Returns a list of all processing queues associated with this list.

->plugins( [ $queue ] )

Returns a list of all the plugins for a list (as Plugin objects).

->add_plugin( $queue => $plugin ) =head2 ->add_plugin( $queue => $plugin, $position )

Add a plugin to this lists processing queue $queue.

$position is optional, and indiates the new index of the plugin.

->set_plugins( $queue => @plugins)

Set the plugin processing queue for this list.

->alias [app name]

Returns a string which is can be used as an alias to post to a list. If you pass in an app name then it will use that in the description as

    created by <app name>

NB assumes that the path to 'tequila' is the same as the path of the script calling the method. This may be broken.

syntax highlighting: