Peace/doc/lib/Peace/Email.pm.html

85 lines
2.0 KiB
HTML

<?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>Peace::Email - The mail sender module for Peace.</title>
<meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#INSTANCE-METHODS">INSTANCE METHODS</a>
<ul>
<li><a href="#new">new</a></li>
</ul>
</li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#sendmail">sendmail</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::Email - The mail sender module for Peace.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $mailer = Peace::Email-&gt;new;
$mailer-&gt;sendmail(
to =&gt; &#39;larry@perl,org&#39;,
text =&gt; &#39;hola&#39;,
html =&gt; &#39;&lt;b&gt;hola&lt;/b&gt;&#39;,
subject =&gt; &#39;Patch&#39;,
);</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Peace::Email reads the Peace config to determine the credentials to send mail and does an abstraction around those.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
<p>Peace::Email implements the following instance methods:</p>
<h2 id="new">new</h2>
<pre><code>my $mailer = Peace::Email-&gt;new;</code></pre>
<p>Instances a new mailer.</p>
<h1 id="METHODS">METHODS</h1>
<p>Peace::Email implements the following methods:</p>
<h2 id="sendmail">sendmail</h2>
<pre><code>$mailer-&gt;sendmail(
to =&gt; &#39;larry@perl,org&#39;,
text =&gt; &#39;hola&#39;,
html =&gt; &#39;&lt;b&gt;hola&lt;/b&gt;&#39;,
subject =&gt; &#39;Patch&#39;,
);</code></pre>
<p>Sends a mail to the given mail address.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="../Peace.pm.html">Peace</a></p>
</body>
</html>