Mail::Toaster::Ezmlm

- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- DEPENDENCIES
- METHODS
- AUTHOR
- BUGS
- TODO
- SEE ALSO
- COPYRIGHT AND LICENSE

# NAME

Mail::Toaster::Ezmlm - a batch processing tool for ezmlm mailing lists

# VERSION

5.02

# SYNOPSIS

         ezmlm.cgi -a [ add | remove | list ]

         -a   action  - add, remove, list
         -d   dir     - ezmlm list directory
         -f   file    - file containing list of email addresses
         -v   verbose - print debugging options

# DESCRIPTION

Ezmlm.cgi is a command line and CGI application that allows a domain administrator (ie, postmaster@example.com) to add, remove, and list batches of email addresses. You can use this utility to subscribe lists of email addresses, delete a list of addresses, or simply retrieve a list of subscribers.

# DEPENDENCIES

     some functions depend on Mail::Ezmlm;
     authentication depends on "vpopmail" (a perl extension)

If you need to run ezmlm.cgi suid, which is likely the case, then hacks to Mail::Ezmlm are required for the ``list'' function to work in taint mode. Also, for a perl script to run suid, you must have suidperl installed. Another (better) approach is to use Apache suexec instead of suidperl.

# METHODS

new

  Creates a new Mail::Toaster::Ezmlm object.

         use Mail::Toaster::Ezmlm;
         my $ez = Mail::Toaster::Ezmlm;

authenticate

  Authenticates a HTTP user against vpopmail to verify the user has permission to do what they're asking.

dir_check

  Check a directory and see if it's a directory and readable.

          $ezmlm->dir_check(dir=>$dir);

  return 0 if not, return 1 if OK.

lists_get

  Get a list of Ezmlm lists for a given mail directory. This is designed to work with vpopmail where all the list for example.com are in ~vpopmail/domains.

          $ezmlm->lists_get("example.com");

logo

  Put the logo on the HTML page. Sets the URL from $conf.

          $ezmlm->logo(conf=>$conf);

  $conf is values from toaster.conf.

       Example:
          $ezmlm->logo(
              web_logo_url => 'http://www.tnpi.net/images/head.jpg',
              web_log_alt  => 'tnpi.net logo',
          );

process_cgi

  Accepts input from HTTP requests, presents a HTML request form, and triggers actions based on input.

         $ez->process_cgi();

process_shell

  Get input from the command line options and proceed accordingly.

subs_add

  Subcribe a user (or list of users) to a mailing list.

         $ezmlm->subs_add(
             list      => $list_name,
             list_dir  => $list_dir,
             requested => $address_list
          );

subs_list

  Print out a list of subscribers to an Ezmlm mailing list.

          $ezmlm->subs_list(list=>$list, dir=>$list_dir);

# AUTHOR

Matt Simerson (matt@tnpi.net)

# BUGS

None known. Report any to author.

# TODO

# SEE ALSO

The following are all man/perldoc pages:

     Mail::Toaster
     Mail::Toaster::Conf
     toaster.conf
     toaster-watcher.conf

     http://mail-toaster.org/

# COPYRIGHT AND LICENSE

Copyright (c) 2005-2008, The Network People, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the The Network People, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.