Mail::Milter version 0.06
=========================

$Id: README,v 1.11 2004/04/23 15:54:37 tvierling Exp $

Mail::Milter is a set of modules useful to mail filter writers who are
using the Sendmail::Milter and/or Sendmail::PMilter APIs to interface
directly to the SMTP transaction.  Among those currently included are:

Mail::Milter::Chain
    A milter container.  This allows multiple milter instances to exist
    within a single milter server, and still play together nicely.  
    With this, an almost rule-based meta-milter can be created.

Mail::Milter::Object
    Allows a milter to exist as a blessed object, using method names
    rather than subroutine references to supply the callbacks.  This adds
    modularity and makes milter objects easier to understand.

Mail::Milter::Wrapper
    "Wraps" a milter with a user-supplied interception subroutine.  This
    can be used to defer a failure return code, add a descriptive message,
    and many other things.

Mail::Milter::Module::*
    Off-the-shelf milter modules that perform commonly used functions.
    Most useful in conjunction with Mail::Milter::Chain.

Mail::Milter::Wrapper::*
    Off-the-shelf milter wrappers that can perform commonly desired
    editing operations on milter return codes.

For a complete list of available modules, see "perldoc Mail::Milter".

=====

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

This module requires these other modules and libraries:

   Sendmail::Milter 0.18 or later
   (Alternatively, Sendmail::PMilter 0.90 or later)

COPYRIGHT AND LICENCE

Mail::Milter is part of the PMilter project:
    http://pmilter.sourceforge.net/

The PMilter packages are:

# Copyright (c) 2002-2004 Todd Vierling <tv@pobox.com> <tv@duh.org>
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 
# 2. 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.
# 
# 3. Neither the name of the author nor the names of 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.
