<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class CMail</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class CMail</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Composite Mail class is able to send multiple email with attachment using PHP::mail()</p>
<ul class="tags">
<li><span class="field">author:</span> Michal "Techi" Vrchota <<a href="mailto:hide@address.com">hide@address.com</a>></li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/gpl.html">GPL</a></li>
<li><span class="field">uses:</span> <a href="../Mail/EmailException.html">EmailException</a></li>
<li><span class="field">version:</span> 1.13</li>
</ul>
<p class="notes">
Located in <a class="field" href="_mail.php.html">/mail.php</a> (line <span class="field">27</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">array</span>
<a href="#$attachments" title="details" class="var-name">$attachments</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$bcc" title="details" class="var-name">$bcc</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$body" title="details" class="var-name">$body</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$cc" title="details" class="var-name">$cc</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$charset" title="details" class="var-name">$charset</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$debug" title="details" class="var-name">$debug</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$from" title="details" class="var-name">$from</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$fromName" title="details" class="var-name">$fromName</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$header" title="details" class="var-name">$header</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$message" title="details" class="var-name">$message</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$mime" title="details" class="var-name">$mime</a>
</div>
<div class="var-title">
<span class="var-type">bool</span>
<a href="#$notify" title="details" class="var-name">$notify</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$priorities" title="details" class="var-name">$priorities</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$priority" title="details" class="var-name">$priority</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$returnPath" title="details" class="var-name">$returnPath</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$subject" title="details" class="var-name">$subject</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$to" title="details" class="var-name">$to</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#getMimeType" title="details" class="method-name">getMimeType</a>
(<span class="var-type">string</span> <span class="var-name">$file</span>)
</div>
<div class="method-definition">
static <span class="method-result">bool</span>
<a href="#isValidEmail" title="details" class="method-name">isValidEmail</a>
(<span class="var-type">string</span> <span class="var-name">$email</span>)
</div>
<div class="method-definition">
<span class="method-result">CMail</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#addAttachment" title="details" class="method-name">addAttachment</a>
(<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$inner_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$mime</span> = <span class="var-default">""</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#clear" title="details" class="method-name">clear</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#clearAttachments" title="details" class="method-name">clearAttachments</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getInvalidEmail" title="details" class="method-name">getInvalidEmail</a>
(<span class="var-type">mixed</span> <span class="var-name">$email</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#send" title="details" class="method-name">send</a>
([<span class="var-type">string</span> <span class="var-name">$emailfile</span> = <span class="var-default">""</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#sendTo" title="details" class="method-name">sendTo</a>
(<span class="var-type">string</span> <span class="var-name">$to</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#stripnl" title="details" class="method-name">stripnl</a>
(<span class="var-type">string</span> <span class="var-name">$string</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$attachments" id="$attachments"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$attachments</span>
= <span class="var-default">array()</span> (line <span class="line-number">125</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> each attachment is stored in this array</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$bcc" id="$bcc"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$bcc</span>
(line <span class="line-number">59</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> blind carbon copy</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$body" id="$body"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$body</span>
(line <span class="line-number">113</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> email body</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$cc" id="$cc"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$cc</span>
(line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> carbon copy</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$charset" id="$charset"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$charset</span>
(line <span class="line-number">95</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> email encoding (iso-8859-1 default)</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$debug" id="$debug"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$debug</span>
(line <span class="line-number">107</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">$var bool $debug enable debug mode to display errors etc.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$from" id="$from"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$from</span>
(line <span class="line-number">34</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> your email</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$fromName" id="$fromName"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$fromName</span>
(line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> your name</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$header" id="$header"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$header</span>
(line <span class="line-number">119</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> email header</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$message" id="$message"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$message</span>
(line <span class="line-number">89</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> message text</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$mime" id="$mime"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$mime</span>
(line <span class="line-number">101</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> Email mime type</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$notify" id="$notify"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">bool</span>
<span class="var-name">$notify</span>
(line <span class="line-number">83</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> send back notification about reading</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$priorities" id="$priorities"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$priorities</span>
= <span class="var-default">array(1 =><br /> '1 (Highest)',<br /> '2 (High)',<br /> '3 (Normal)',<br /> '4 (Low)',<br /> '5 (Lowest)')</span> (line <span class="line-number">130</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> priority with description</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$priority" id="$priority"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$priority</span>
(line <span class="line-number">71</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> email priority 1-5 (3 standart)</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$returnPath" id="$returnPath"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$returnPath</span>
(line <span class="line-number">77</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> override $to to this email for reply address</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$subject" id="$subject"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$subject</span>
(line <span class="line-number">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> email subject</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$to" id="$to"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$to</span>
(line <span class="line-number">46</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> target email</li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodgetMimeType" id="getMimeType"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method getMimeType</span> (line <span class="line-number">188</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">return mime type for given file</p>
<ul class="tags">
<li><span class="field">return:</span> mime-type for given file</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
getMimeType
</span>
(<span class="var-type">string</span> <span class="var-name">$file</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$file</span><span class="var-description">: file name</span> </li>
</ul>
</div>
<a name="methodisValidEmail" id="isValidEmail"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method isValidEmail</span> (line <span class="line-number">176</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if given email is valid</p>
<ul class="tags">
<li><span class="field">return:</span> true if email is valid</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">bool</span>
<span class="method-name">
isValidEmail
</span>
(<span class="var-type">string</span> <span class="var-name">$email</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$email</span><span class="var-description">: email to be checked</span> </li>
</ul>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">141</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">CMail</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodaddAttachment" id="addAttachment"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">addAttachment</span> (line <span class="line-number">245</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">add attachment encoded by base64</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
addAttachment
</span>
(<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$inner_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$mime</span> = <span class="var-default">""</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: path to file on server</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$inner_name</span><span class="var-description">: file name displayed in email else filename</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$mime</span><span class="var-description">: own mime type if specified else get it from inner name</span> </li>
</ul>
</div>
<a name="methodclear" id="clear"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">clear</span> (line <span class="line-number">150</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set default attributes</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
clear
</span>
()
</div>
</div>
<a name="methodclearAttachments" id="clearAttachments"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">clearAttachments</span> (line <span class="line-number">232</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">delete all attachments for this email</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
clearAttachments
</span>
()
</div>
</div>
<a name="methodgetInvalidEmail" id="getInvalidEmail"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getInvalidEmail</span> (line <span class="line-number">430</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return invalid email if some else null</p>
<ul class="tags">
<li><span class="field">return:</span> invalid email if any</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getInvalidEmail
</span>
(<span class="var-type">mixed</span> <span class="var-name">$email</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$email</span><span class="var-description">: email of array of emails to be checked</span> </li>
</ul>
</div>
<a name="methodsend" id="send"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">send</span> (line <span class="line-number">298</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send email</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
send
</span>
([<span class="var-type">string</span> <span class="var-name">$emailfile</span> = <span class="var-default">""</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$emailfile</span><span class="var-description">: if specified the current email will be also sent as attachment</span> </li>
</ul>
</div>
<a name="methodsendTo" id="sendTo"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">sendTo</span> (line <span class="line-number">415</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Send email to 1 email only</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
sendTo
</span>
(<span class="var-type">string</span> <span class="var-name">$to</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$to</span><span class="var-description">: target email</span> </li>
</ul>
</div>
<a name="methodstripnl" id="stripnl"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">stripnl</span> (line <span class="line-number">287</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Strip NL</p>
<ul class="tags">
<li><span class="field">return:</span> without white characters</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
stripnl
</span>
(<span class="var-type">string</span> <span class="var-name">$string</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$string</span><span class="var-description">: to be stripped</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 12 Oct 2006 01:53:37 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
</p>
</div></body>
</html>