Mail-Toaster
view release on metacpan or search on metacpan
doc/modules/Toaster.html view on Meta::CPAN
<?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</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@tenten-slave.macports.org" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#USAGE">USAGE</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#SUBROUTINES">SUBROUTINES</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
<li><a href="#DIAGNOSTICS">DIAGNOSTICS</a></li>
<li><a href="#CONFIGURATION-AND-ENVIRONMENT">CONFIGURATION AND ENVIRONMENT</a></li>
<li><a href="#DEPENDENCIES">DEPENDENCIES</a></li>
<li><a href="#BUGS-AND-LIMITATIONS">BUGS AND LIMITATIONS</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
<li><a href="#COPYRIGHT-AND-LICENCE">COPYRIGHT AND LICENCE</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Mail::Toaster - a fast, secure, full-featured mail server.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code> functions used in: toaster-watcher.pl
toaster_setup.pl
qqtool.pl</code></pre>
<p>To expose much of what can be done with these, run toaster_setup.pl -s help and you'll get a list of the available targets.</p>
<p>The functions in Mail::Toaster.pm are used by toaster-watcher.pl (which is run every 5 minutes via cron), as well as in toaster_setup.pl and other functions, particularly those in Qmail.pm and mailadmin.</p>
<h1 id="USAGE">USAGE</h1>
<pre><code> use Mail::Toaster;
my $toaster = Mail::Toaster->new;
# verify that processes are all running and complain if not
$toaster->check();
# get a list of all maildirs on the system
my @all_maildirs = $toaster->get_maildir_paths();
# clean up old messages over X days old
$toaster->clean_mailboxes();
# clean up messages in Trash folders that exceed X days
foreach my $maildir ( @all_maildirs ) {
$toaster->maildir_clean_trash( $maildir );
};</code></pre>
<p>These functions can all be called indivually, see the working examples in the aforementioned scripts or the t/Toaster.t file.</p>
( run in 0.457 second using v1.01-cache-2.11-cpan-119454b85a5 )