README
1Mail::Procmailrc version 1.09
2=============================
3
4Mail::Procmailrc is a pure Perl module that can read and write
5procmail(1) compatible rc files. The intent behind its creation was
6to provide an abstracted interface for web clients wishing to edit
7procmailrc files, but it could be used in any number of useful ways
8(e.g., a procmail rc pretty printer--how useful is that!?).
9
10Mail::Procmailrc does not process mail in any form; it only reads and
11writes procmail(1) rc files.
12
13SAMPLE USAGE
14
15 use Mail::Procmailrc;
16
17 $pmrc = new Mail::Procmailrc("$HOME/.procmail/rc.spam");
18
19 ## find the recipe we're looking for
20 my $conditions;
21 for my $recipe ( @{$pmrc->recipes} ) {
22 next unless $recipe->info->[0] =~ /^\s*\#\# this recipe is for spam/io;
23 $conditions = $recipe->conditions;
24 last;
25 }
26
27 ## add another condition to this recipe
28 push @$conditions, '* 1^0 this is not SPAM';
29
30 ## write back out to disk
31 $pmrc->flush;
32
33EXAMPLES
34
35The POD for this module contains extensive examples. Also included
36with this distribution is a sample CGI script that makes use of
37Mail::Procmailrc to create/edit a procmail rc file. See the 'eg'
38directory in this distribution for example programs.
39
40INSTALLATION
41
42To install this module type the following:
43
44 perl Makefile.PL
45 make
46 make test
47 make install
48
49COPYRIGHT AND LICENCE
50
51Copyright (c) 2002 Scott Wiersdorf. All rights reserved.
52
53This library is free software; you can redistribute it and/or modify
54it under the terms of the Perl Artistic License.
55
56AUTHOR
57
58Scott Wiersdorf, <scott@perlcode.org>
59