NAME

DADA::MailingList - Creates and Removes Dada Mail Mailing Lists

VERSION

SYNOPSIS

 use DADA::MailingList; 
 
 my $list = 'foo'; 
 
 
 # Create!
  my $ls = DADA::MailingList::Create(
        { 
                -list => 'mylist',
                -settings => 
                        {
                                #...
                        },
        }
        ); 
 
 # $ls is now a DADA::MailingList::Settings object.
 
 # Remove!
 DADA::MailingList::Remove({ -name => 'mylist' });

DESCRIPTION

This module basically either creates, or removes a list.

SUBROUTINES

Create

 my $ls = DADA::MailingList::Create(
        { 
                -list => 'mylist', 
                -settings => {
                                # a bunch of settings!
                                }
        }
 );

or even,

 my $ls = DADA::MailingList::Create(
        { 
                -list => 'mylist', 
                -settings => {
                                # a bunch of settings!
                                }
                -clone => 'my_first_list',
        }
 );

Creates all the necessary files for a Dada Mailing List.

The -list paramater should hold the list shortname of your mailing list - which itself should be no more than 16 characters and should only include letters/numbers.

The, -settings paramater should hold a hashref with the key/values that make up your list settings. Only keys that are mentioned in the Config.pm's %LIST_SETUP_DEFAULTS can be passed - trying to pass keys that aren't mentioned will cause an error.

The optional, -clone variable will copy list settings from an already existing list, to be used in this new list. Settings mentioned in the Config.pm variable, @LIST_SETUP_DONT_CLONE will not be copied over.

This method returns a DADA::MailingList::Settings object.

Remove

 DADA::MailingList::Remove({ -name => 'mylist', -delete_backups => 1});

Removes a Mailing List. the -name paramater is required. -delete_backups is optional, but when set to 1, will remove any backups of the list settings, archives or schedules.

AUTHOR

Justin Simoni - http://dadamailproject.com/contact

LICENCE AND COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.