MAN page from Mandrake Other perl-SyslogScan-0.32-1.i386.rpm

SyslogScan::DeliveryIterator

Section: User Contributed Perl Documentation (3)
Updated: perl 5.004, patch 04
Index

NAME

SyslogScan::DeliveryIterator -- scans a syslog file for ``deliveries'',successful transfers of mail to mailboxes or to other machines.

SYNOPSIS

    use SyslogScan::Delivery;    use SyslogScan::DeliveryIterator;        my $iter = new SyslogScan::DeliveryIterator(syslogList =>                                                ["/var/log/syslog"]);        my $delivery;    while ($delivery = $iter -> next())    {        print $delivery -> summary();    }

DESCRIPTION

A DeliveryIterator goes through your sendmail logging file (which maybe /var/log/syslog, /var/adm/messages, or something completelydifferent) looking for successful deliveries of mail to localuser-accounts or successful transfers of mail to remote machines.

Here is an excerpt from a sample syslog:

Jun 13 01:50:16 satellife sendmail[29556]: DAA29556: from=<shookway@fs1.ho.man.ac.uk>, size=954, class=0, pri=30954, nrcpts=1, msgid=<5B013544E0DAATTfs1.ho.man.ac.uk>, proto=ESMTP, relay=curlew.cs.man.ac.uk [130.88.13.7]

Jun 13 01:50:17 satellife sendmail[29558]: DAA29556: to=<shokoAATTtime.healthnet.org>, delay=00:00:05, mailer=fidogate, stat=Deferred (Remote host is busy)

...

Jun 13 14:55:50 satellife sendmail[29558]: DAA29556: to=<shokoAATTtime.healthnet.org>, delay=13:00:05, mailer=fidogate, stat=Sent

The delivery is not registered until 14:55:50. In order to figure outthe size and sender, the iterator needs to have gone over the `from'entry associated with message DAA29566, otherwise it will return adelivery with `Sender' and `Size' set to an undefined value (unlessyou specified defaults when constructing your DeliveryIterator.)

METHOD `NEW'

'new' creates a new iterator.

    my $iter =        new SyslogScan::DeliveryIterator(startDate => "06.01.96 18:00:00",                                         endDate => "06.02.96 06:00:00",                                         syslogList =>                                         [/var/log/syslog.090696,                                          /var/log/syslog.090796],                                         unknownSender => 'antiquity',                                         unknownSize => 0,                                         defaultYear => 1996);

All of the above parameters are optional.

startDate and endDate define a span of time; we ignoredeliveries that fall before startDate or after endDate. Thisallows you to generate statistical reports about mail delivered over agiven span of time.

syslogList is a list of files to search through for deliveries.The alternative to specifying syslogList is to supply a file-handle toa syslog file on each call to the next() method.

unknownSender and unknownSize are what to specify as the senderand the size if we cannot determine from the logs who sent the messageand how large the message is.

defaultYear is the year in which the deliveries are assumed to havetaken place (this is not specified in the syslog file.) Default is toguess the year that makes the delivery take place close to now. (Forexample, if `now' is February 3rd 1996, then by default a deliverymade on December 14th is assumed to be in 1995, and a delivery made onFebruary 4th is assumed to be in 1996.

defaultYear is deprecated, set the default year insteadwith SyslogScan::ParseDate::setDefaultYear.

METHOD `NEXT'

Once an iterator is defined, the next() method will search for thenext delivery, skipping any deliveries which don't match the timeconstraints of startDate and endDate. There are two ways tocall next():

    # poll syslogList members    $delivery = $iter -> next;

    # poll filehandle    open(LOG,"/var/log/syslog");    $delivery = $iter -> next(\*LOG);

OTHER OPERATIONS

The `appendSyslog' method can add a syslog filename to the listof syslog filenames which were specified at construction timeas `syslogList'.

Setting the global variable $::gbQuiet to 1 will suppress someof the error messages to STDERR.

BUGS

If two messages have the same message ID through a bad coincidence, amessage is produced with sender of `duplicate' and size of `0' ratherthan using the unknownSender and unknownSize parameters.

Sender and receiver address are downcased automatically. It wouldprobably be better if this module downcased only the host-name part ofthe address and not the user-name.

Some mailings have a `ctladdr' field; DeliveryIterator should probablytry to parse this as a backup clue for figuring out the sender.

AUTHOR and COPYRIGHT

The author (Rolf Harold Nelson) can currently be e-mailed asrolfAATTusa.healthnet.org.

In no event shall SatelLife be liable to any party for direct,indirect, special, incidental, or consequential damages arising out ofthe use of this software and its documentation (including, but notlimited to, lost profits) even if the authors have been advised of thepossibility of such damage.

This document was created byman2html,using the manual pages.