|static new() method||new takes as arguments a (possibly null) list of SyslogScan::DeliveryIterator objects, from which it extracts and registers all queued deliveries.|
registerDelivery takes as its first argument a SyslogScan::Delivery
object followed by up to two optional patterns. If the first pattern
is specified, only those e-mail addresses which match the pattern are
tallied. This enables you to create an accounting summary for only
those users at your site.
If the second pattern is also specified, then deliveries will only be registered to the person matched by the first pattern if the second pattern matches the address at the other end of the pipe.
Pattern-matches are case-insensitive. Remember the (?!regexp) operation if you want only addresses which do _not_ match the pattern to get passed through the filter. For example, if mail to or from support is exempt from billing charges, note that the pattern-match
Takes as parameters two patterns and a list of iterators, then feeds
deliveries in the iterators and the patterns to registerDelivery().
will bill users at foo.com for all mail extracted from @iterList which was sent from foo.com to somewhere besides bar.com, or sent to foo.com from somewhere besides bar.com.
dump returns a string containing address lines alternating with
usage reports. Usage reports are in the form:
S# is the number of messages sent S# is the total number of bytes sent
R# is the number of messages received R# is the total number of bytes received
|persist() method||persist takes as its single argument an output file-handle, and then persists the state of the summary to the file.|
|static restore() method||restore takes as its single argument an input file-handle which stores the results of a previous persist() command, and then returns a copy of the object in the state in which it was originally persisted.|
|addSummary() method||addSummary takes as its single argument a second SyslogScan::Summary object, and then adds this second summary to the $self object.|
Suppose I have a function getTodaySummary() which gets a Summary of the last 24 hours of sendmail logging.
my $summary = getTodaySummary(); open(SUMMARY1,">summary1.sav"); $summary -> persist(\*SUMMARY1); close(SUMMARY1); exit 0; # wait 24 hours my $summary = getTodaySummary(); open(SUMMARY2,">summary2.sav"); $summary -> persist(\*SUMMARY2); close(SUMMARY2); exit 0; # some time later, you decide you want a summary of the total # for both days. So, you write this program: open(INSUM1,"summary1.sav"); my $sum = SyslogScan::Summary -> restore(\*INSUM1); open(INSUM2,"summary2.sav"); my $sum2 = SyslogScan::Summary -> restore(\*INSUM2); $sum -> addSummary($sum2); print "Here is the grand total for both days:\n\n"; print $sum -> dump();
A SyslogScan::Summary object is a hash of SyslogScan::Usage objects, where the key is the e-mail address of the user in question. SyslogScan::Usage has its own man page which describes how to extract information without having to use the dump() method.
The author (Rolf Harold Nelson) can currently be e-mailed as firstname.lastname@example.org.
This code is Copyright (C) SatelLife, Inc. 1996. All rights reserved. This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
In no event shall SatelLife be liable to any party for direct, indirect, special, incidental, or consequential damages arising out of the use of this software and its documentation (including, but not limited to, lost profits) even if the authors have been advised of the possibility of such damage.
|perl v5.20.3||SYSLOGSCAN::SUMMARY (3)||1997-11-24|