| 1 |
Mail::Milter version 0.07 |
| 2 |
========================= |
| 3 |
|
| 4 |
$Id: README,v 1.13 2006/03/22 15:48:44 tvierling Exp $ |
| 5 |
|
| 6 |
Mail::Milter is a set of modules useful to mail filter writers who are |
| 7 |
using the Sendmail::Milter and/or Sendmail::PMilter APIs to interface |
| 8 |
directly to the SMTP transaction. Among those currently included are: |
| 9 |
|
| 10 |
Mail::Milter::Chain |
| 11 |
A milter container. This allows multiple milter instances to exist |
| 12 |
within a single milter server, and still play together nicely. |
| 13 |
With this, an almost rule-based meta-milter can be created. |
| 14 |
|
| 15 |
Mail::Milter::Object |
| 16 |
Allows a milter to exist as a blessed object, using method names |
| 17 |
rather than subroutine references to supply the callbacks. This adds |
| 18 |
modularity and makes milter objects easier to understand. |
| 19 |
|
| 20 |
Mail::Milter::Wrapper |
| 21 |
"Wraps" a milter with a user-supplied interception subroutine. This |
| 22 |
can be used to defer a failure return code, add a descriptive message, |
| 23 |
and many other things. |
| 24 |
|
| 25 |
Mail::Milter::Module::* |
| 26 |
Off-the-shelf milter modules that perform commonly used functions. |
| 27 |
Most useful in conjunction with Mail::Milter::Chain. |
| 28 |
|
| 29 |
Mail::Milter::Wrapper::* |
| 30 |
Off-the-shelf milter wrappers that can perform commonly desired |
| 31 |
editing operations on milter return codes. |
| 32 |
|
| 33 |
For a complete list of available modules, see "perldoc Mail::Milter". |
| 34 |
|
| 35 |
===== |
| 36 |
|
| 37 |
INSTALLATION |
| 38 |
|
| 39 |
To install this module type the following: |
| 40 |
|
| 41 |
perl Makefile.PL |
| 42 |
make |
| 43 |
make test |
| 44 |
make install |
| 45 |
|
| 46 |
DEPENDENCIES |
| 47 |
|
| 48 |
This module requires these other modules and libraries: |
| 49 |
|
| 50 |
Sendmail::Milter 0.18 or later |
| 51 |
(Alternatively, Sendmail::PMilter 0.90 or later) |
| 52 |
|
| 53 |
COPYRIGHT AND LICENCE |
| 54 |
|
| 55 |
Mail::Milter is part of the PMilter project: |
| 56 |
http://pmilter.sourceforge.net/ |
| 57 |
|
| 58 |
The PMilter packages are: |
| 59 |
|
| 60 |
# Copyright (c) 2002-2006 Todd Vierling <[email protected]> <[email protected]> |
| 61 |
# All rights reserved. |
| 62 |
# |
| 63 |
# Redistribution and use in source and binary forms, with or without |
| 64 |
# modification, are permitted provided that the following conditions are met: |
| 65 |
# |
| 66 |
# 1. Redistributions of source code must retain the above copyright notice, |
| 67 |
# this list of conditions and the following disclaimer. |
| 68 |
# |
| 69 |
# 2. Redistributions in binary form must reproduce the above copyright |
| 70 |
# notice, this list of conditions and the following disclaimer in the |
| 71 |
# documentation and/or other materials provided with the distribution. |
| 72 |
# |
| 73 |
# 3. Neither the name of the author nor the names of contributors may be used |
| 74 |
# to endorse or promote products derived from this software without specific |
| 75 |
# prior written permission. |
| 76 |
# |
| 77 |
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 78 |
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 79 |
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 80 |
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| 81 |
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 82 |
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 83 |
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 84 |
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 85 |
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 86 |
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 87 |
# POSSIBILITY OF SUCH DAMAGE. |