| 1 |
Courier::Filter 0.200 |
| 2 |
A purely Perl-based mail filter framework for the Courier MTA. |
| 3 |
(C) 2003-2008 Julian Mehnle <[email protected]> |
| 4 |
<http://www.mehnle.net/software/courier-filter> |
| 5 |
============================================================================== |
| 6 |
|
| 7 |
The Courier MTA's courierfilter interface |
| 8 |
----------------------------------------- |
| 9 |
|
| 10 |
The Courier MTA <http://www.courier-mta.org> offers an interface for |
| 11 |
daemon-style processes to act as mail filters, called courierfilters. For |
| 12 |
every incoming mail message, right after the DATA command in the SMTP |
| 13 |
transaction phase has completed, Courier calls every registered mail filter |
| 14 |
through a UNIX domain socket the filter is listening on, and feeds it the file |
| 15 |
names of the incoming message and one or more control files. The mail filter |
| 16 |
processes the message and its control file(s), and returns an SMTP-style |
| 17 |
status response. If the status response is a positive ("2xx") one, Courier |
| 18 |
accepts the message. Otherwise, Courier rejects the message using the |
| 19 |
returned response code and text. |
| 20 |
|
| 21 |
About Courier::Filter |
| 22 |
--------------------- |
| 23 |
|
| 24 |
Courier::Filter implements the courierfilter interface as a framework for mail |
| 25 |
filter modules that frees modules from the duties of creating and handling the |
| 26 |
UNIX domain sockets, waiting for connections from Courier, and reading and |
| 27 |
parsing message and control files. Thus, authors of filter modules can |
| 28 |
concentrate on writing the actual filter logic without having to care about |
| 29 |
things that can easily be abstracted and can be performed by the framework. |
| 30 |
|
| 31 |
Courier::Filter allows multiple filter modules to be installed, and filter |
| 32 |
modules can be stacked and grouped hierarchically, and even a module's polarity |
| 33 |
can be reversed, so some modules can be used for explicitly accepting messages |
| 34 |
while others are used in the traditional way for rejecting messages. |
| 35 |
|
| 36 |
Getting started |
| 37 |
--------------- |
| 38 |
|
| 39 |
Read the following perldocs in order to get started with Courier::Filter: |
| 40 |
|
| 41 |
* Courier::Filter::Overview |
| 42 |
* Courier::Filter |
| 43 |
* Courier::Filter::Module |
| 44 |
|
| 45 |
Upgrading from versions prior to 0.15 |
| 46 |
------------------------------------- |
| 47 |
|
| 48 |
Starting from version 0.15, the Courier::* Perl modules are no longer being |
| 49 |
installed in your Perl's configured "vendorlib" path, but in the private path |
| 50 |
'/usr/share/courier-filter-perl/perl5'. (This is because Courier::Filter is |
| 51 |
primarily a plug-in for the Courier MTA, and not a library of Perl modules that |
| 52 |
are intended to be used by other programs or modules. However some of the |
| 53 |
modules (e.g. Courier::Message) are indeed designed genericly, and should any |
| 54 |
other program or module actually make use of them in the future, I will split |
| 55 |
them off into a separate library package.) |
| 56 |
|
| 57 |
Due to this partial relocation, upgrading from a version prior to 0.15 is |
| 58 |
probably best achieved by removing the old version and doing a fresh install. |
| 59 |
You can of course keep your old configuration file(s). |
| 60 |
|
| 61 |
Reporting Bugs |
| 62 |
-------------- |
| 63 |
|
| 64 |
Please report bugs in Courier::Filter and its documentation to the CPAN bug |
| 65 |
tracker: |
| 66 |
|
| 67 |
http://rt.cpan.org/Public/Dist/Display.html?Name=Courier-Filter |
| 68 |
|
| 69 |
License |
| 70 |
------- |
| 71 |
|
| 72 |
Courier::Filter is free software. You may use, modify, and distribute it under |
| 73 |
the same terms as Perl itself, i.e. under the GNU GPL (version 2 or later) or |
| 74 |
the Artistic License. See LICENSE for the license texts. |
| 75 |
|
| 76 |
# $Id: README 210 2008-03-21 19:30:31Z julian $ |
| 77 |
# vim:tw=79 |