Mail-Toaster

 view release on metacpan or  search on metacpan

doc/modules/Setup.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::Setup</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="#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="#METHODS">METHODS</a></li>
  <li><a href="#DEPENDENCIES">DEPENDENCIES</a></li>
  <li><a href="#AUTHOR">AUTHOR</a></li>
  <li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>

<h1 id="NAME">NAME</h1>

<p>Mail::Toaster::Setup - methods to configure and build all the components of a modern email server.</p>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>The meat and potatoes of toaster_setup.pl. This is where the majority of the work gets done. Big chunks of the code and logic for getting all the various applications and scripts installed and configured resides in here.</p>

<h1 id="METHODS">METHODS</h1>

<p>All documented methods in this package (shown below) accept two optional arguments, verbose and fatal. Setting verbose to zero will supress nearly all informational and debugging output. If you want more output, simply pass along verbose=&gt;1 and...

<pre><code> arguments required:
   varies (most require conf)

 arguments optional:
   verbose - print status messages
   fatal   - die on errors (default)

 result:
   0 - failure
   1 - success</code></pre>

<dl>

<dt id="new">new</dt>
<dd>

<p>To use any methods in Mail::Toaster::Setup, you must create a setup object:</p>

<pre><code>  use Mail::Toaster::Setup;
  my $setup = Mail::Toaster::Setup-&gt;new;</code></pre>

<p>From there you can run any of the following methods via $setup-&gt;method as documented below.</p>

<p>Many of the methods require $conf, which is a hashref containing the contents of toaster-watcher.conf.</p>

</dd>
<dt id="clamav">clamav</dt>
<dd>



( run in 0.431 second using v1.01-cache-2.11-cpan-119454b85a5 )