<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Mail::Toaster::Logs</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:matt@mattbook.simerson.net" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#methods">METHODS</a></li>
<li><a href="#author">AUTHOR</a></li>
<li><a href="#bugs">BUGS</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Mail::Toaster::Logs - objects and functions for interacting with email logs</p>
<p>This module contains functions related to mail logging and are used primarily in maillogs. Some functions are also used in toaster-watcher.pl and toaster_setup.pl.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<dl>
<dt><strong><a name="new" class="item">new</a></strong></dt>
<dd>
<p>Create a new Mail::Toaster::Logs object.</p>
<pre>
use Mail::Toaster::Logs;
$logs = Mail::Toaster::Logs->new;</pre>
</dd>
<dt><strong><a name="report_yesterdays_activity" class="item">report_yesterdays_activity</a></strong></dt>
<dd>
<p>email a report of yesterdays email traffic.</p>
</dd>
<dt><strong><a name="verify_settings" class="item">verify_settings</a></strong></dt>
<dd>
<p>Does some checks to make sure things are set up correctly.</p>
<pre>
$logs->verify_settings();</pre>
<p>tests:</p>
<pre>
logs base directory exists
logs based owned by qmaill
counters directory exists
maillogs is installed</pre>
</dd>
<dt><strong><a name="parse_cmdline_flags" class="item">parse_cmdline_flags</a></strong></dt>
<dd>
<p>Do the appropriate things based on what argument is passed on the command line.</p>
<pre>
$logs->parse_cmdline_flags(prot=>$prot, debug=>0);</pre>
<p>$conf is a hashref of configuration values, assumed to be pulled from toaster-watcher.conf.</p>
<p>$prot is the protocol we're supposed to work on.</p>
</dd>
<dt><strong><a name="check_log_files" class="item">check_log_files</a></strong></dt>
<dd>
<pre>
$logs->check_log_files( $check );</pre>
</dd>
<dt><strong><a name="compress_yesterdays_logs" class="item">compress_yesterdays_logs</a></strong></dt>
<dd>
<pre>
$logs->compress_yesterdays_logs(
file => $file,
);</pre>
</dd>
<dt><strong><a name="count_rbl_line" class="item">count_rbl_line</a></strong></dt>
<dd>
<pre>
$logs->count_rbl_line($line);</pre>
</dd>
<dt><strong><a name="count_send_line" class="item">count_send_line</a></strong></dt>
<dd>
<pre>
usage:
$logs->count_send_line( $count, $line );</pre>
<pre>
arguments required:
count - a hashref of counter values
line - an entry from qmail's send logs</pre>
<pre>
results:
a hashref will be returned with updated counters</pre>
</dd>
<dt><strong><a name="counter_read" class="item">counter_read</a></strong></dt>
<dd>
<pre>
$logs->counter_read( file=>$file, debug=>$debug);</pre>
<p>$file is the file to read from. $debug is optional, it prints out verbose messages during the process. The sub returns a hashref full of key value pairs.</p>
</dd>
<dt><strong><a name="counter_write" class="item">counter_write</a></strong></dt>
<dd>
<pre>
$logs->counter_write(log=>$file, values=>$values);</pre>
<pre>
arguments required:
file - the logfile to write.
values - a hashref of value=count style pairs.</pre>
<pre>
result:
1 if written
0 if not.</pre>
</dd>
<dt><strong><a name="imap_count" class="item">imap_count</a></strong></dt>
<dd>
<pre>
$logs->imap_count(conf=>$conf);</pre>
<p>Count the number of connections and successful authentications via IMAP and IMAP-SSL.</p>
</dd>
<dt><strong><a name="pop3_count" class="item">pop3_count</a></strong></dt>
<dd>
<pre>
$logs->pop3_count(conf=>$conf);</pre>
<p>Count the number of connections and successful authentications via POP3 and POP3-SSL.</p>
</dd>
<dt><strong><a name="process_pop3_logs" class="item">process_pop3_logs</a></strong></dt>
<dt><strong><a name="process_rbl_logs" class="item">process_rbl_logs</a></strong></dt>
<dd>
<pre>
process_rbl_logs(
roll => 0,
files => $self->check_log_files( "$logbase/smtp/current" ),
);</pre>
</dd>
<dt><strong><a name="process_send_logs" class="item">process_send_logs</a></strong></dt>
<dt><strong><a name="qms_count" class="item">qms_count</a></strong></dt>
<dd>
<pre>
$logs->qms_count($conf);</pre>
<p>Count statistics logged by qmail scanner.</p>
</dd>
<dt><strong><a name="purge_last_months_logs" class="item">purge_last_months_logs</a></strong></dt>
<dd>
<pre>
$logs->purge_last_months_logs(
fatal => 0,
);</pre>
<p>For a supplied protocol, cleans out last months email logs.</p>
</dd>
<dt><strong><a name="rbl_count" class="item">rbl_count</a></strong></dt>
<dd>
<p>Count the number of connections we've blocked (via rblsmtpd) for each RBL that we use.</p>
<pre>
$logs->rbl_count(conf=>$conf, $debug);</pre>
</dd>
<dt><strong><a name="roll_rbl_logs" class="item">roll_rbl_logs</a></strong></dt>
<dd>
<pre>
$logs->roll_rbl_logs($conf, $debug);</pre>
<p>Roll the qmail-smtpd logs (without 2>&1 output generated by rblsmtpd).</p>
</dd>
<dt><strong><a name="rollpop3logs" class="item">RollPOP3Logs</a></strong></dt>
<dd>
<pre>
$logs->RollPOP3Logs($conf);</pre>
<p>These logs will only exist if tcpserver debugging is enabled. Rolling them is not likely to be necessary but the code is here should it ever prove necessary.</p>
</dd>
<dt><strong><a name="roll_send_logs" class="item">roll_send_logs</a></strong></dt>
<dd>
<pre>
$logs->roll_send_logs();</pre>
<p>Roll the qmail-send multilog logs. Update the maillogs counter.</p>
</dd>
<dt><strong><a name="send_count" class="item">send_count</a></strong></dt>
<dd>
<pre>
$logs->send_count(conf=>$conf);</pre>
<p>Count the number of messages we deliver, and a whole mess of stats from qmail-send.</p>
</dd>
<dt><strong><a name="smtp_auth_count" class="item">smtp_auth_count</a></strong></dt>
<dd>
<pre>
$logs->smtp_auth_count(conf=>$conf);</pre>
<p>Count the number of times users authenticate via SMTP-AUTH to our qmail-smtpd daemon.</p>
</dd>
<dt><strong><a name="spama_count" class="item">spama_count</a></strong></dt>
<dd>
<pre>
$logs->spama_count($conf);</pre>
<p>Count statistics logged by SpamAssassin.</p>
</dd>
<dt><strong><a name="syslog_locate" class="item">syslog_locate</a></strong></dt>
<dd>
<pre>
$logs->syslog_locate($debug);</pre>
<p>Determine where syslog.mail is logged to. Right now we just test based on the OS you're running on and assume you've left it in the default location. This is easy to expand later.</p>
</dd>
<dt><strong><a name="webmail_count" class="item">webmail_count</a></strong></dt>
<dd>
<pre>
$logs->webmail_count();</pre>
<p>Count the number of webmail authentications.</p>
</dd>
<dt><strong><a name="what_am_i" class="item">what_am_i</a></strong></dt>
<dd>
<pre>
$logs->what_am_i()</pre>
<p>Determine what the filename of this program is. This is used in maillogs, as maillogs gets renamed in order to function as a log post-processor for multilog.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Matt Simerson <<a href="mailto:matt@tnpi.net">matt@tnpi.net</a>></p>
<p>
</p>
<hr />
<h1><a name="bugs">BUGS</a></h1>
<p>None known. Report any to author.
Patches welcome.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p>The following are relevant man/perldoc pages:</p>
<pre>
maillogs
Mail::Toaster
toaster.conf</pre>
<pre>
<a href="http://mail-toaster.org/">http://mail-toaster.org/</a></pre>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright (c) 2004-2008, The Network People, Inc. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
<p>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</p>
<p>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</p>
<p>Neither the name of the The Network People, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</p>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
</body>
</html>