Mail-Toaster

 view release on metacpan or  search on metacpan

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

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  use Mail::Toaster::Utility;
  my $toaster = Mail::Toaster::Utility-&gt;new;

  $util-&gt;file_write($file, lines=&gt; @lines);</code></pre>

<p>This is just one of the many handy little methods I have amassed here. Rather than try to remember all of the best ways to code certain functions and then attempt to remember them, I have consolidated years of experience and countless references f...

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

<p>This Mail::Toaster::Utility package is my most frequently used one. Each method has its own documentation but in general, all methods accept as input a hashref with at least one required argument and a number of optional arguments.</p>

<h1 id="DIAGNOSTICS">DIAGNOSTICS</h1>

<p>All methods set and return error codes (0 = fail, 1 = success) unless otherwise stated.</p>

<p>Unless otherwise mentioned, all methods accept two additional parameters:</p>

<pre><code>  verbose - to print status and verbose error messages, set verbose=&gt;1.
  fatal - die on errors. This is the default, set fatal=&gt;0 to override.</code></pre>

<h1 id="DEPENDENCIES">DEPENDENCIES</h1>

<pre><code>  Perl.
  Scalar::Util -  built-in as of perl 5.8</code></pre>

<p>Almost nothing else. A few of the methods do require certian things, like extract_archive requires tar and file. But in general, this package (Mail::Toaster::Utility) should run flawlessly on any UNIX-like system. Because I recycle this package in...

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

<dl>

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

<p>To use any of the methods below, you must first create a utility object. The methods can be accessed via the utility object.</p>

<pre><code>  ############################################



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