0
0
mirror of https://github.com/PHPMailer/PHPMailer.git synced 2024-09-20 01:52:15 +02:00

No code changes, just cleanup

Fix some inconsistent phpdoc syntax, make sure scripts have a page-level docblock and version tags
Remove compiled phpdocs from repo
Add docs.ini config file for phpdoc: use `phpdoc -i docs.ini` to generate docs.
This commit is contained in:
Marcus Bointon 2008-11-12 11:16:35 +00:00
parent fb07adf194
commit da06e1d598
17 changed files with 45 additions and 4122 deletions

View File

@ -23,6 +23,7 @@
| - Technology Consulting |
| - Oursourcing (highly qualified programmers and graphic designers) |
'---------------------------------------------------------------------------'
*/
/**
* PHPMailer - PHP email transport class
@ -30,8 +31,15 @@
* @package PHPMailer
* @author Andy Prevost
* @copyright 2004 - 2008 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
* @version $Id$
*/
/**
* PHPMailer - PHP email transport class
* @package PHPMailer
* @author Andy Prevost
*/
class PHPMailer {
/////////////////////////////////////////////////
@ -314,7 +322,7 @@ class PHPMailer {
*/
public function IsQmail() {
$this->Sendmail = '/var/qmail/bin/sendmail';
$this->Mailer = 'sendmail';
$this->Mailer = 'sendmail';
}
/////////////////////////////////////////////////
@ -510,11 +518,12 @@ class PHPMailer {
}
/**
* Sends mail via SMTP using PhpSMTP (Author:
* Chris Ryan). Returns bool. Returns false if there is a
* bad MAIL FROM, RCPT, or DATA input.
* Sends mail via SMTP using PhpSMTP
* Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
* @uses SMTP
* @access public
* @return bool
* @author Chris Ryan
*/
public function SmtpSend($header, $body) {
include_once($this->PluginDir . 'class.smtp.php');
@ -578,8 +587,9 @@ class PHPMailer {
}
/**
* Initiates a connection to an SMTP server. Returns false if the
* operation failed.
* Initiates a connection to an SMTP server.
* Returns false if the operation failed.
* @uses SMTP
* @access public
* @return bool
*/
@ -643,6 +653,7 @@ class PHPMailer {
/**
* Closes the active SMTP session if one exists.
* @uses SMTP
* @return void
*/
public function SmtpClose() {
@ -1711,7 +1722,7 @@ class PHPMailer {
* @access public
* @return $message
*/
public function MsgHTML($message,$basedir='') {
public function MsgHTML($message, $basedir = '') {
preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
if(isset($images[2])) {
foreach($images[2] as $i => $url) {

View File

@ -23,6 +23,17 @@
| - Technology Consulting |
| - Oursourcing (highly qualified programmers and graphic designers) |
'---------------------------------------------------------------------------'
*/
/**
* PHPMailer - PHP POP Before SMTP Authentication Class
* NOTE: Designed for use with PHP version 5 and up
* @package PHPMailer
* @author Andy Prevost
* @copyright 2004 - 2008 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
* @version $Id$
*/
/**
* POP Before SMTP Authentication Class

View File

@ -23,6 +23,17 @@
| - Technology Consulting |
| - Oursourcing (highly qualified programmers and graphic designers) |
'---------------------------------------------------------------------------'
*/
/**
* PHPMailer - PHP SMTP email transport class
* NOTE: Designed for use with PHP version 5 and up
* @package PHPMailer
* @author Andy Prevost
* @copyright 2004 - 2008 Andy Prevost
* @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
* @version $Id$
*/
/**
* SMTP is rfc 821 compliant and implements all the rfc 821 SMTP
@ -96,7 +107,7 @@ class SMTP {
* @access public
* @return bool
*/
public function Connect($host,$port=0,$tval=30) {
public function Connect($host, $port = 0, $tval = 30) {
/* set the error val to null so there is no confusion */
$this->error = null;
@ -154,7 +165,7 @@ class SMTP {
}
/**
* Initiate a TSL communication with the server.
* Initiate a TLS communication with the server.
*
* SMTP CODE 220 Ready to start TLS
* SMTP CODE 501 Syntax error (no parameters allowed)
@ -520,7 +531,7 @@ class SMTP {
* @access public
* @return bool
*/
public function Hello($host="") {
public function Hello($host = '') {
$this->error = null; // so no confusion is caused
if(!$this->connected()) {
@ -594,7 +605,7 @@ class SMTP {
* @access public
* @return string
*/
public function Help($keyword="") {
public function Help($keyword = '') {
$this->error = null; // to avoid confusion
if(!$this->connected()) {
@ -732,7 +743,7 @@ class SMTP {
* @access public
* @return bool
*/
public function Quit($close_on_error=true) {
public function Quit($close_on_error = true) {
$this->error = null; // so there is no confusion
if(!$this->connected()) {

File diff suppressed because it is too large Load Diff

View File

@ -1,734 +0,0 @@
<?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 SMTP</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 SMTP</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">SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.</p>
<ul class="tags">
<li><span class="field">author:</span> <p>Chris Ryan</p></li>
</ul>
<p class="notes">
Located in <a class="field" href="_class_smtp_php.html">Program_Root/class.smtp.php</a> (line <span class="field">24</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">string</span>
<a href="#$CRLF" title="details" class="var-name">$CRLF</a>
</div>
<div class="var-title">
<span class="var-type">bool</span>
<a href="#$do_debug" title="details" class="var-name">$do_debug</a>
</div>
<div class="var-title">
<span class="var-type">int</span>
<a href="#$SMTP_PORT" title="details" class="var-name">$SMTP_PORT</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">
<span class="method-result">void</span>
<a href="#SMTP" title="details" class="method-name">SMTP</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Authenticate" title="details" class="method-name">Authenticate</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$password</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#Close" title="details" class="method-name">Close</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Connect" title="details" class="method-name">Connect</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$port</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$tval</span> = <span class="var-default">30</span>])
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Data" title="details" class="method-name">Data</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$msg_data</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#Expand" title="details" class="method-name">Expand</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Hello" title="details" class="method-name">Hello</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">""</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#Help" title="details" class="method-name">Help</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$keyword</span> = <span class="var-default">""</span>])
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Mail" title="details" class="method-name">Mail</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Noop" title="details" class="method-name">Noop</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Quit" title="details" class="method-name">Quit</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$close_on_error</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Recipient" title="details" class="method-name">Recipient</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$to</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Reset" title="details" class="method-name">Reset</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Send" title="details" class="method-name">Send</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#SendAndMail" title="details" class="method-name">SendAndMail</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#SendOrMail" title="details" class="method-name">SendOrMail</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#Turn" title="details" class="method-name">Turn</a>
()
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#Verify" title="details" class="method-name">Verify</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</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$CRLF" id="$CRLF"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$CRLF</span>
= <span class="var-default"> &quot;\r\n&quot;</span> (line <span class="line-number">36</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SMTP reply line ending</p>
</div>
<a name="var$do_debug" id="$do_debug"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">bool</span>
<span class="var-name">$do_debug</span>
(line <span class="line-number">42</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets whether debugging is turned on</p>
</div>
<a name="var$SMTP_PORT" id="$SMTP_PORT"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">int</span>
<span class="var-name">$SMTP_PORT</span>
= <span class="var-default"> 25</span> (line <span class="line-number">30</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">SMTP server port</p>
</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="methodSMTP" id="SMTP"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor SMTP</span> (line <span class="line-number">57</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialize the class so that the data is in a known state.</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">
SMTP
</span>
()
</div>
</div>
<a name="methodAuthenticate" id="Authenticate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Authenticate</span> (line <span class="line-number">144</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Authenticate
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$password</span>)
</div>
</div>
<a name="methodClose" id="Close"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Close</span> (line <span class="line-number">232</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes the socket and cleans up the state of the class.</p>
<p class="description"><p>It is not considered good to use this function without first trying to use QUIT.</p></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">
Close
</span>
()
</div>
</div>
<a name="methodConnect" id="Connect"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Connect</span> (line <span class="line-number">82</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Connect to the server specified on the port specified.</p>
<p class="description"><p>If the port is not specified use the default SMTP_PORT. If tval is specified then a connection will try and be established with the server for that number of seconds. If tval is not specified the default is 30 seconds to try on the connection.</p><p>SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Connect
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$port</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$tval</span> = <span class="var-default">30</span>])
</div>
</div>
<a name="methodData" id="Data"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Data</span> (line <span class="line-number">266</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Issues a data command and sends the msg_data to the server</p>
<p class="description"><p>finializing the mail transaction. $msg_data is the message that is to be send with the headers. Each header needs to be on a single line followed by a &lt;CRLF&gt; with the message headers and the message body being seperated by and additional &lt;CRLF&gt;.</p><p>Implements rfc 821: DATA &lt;CRLF&gt;</p><p>SMTP CODE INTERMEDIATE: 354 [data] &lt;CRLF&gt;.&lt;CRLF&gt; SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP CODE ERROR : 500,501,503,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Data
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$msg_data</span>)
</div>
</div>
<a name="methodExpand" id="Expand"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Expand</span> (line <span class="line-number">399</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.</p>
<p class="description"><p>Each value in the array returned has the format of: [ &lt;full-name&gt; &lt;sp&gt; ] &lt;path&gt; The definition of &lt;path&gt; is defined in rfc 821</p><p>Implements rfc 821: EXPN &lt;SP&gt; &lt;string&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 550 SMTP CODE ERROR : 500,501,502,504,421</p></p>
<ul class="tags">
<li><span class="field">return:</span> <p>array</p></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
Expand
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
</div>
</div>
<a name="methodHello" id="Hello"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Hello</span> (line <span class="line-number">450</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends the HELO command to the smtp server.</p>
<p class="description"><p>This makes sure that we and the server are in the same known state.</p><p>Implements from rfc 821: HELO &lt;SP&gt; &lt;domain&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Hello
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$host</span> = <span class="var-default">""</span>])
</div>
</div>
<a name="methodHelp" id="Help"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Help</span> (line <span class="line-number">524</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gets help information on the keyword specified. If the keyword</p>
<p class="description"><p>is not specified then returns generic help, ussually contianing A list of keywords that help is available on. This function returns the results back to the user. It is up to the user to handle the returned data. If an error occurs then false is returned with $this-&gt;error set appropiately.</p><p>Implements rfc 821: HELP [ &lt;SP&gt; &lt;string&gt; ] &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 211,214 SMTP CODE ERROR : 500,501,502,504,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
Help
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$keyword</span> = <span class="var-default">""</span>])
</div>
</div>
<a name="methodMail" id="Mail"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Mail</span> (line <span class="line-number">576</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.</p>
<p class="description"><p>Implements rfc 821: MAIL &lt;SP&gt; FROM:&lt;reverse-path&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Mail
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
</div>
<a name="methodNoop" id="Noop"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Noop</span> (line <span class="line-number">618</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends the command NOOP to the SMTP server.</p>
<p class="description"><p>Implements from rfc 821: NOOP &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Noop
</span>
()
</div>
</div>
<a name="methodQuit" id="Quit"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Quit</span> (line <span class="line-number">661</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.</p>
<p class="description"><p>Implements from rfc 821: QUIT &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Quit
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$close_on_error</span> = <span class="var-default">true</span>])
</div>
</div>
<a name="methodRecipient" id="Recipient"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Recipient</span> (line <span class="line-number">715</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</p>
<p class="description"><p>Returns true if the recipient was accepted false if it was rejected.</p><p>Implements from rfc 821: RCPT &lt;SP&gt; TO:&lt;forward-path&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452 SMTP CODE ERROR : 500,501,503,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Recipient
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$to</span>)
</div>
</div>
<a name="methodReset" id="Reset"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Reset</span> (line <span class="line-number">759</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</p>
<p class="description"><p>Implements rfc 821: RSET &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Reset
</span>
()
</div>
</div>
<a name="methodSend" id="Send"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Send</span> (line <span class="line-number">808</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starts a mail transaction from the email address specified in</p>
<p class="description"><p>$from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command. This command will send the message to the users terminal if they are logged in.</p><p>Implements rfc 821: SEND &lt;SP&gt; FROM:&lt;reverse-path&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Send
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
</div>
<a name="methodSendAndMail" id="SendAndMail"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">SendAndMail</span> (line <span class="line-number">856</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starts a mail transaction from the email address specified in</p>
<p class="description"><p>$from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command. This command will send the message to the users terminal if they are logged in and send them an email.</p><p>Implements rfc 821: SAML &lt;SP&gt; FROM:&lt;reverse-path&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
SendAndMail
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
</div>
<a name="methodSendOrMail" id="SendOrMail"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">SendOrMail</span> (line <span class="line-number">904</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starts a mail transaction from the email address specified in</p>
<p class="description"><p>$from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command. This command will send the message to the users terminal if they are logged in or mail it to them if they are not.</p><p>Implements rfc 821: SOML &lt;SP&gt; FROM:&lt;reverse-path&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
SendOrMail
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$from</span>)
</div>
</div>
<a name="methodTurn" id="Turn"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Turn</span> (line <span class="line-number">949</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future</p>
<p class="description"><p>Implements from rfc 821: TURN &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
Turn
</span>
()
</div>
</div>
<a name="methodVerify" id="Verify"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Verify</span> (line <span class="line-number">971</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Verifies that the name is recognized by the server.</p>
<p class="description"><p>Returns false if the name could not be verified otherwise the response from the server is returned.</p><p>Implements rfc 821: VRFY &lt;SP&gt; &lt;string&gt; &lt;CRLF&gt;</p><p>SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,553 SMTP CODE ERROR : 500,501,502,421</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
Verify
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>)
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
</p>
</div></body>
</html>

View File

@ -1,60 +0,0 @@
<?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 page class.phpmailer.php</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="file-name">Program_Root/class.phpmailer.php</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-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PHPMailer/PHPMailer.html">PHPMailer</a>
</td>
<td>
PHPMailer - PHP email transport class
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
</p>
</div></body>
</html>

View File

@ -1,60 +0,0 @@
<?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 page class.smtp.php</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="file-name">Program_Root/class.smtp.php</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-classes">Classes</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
<a name="sec-classes"></a>
<div class="info-box">
<div class="info-box-title">Classes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Classes</span>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em; vertical-align: top">
<a href="../PHPMailer/SMTP.html">SMTP</a>
</td>
<td>
SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.
</td>
</tr>
</table>
</div>
</div>
<p class="notes" id="credit">
Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
</p>
</div></body>
</html>

View File

@ -1,13 +0,0 @@
<html>
<head>
<title>Generated Documentation</title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div align="center"><h1>Generated Documentation</h1></div>
<b>Welcome to default!</b><br />
<br />
This documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor v1.2.0</a><br />
</body>
</html>

View File

@ -1,28 +0,0 @@
<?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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<!-- Start of Class Data -->
<H2>
</H2>
<h2>Root class PHPMailer</h2>
<ul>
<li><a href="PHPMailer/PHPMailer.html">PHPMailer</a></li></ul>
<h2>Root class SMTP</h2>
<ul>
<li><a href="PHPMailer/SMTP.html">SMTP</a></li></ul>
<p class="notes" id="credit">
Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
</p>
</body>
</html>

View File

@ -1,734 +0,0 @@
<?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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<a name="top"></a>
<h2>Full index</h2>
<h3>Package indexes</h3>
<ul>
<li><a href="elementindex_PHPMailer.html">PHPMailer</a></li>
</ul>
<br />
<div class="index-letter-menu">
<a class="index-letter" href="elementindex.html#a">a</a>
<a class="index-letter" href="elementindex.html#b">b</a>
<a class="index-letter" href="elementindex.html#c">c</a>
<a class="index-letter" href="elementindex.html#d">d</a>
<a class="index-letter" href="elementindex.html#e">e</a>
<a class="index-letter" href="elementindex.html#f">f</a>
<a class="index-letter" href="elementindex.html#h">h</a>
<a class="index-letter" href="elementindex.html#i">i</a>
<a class="index-letter" href="elementindex.html#m">m</a>
<a class="index-letter" href="elementindex.html#n">n</a>
<a class="index-letter" href="elementindex.html#p">p</a>
<a class="index-letter" href="elementindex.html#q">q</a>
<a class="index-letter" href="elementindex.html#r">r</a>
<a class="index-letter" href="elementindex.html#s">s</a>
<a class="index-letter" href="elementindex.html#t">t</a>
<a class="index-letter" href="elementindex.html#u">u</a>
<a class="index-letter" href="elementindex.html#v">v</a>
<a class="index-letter" href="elementindex.html#w">w</a>
</div>
<a name="a"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">a</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$AltBody</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.</div>
</dd>
<dt class="field">
<span class="method-title">AddAddress</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;To&quot; address.</div>
</dd>
<dt class="field">
<span class="method-title">AddAttachment</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds an attachment from a path on the filesystem.</div>
</dd>
<dt class="field">
<span class="method-title">AddBCC</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Bcc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
</dd>
<dt class="field">
<span class="method-title">AddCC</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Cc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
</dd>
<dt class="field">
<span class="method-title">AddCustomHeader</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a custom header.</div>
</dd>
<dt class="field">
<span class="method-title">AddEmbeddedImage</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use &quot;image/jpeg&quot; and for GIF images use &quot;image/gif&quot;.</div>
</dd>
<dt class="field">
<span class="method-title">AddReplyTo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Reply-to&quot; address.</div>
</dd>
<dt class="field">
<span class="method-title">AddStringAttachment</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div>
</dd>
<dt class="field">
<span class="method-title">Authenticate</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div>
<div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div>
</dd>
</dl>
<a name="b"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">b</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Body</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">c</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$CharSet</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the CharSet of the message.</div>
</dd>
<dt class="field">
<span class="var-title">$ConfirmReadingTo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div>
</dd>
<dt class="field">
<span class="var-title">$ContentType</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Content-type of the message.</div>
</dd>
<dt class="field">
<span class="var-title">$CRLF</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div>
<div class="index-item-description">SMTP reply line ending</div>
</dd>
<dt class="field">
<span class="include-title">class.phpmailer.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div>
</dd>
<dt class="field">
<span class="include-title">class.smtp.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div>
</dd>
<dt class="field">
<span class="method-title">ClearAddresses</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearAllRecipients</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearAttachments</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearBCCs</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearCCs</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearCustomHeaders</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all custom headers. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearReplyTos</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">Close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div>
<div class="index-item-description">Closes the socket and cleans up the state of the class.</div>
</dd>
<dt class="field">
<span class="method-title">Connect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div>
<div class="index-item-description">Connect to the server specified on the port specified.</div>
</dd>
</dl>
<a name="d"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">d</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$do_debug</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div>
<div class="index-item-description">Sets whether debugging is turned on</div>
</dd>
<dt class="field">
<span class="method-title">Data</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div>
<div class="index-item-description">Issues a data command and sends the msg_data to the server</div>
</dd>
</dl>
<a name="e"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">e</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Encoding</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Encoding of the message. Options for this are &quot;8bit&quot;, &quot;7bit&quot;, &quot;binary&quot;, &quot;base64&quot;, and &quot;quoted-printable&quot;.</div>
</dd>
<dt class="field">
<span class="var-title">$ErrorInfo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div>
<div class="index-item-description">Holds the most recent mailer error message.</div>
</dd>
<dt class="field">
<span class="method-title">Expand</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div>
<div class="index-item-description">Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.</div>
</dd>
</dl>
<a name="f"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">f</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$From</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the From email address for the message.</div>
</dd>
<dt class="field">
<span class="var-title">$FromName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the From name of the message.</div>
</dd>
</dl>
<a name="h"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">h</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Helo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div>
</dd>
<dt class="field">
<span class="var-title">$Host</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. &quot;smtp1.example.com:25;smtp2.example.com&quot;).</div>
</dd>
<dt class="field">
<span class="var-title">$Hostname</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.</div>
</dd>
<dt class="field">
<span class="method-title">Hello</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the HELO command to the smtp server.</div>
</dd>
<dt class="field">
<span class="method-title">Help</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div>
<div class="index-item-description">Gets help information on the keyword specified. If the keyword</div>
</dd>
</dl>
<a name="i"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">i</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">IsError</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div>
<div class="index-item-description">Returns true if an error occurred.</div>
</dd>
<dt class="field">
<span class="method-title">IsHTML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets message type to HTML.</div>
</dd>
<dt class="field">
<span class="method-title">IsMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div>
</dd>
<dt class="field">
<span class="method-title">IsQmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div>
</dd>
<dt class="field">
<span class="method-title">IsSendmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div>
</dd>
<dt class="field">
<span class="method-title">IsSMTP</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using SMTP.</div>
</dd>
</dl>
<a name="m"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">m</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Mailer</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div>
<div class="index-item-description">Method to send mail: (&quot;mail&quot;, &quot;sendmail&quot;, or &quot;smtp&quot;).</div>
</dd>
<dt class="field">
<span class="method-title">Mail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.</div>
</dd>
</dl>
<a name="n"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">n</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Noop</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the command NOOP to the SMTP server.</div>
</dd>
</dl>
<a name="p"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">p</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Password</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP password.</div>
</dd>
<dt class="field">
<span class="var-title">$PluginDir</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div>
<div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div>
</dd>
<dt class="field">
<span class="var-title">$Port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the default SMTP server port.</div>
</dd>
<dt class="field">
<span class="var-title">$Priority</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div>
<div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div>
</dd>
<dt class="field">
PHPMailer
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div>
<div class="index-item-description">PHPMailer - PHP email transport class</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">q</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Quit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.</div>
</dd>
</dl>
<a name="r"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">r</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Recipient</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div>
</dd>
<dt class="field">
<span class="method-title">Reset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div>
</dd>
</dl>
<a name="s"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">s</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Sender</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.</div>
</dd>
<dt class="field">
<span class="var-title">$Sendmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the path of the sendmail program.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPAuth</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPDebug</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP class debugging on or off.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPKeepAlive</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div>
<div class="index-item-description">Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().</div>
</dd>
<dt class="field">
<span class="var-title">$SMTP_PORT</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div>
<div class="index-item-description">SMTP server port</div>
</dd>
<dt class="field">
<span class="var-title">$Subject</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Subject of the message.</div>
</dd>
<dt class="field">
<span class="method-title">Send</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">Send</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div>
<div class="index-item-description">Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.</div>
</dd>
<dt class="field">
<span class="method-title">SendAndMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">SendOrMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">SetLanguage</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div>
</dd>
<dt class="field">
<span class="method-title">SMTP</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div>
<div class="index-item-description">Initialize the class so that the data is in a known state.</div>
</dd>
<dt class="field">
SMTP
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div>
<div class="index-item-description">SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.</div>
</dd>
<dt class="field">
<span class="method-title">SmtpClose</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div>
<div class="index-item-description">Closes the active SMTP session if one exists.</div>
</dd>
</dl>
<a name="t"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">t</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Timeout</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div>
</dd>
<dt class="field">
<span class="method-title">Turn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div>
<div class="index-item-description">This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">u</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Username</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP username.</div>
</dd>
</dl>
<a name="v"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">v</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Version</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div>
<div class="index-item-description">Holds PHPMailer version.</div>
</dd>
<dt class="field">
<span class="method-title">Verify</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div>
<div class="index-item-description">Verifies that the name is recognized by the server.</div>
</dd>
</dl>
<a name="w"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">w</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$WordWrap</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div>
</dd>
</dl>
<div class="index-letter-menu">
<a class="index-letter" href="elementindex.html#a">a</a>
<a class="index-letter" href="elementindex.html#b">b</a>
<a class="index-letter" href="elementindex.html#c">c</a>
<a class="index-letter" href="elementindex.html#d">d</a>
<a class="index-letter" href="elementindex.html#e">e</a>
<a class="index-letter" href="elementindex.html#f">f</a>
<a class="index-letter" href="elementindex.html#h">h</a>
<a class="index-letter" href="elementindex.html#i">i</a>
<a class="index-letter" href="elementindex.html#m">m</a>
<a class="index-letter" href="elementindex.html#n">n</a>
<a class="index-letter" href="elementindex.html#p">p</a>
<a class="index-letter" href="elementindex.html#q">q</a>
<a class="index-letter" href="elementindex.html#r">r</a>
<a class="index-letter" href="elementindex.html#s">s</a>
<a class="index-letter" href="elementindex.html#t">t</a>
<a class="index-letter" href="elementindex.html#u">u</a>
<a class="index-letter" href="elementindex.html#v">v</a>
<a class="index-letter" href="elementindex.html#w">w</a>
</div> </body>
</html>

View File

@ -1,731 +0,0 @@
<?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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<a name="top"></a>
<h2>[PHPMailer] element index</h2>
<a href="elementindex.html">All elements</a>
<br />
<div class="index-letter-menu">
<a class="index-letter" href="elementindex_PHPMailer.html#a">a</a>
<a class="index-letter" href="elementindex_PHPMailer.html#b">b</a>
<a class="index-letter" href="elementindex_PHPMailer.html#c">c</a>
<a class="index-letter" href="elementindex_PHPMailer.html#d">d</a>
<a class="index-letter" href="elementindex_PHPMailer.html#e">e</a>
<a class="index-letter" href="elementindex_PHPMailer.html#f">f</a>
<a class="index-letter" href="elementindex_PHPMailer.html#h">h</a>
<a class="index-letter" href="elementindex_PHPMailer.html#i">i</a>
<a class="index-letter" href="elementindex_PHPMailer.html#m">m</a>
<a class="index-letter" href="elementindex_PHPMailer.html#n">n</a>
<a class="index-letter" href="elementindex_PHPMailer.html#p">p</a>
<a class="index-letter" href="elementindex_PHPMailer.html#q">q</a>
<a class="index-letter" href="elementindex_PHPMailer.html#r">r</a>
<a class="index-letter" href="elementindex_PHPMailer.html#s">s</a>
<a class="index-letter" href="elementindex_PHPMailer.html#t">t</a>
<a class="index-letter" href="elementindex_PHPMailer.html#u">u</a>
<a class="index-letter" href="elementindex_PHPMailer.html#v">v</a>
<a class="index-letter" href="elementindex_PHPMailer.html#w">w</a>
</div>
<a name="a"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">a</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$AltBody</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.</div>
</dd>
<dt class="field">
<span class="method-title">AddAddress</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;To&quot; address.</div>
</dd>
<dt class="field">
<span class="method-title">AddAttachment</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds an attachment from a path on the filesystem.</div>
</dd>
<dt class="field">
<span class="method-title">AddBCC</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Bcc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
</dd>
<dt class="field">
<span class="method-title">AddCC</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Cc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
</dd>
<dt class="field">
<span class="method-title">AddCustomHeader</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a custom header.</div>
</dd>
<dt class="field">
<span class="method-title">AddEmbeddedImage</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use &quot;image/jpeg&quot; and for GIF images use &quot;image/gif&quot;.</div>
</dd>
<dt class="field">
<span class="method-title">AddReplyTo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a &quot;Reply-to&quot; address.</div>
</dd>
<dt class="field">
<span class="method-title">AddStringAttachment</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div>
<div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div>
</dd>
<dt class="field">
<span class="method-title">Authenticate</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div>
<div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div>
</dd>
</dl>
<a name="b"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">b</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Body</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">c</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$CharSet</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the CharSet of the message.</div>
</dd>
<dt class="field">
<span class="var-title">$ConfirmReadingTo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div>
</dd>
<dt class="field">
<span class="var-title">$ContentType</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Content-type of the message.</div>
</dd>
<dt class="field">
<span class="var-title">$CRLF</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div>
<div class="index-item-description">SMTP reply line ending</div>
</dd>
<dt class="field">
<span class="include-title">class.phpmailer.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div>
</dd>
<dt class="field">
<span class="include-title">class.smtp.php</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div>
</dd>
<dt class="field">
<span class="method-title">ClearAddresses</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearAllRecipients</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearAttachments</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearBCCs</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearCCs</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearCustomHeaders</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all custom headers. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">ClearReplyTos</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div>
<div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div>
</dd>
<dt class="field">
<span class="method-title">Close</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div>
<div class="index-item-description">Closes the socket and cleans up the state of the class.</div>
</dd>
<dt class="field">
<span class="method-title">Connect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div>
<div class="index-item-description">Connect to the server specified on the port specified.</div>
</dd>
</dl>
<a name="d"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">d</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$do_debug</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div>
<div class="index-item-description">Sets whether debugging is turned on</div>
</dd>
<dt class="field">
<span class="method-title">Data</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div>
<div class="index-item-description">Issues a data command and sends the msg_data to the server</div>
</dd>
</dl>
<a name="e"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">e</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Encoding</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Encoding of the message. Options for this are &quot;8bit&quot;, &quot;7bit&quot;, &quot;binary&quot;, &quot;base64&quot;, and &quot;quoted-printable&quot;.</div>
</dd>
<dt class="field">
<span class="var-title">$ErrorInfo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div>
<div class="index-item-description">Holds the most recent mailer error message.</div>
</dd>
<dt class="field">
<span class="method-title">Expand</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div>
<div class="index-item-description">Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.</div>
</dd>
</dl>
<a name="f"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">f</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$From</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the From email address for the message.</div>
</dd>
<dt class="field">
<span class="var-title">$FromName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the From name of the message.</div>
</dd>
</dl>
<a name="h"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">h</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Helo</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div>
</dd>
<dt class="field">
<span class="var-title">$Host</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. &quot;smtp1.example.com:25;smtp2.example.com&quot;).</div>
</dd>
<dt class="field">
<span class="var-title">$Hostname</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.</div>
</dd>
<dt class="field">
<span class="method-title">Hello</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the HELO command to the smtp server.</div>
</dd>
<dt class="field">
<span class="method-title">Help</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div>
<div class="index-item-description">Gets help information on the keyword specified. If the keyword</div>
</dd>
</dl>
<a name="i"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">i</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">IsError</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div>
<div class="index-item-description">Returns true if an error occurred.</div>
</dd>
<dt class="field">
<span class="method-title">IsHTML</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets message type to HTML.</div>
</dd>
<dt class="field">
<span class="method-title">IsMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div>
</dd>
<dt class="field">
<span class="method-title">IsQmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div>
</dd>
<dt class="field">
<span class="method-title">IsSendmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div>
</dd>
<dt class="field">
<span class="method-title">IsSMTP</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets Mailer to send message using SMTP.</div>
</dd>
</dl>
<a name="m"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">m</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Mailer</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div>
<div class="index-item-description">Method to send mail: (&quot;mail&quot;, &quot;sendmail&quot;, or &quot;smtp&quot;).</div>
</dd>
<dt class="field">
<span class="method-title">Mail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.</div>
</dd>
</dl>
<a name="n"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">n</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Noop</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the command NOOP to the SMTP server.</div>
</dd>
</dl>
<a name="p"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">p</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Password</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP password.</div>
</dd>
<dt class="field">
<span class="var-title">$PluginDir</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div>
<div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div>
</dd>
<dt class="field">
<span class="var-title">$Port</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the default SMTP server port.</div>
</dd>
<dt class="field">
<span class="var-title">$Priority</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div>
<div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div>
</dd>
<dt class="field">
PHPMailer
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div>
<div class="index-item-description">PHPMailer - PHP email transport class</div>
</dd>
</dl>
<a name="q"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">q</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Quit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.</div>
</dd>
</dl>
<a name="r"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">r</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="method-title">Recipient</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div>
</dd>
<dt class="field">
<span class="method-title">Reset</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div>
<div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div>
</dd>
</dl>
<a name="s"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">s</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Sender</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.</div>
</dd>
<dt class="field">
<span class="var-title">$Sendmail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the path of the sendmail program.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPAuth</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPDebug</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP class debugging on or off.</div>
</dd>
<dt class="field">
<span class="var-title">$SMTPKeepAlive</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div>
<div class="index-item-description">Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().</div>
</dd>
<dt class="field">
<span class="var-title">$SMTP_PORT</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div>
<div class="index-item-description">SMTP server port</div>
</dd>
<dt class="field">
<span class="var-title">$Subject</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the Subject of the message.</div>
</dd>
<dt class="field">
<span class="method-title">Send</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">Send</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div>
<div class="index-item-description">Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.</div>
</dd>
<dt class="field">
<span class="method-title">SendAndMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">SendOrMail</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div>
<div class="index-item-description">Starts a mail transaction from the email address specified in</div>
</dd>
<dt class="field">
<span class="method-title">SetLanguage</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div>
</dd>
<dt class="field">
<span class="method-title">SMTP</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div>
<div class="index-item-description">Initialize the class so that the data is in a known state.</div>
</dd>
<dt class="field">
SMTP
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div>
<div class="index-item-description">SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.</div>
</dd>
<dt class="field">
<span class="method-title">SmtpClose</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div>
<div class="index-item-description">Closes the active SMTP session if one exists.</div>
</dd>
</dl>
<a name="t"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">t</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Timeout</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div>
</dd>
<dt class="field">
<span class="method-title">Turn</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div>
<div class="index-item-description">This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">u</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Username</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets SMTP username.</div>
</dd>
</dl>
<a name="v"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">v</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$Version</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div>
<div class="index-item-description">Holds PHPMailer version.</div>
</dd>
<dt class="field">
<span class="method-title">Verify</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div>
<div class="index-item-description">Verifies that the name is recognized by the server.</div>
</dd>
</dl>
<a name="w"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">w</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<span class="var-title">$WordWrap</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div>
<div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div>
</dd>
</dl>
<div class="index-letter-menu">
<a class="index-letter" href="elementindex_PHPMailer.html#a">a</a>
<a class="index-letter" href="elementindex_PHPMailer.html#b">b</a>
<a class="index-letter" href="elementindex_PHPMailer.html#c">c</a>
<a class="index-letter" href="elementindex_PHPMailer.html#d">d</a>
<a class="index-letter" href="elementindex_PHPMailer.html#e">e</a>
<a class="index-letter" href="elementindex_PHPMailer.html#f">f</a>
<a class="index-letter" href="elementindex_PHPMailer.html#h">h</a>
<a class="index-letter" href="elementindex_PHPMailer.html#i">i</a>
<a class="index-letter" href="elementindex_PHPMailer.html#m">m</a>
<a class="index-letter" href="elementindex_PHPMailer.html#n">n</a>
<a class="index-letter" href="elementindex_PHPMailer.html#p">p</a>
<a class="index-letter" href="elementindex_PHPMailer.html#q">q</a>
<a class="index-letter" href="elementindex_PHPMailer.html#r">r</a>
<a class="index-letter" href="elementindex_PHPMailer.html#s">s</a>
<a class="index-letter" href="elementindex_PHPMailer.html#t">t</a>
<a class="index-letter" href="elementindex_PHPMailer.html#u">u</a>
<a class="index-letter" href="elementindex_PHPMailer.html#v">v</a>
<a class="index-letter" href="elementindex_PHPMailer.html#w">w</a>
</div> </body>
</html>

View File

@ -1,23 +0,0 @@
<?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>phpDocumentor Parser Errors and Warnings</title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<a href="#Post-parsing">Post-parsing</a><br>
<a href="#class.smtp.php">class.smtp.php</a><br>
<h1>class.phpmailer.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 1530</b> - no @package tag was used in a DocBlock for file C:\dev\phpDocumentor-1.2.0\Classes\class.phpmailer.php<br>
<h1>class.smtp.php</h1>
<h2>Warnings:</h2><br>
<b>Warning on line 1039</b> - no @package tag was used in a DocBlock for file C:\dev\phpDocumentor-1.2.0\Classes\class.smtp.php<br>
<p class="notes" id="credit">
Documention generated on Mon, 28 Jul 2003 23:25:50 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
</p>
</body>
</html>

View File

@ -1,24 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//FR"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- Generated by phpDocumentor on Mon, 28 Jul 2003 23:25:49 -0400 -->
<title>Generated Documentation</title>
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<FRAMESET rows='100,*'>
<FRAME src='packages.html' name='left_top' frameborder="1" bordercolor="#999999">
<FRAMESET cols='25%,*'>
<FRAME src='li_PHPMailer.html' name='left_bottom' frameborder="1" bordercolor="#999999">
<FRAME src='blank.html' name='right' frameborder="1" bordercolor="#999999">
</FRAMESET>
<NOFRAMES>
<H2>Frame Alert</H2>
<P>This document is designed to be viewed using the frames feature.
If you see this message, you are using a non-frame-capable web client.</P>
</NOFRAMES>
</FRAMESET>
</HTML>

View File

@ -1,36 +0,0 @@
<?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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="package-title">PHPMailer</div>
<div class="package-details">
<dl class="tree">
<dt class="folder-title">Description</dt>
<dd>
<a href='classtrees_PHPMailer.html' target='right'>Class trees</a><br />
<a href='elementindex_PHPMailer.html' target='right'>Index of elements</a><br />
</dd>
<dt class="folder-title">Classes</dt>
<dd><a href='PHPMailer/PHPMailer.html' target='right'>PHPMailer</a></dd>
<dd><a href='PHPMailer/SMTP.html' target='right'>SMTP</a></dd>
<dt class="folder-title">Files</dt>
<dd><a href='PHPMailer/_class_phpmailer_php.html' target='right'>class.phpmailer.php</a></dd>
<dd><a href='PHPMailer/_class_smtp_php.html' target='right'>class.smtp.php</a></dd>
</dl>
</div>
<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.2.0</span></a></p>
</BODY>
</HTML>

View File

@ -1,32 +0,0 @@
body
{
background-color: #CCCCFF;
margin: 0px;
padding: 0px;
}
/* Banner (top bar) classes */
.banner { }
.banner-menu
{
clear: both;
padding: .5em;
border-top: 2px solid #6666AA;
}
.banner-title
{
text-align: right;
font-size: 20pt;
font-weight: bold;
margin: .2em;
}
.package-selector
{
background-color: #AAAADD;
border: 1px solid black;
color: yellow;
}

View File

@ -1,133 +0,0 @@
a { color: #336699; text-decoration: none; }
a:hover { color: #6699CC; text-decoration: underline; }
a:active { color: #6699CC; text-decoration: underline; }
body, table { font-family: Georgia, Times New Roman, Times, serif; font-size: 10pt }
p, li { line-height: 140% }
a img { border: 0px; }
dd { margin-left: 0px; padding-left: 1em; }
/* Page layout/boxes */
.info-box {}
.info-box-title { margin: 1em 0em 0em 0em; padding: .25em; font-weight: normal; font-size: 14pt; border: 2px solid #999999; background-color: #CCCCFF }
.info-box-body { border: 1px solid #999999; padding: .5em; }
.nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }
.oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
.evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
.page-body { max-width: 800px; margin: auto; }
.tree dl { margin: 0px }
/* Index formatting classes */
.index-item-body { margin-top: .5em; margin-bottom: .5em}
.index-item-description { margin-top: .25em }
.index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
.index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
.index-letter-title { font-size: 12pt; font-weight: bold }
.index-letter-menu { text-align: center; margin: 1em }
.index-letter { font-size: 12pt }
/* Docbook classes */
.description {}
.short-description { font-weight: bold; color: #666666; }
.tags { padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
.parameters { padding-left: 0em; margin-left: 3em; font-style: italic; list-style-type: square; }
.redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
.package { }
.package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
.package-details { font-size: 85%; }
.sub-package { font-weight: bold; font-size: 120% }
.tutorial { border-width: thin; border-color: #0066ff }
.tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
.nav-button-disabled { color: #999999; }
.nav-button:active,
.nav-button:focus,
.nav-button:hover { background-color: #DDDDDD; outline: 1px solid #999999; text-decoration: none }
.folder-title { font-style: italic }
/* Generic formatting */
.field { font-weight: bold; }
.detail { font-size: 8pt; }
.notes { font-style: italic; font-size: 8pt; }
.separator { background-color: #999999; height: 2px; }
.warning { color: #FF6600; }
.disabled { font-style: italic; color: #999999; }
/* Code elements */
.line-number { }
.class-table { width: 100%; }
.class-table-header { border-bottom: 1px dotted #666666; text-align: left}
.class-name { color: #000000; font-weight: bold; }
.method-summary { padding-left: 1em; font-size: 8pt }
.method-header { }
.method-definition { margin-bottom: .3em }
.method-title { font-weight: bold; }
.method-name { font-weight: bold; }
.method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
.method-result { font-style: italic; }
.var-summary { padding-left: 1em; font-size: 8pt; }
.var-header { }
.var-title { margin-bottom: .3em }
.var-type { font-style: italic; }
.var-name { font-weight: bold; }
.var-default {}
.var-description { font-weight: normal; color: #000000; }
.include-title { }
.include-type { font-style: italic; }
.include-name { font-weight: bold; }
.const-title { }
.const-name { font-weight: bold; }
/* Syntax highlighting */
.src-code { border: 1px solid #336699; padding: 1em; background-color: #EEEEEE; }
.src-comm { color: green; }
.src-id { }
.src-inc { color: #0000FF; }
.src-key { color: #0000FF; }
.src-num { color: #CC0000; }
.src-str { color: #66cccc; }
.src-sym { font-weight: bold; }
.src-var { }
.src-php { font-weight: bold; }
.src-doc { color: #009999 }
.src-doc-close-template { color: #0000FF }
.src-doc-coretag { color: #0099FF; font-weight: bold }
.src-doc-inlinetag { color: #0099FF }
.src-doc-internal { color: #6699cc }
.src-doc-tag { color: #0080CC }
.src-doc-template { color: #0000FF }
.src-doc-type { font-style: italic }
.src-doc-var { font-style: italic }
/* tutorial */
.authors { }
.author { font-style: italic; font-weight: bold }
.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em }
.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap }
.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
.ref-title-box { }
.ref-title { }
.ref-purpose { font-style: italic; color: #666666 }
.ref-synopsis { }
.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #CCCCFF }
.cmd-synopsis { margin: 1em 0em }
.cmd-title { font-weight: bold }
.toc { margin-left: 2em; padding-left: 0em }

View File

@ -1,27 +0,0 @@
<?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></title>
<link rel="stylesheet" href="media/stylesheet.css" />
<link rel="stylesheet" href="media/banner.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="banner">
<div class="banner-title">PHPMailer</div>
<div class="banner-menu">
<table cellpadding="0" cellspacing="0" style="width: 100%">
<tr>
<td>
</td>
<td style="width: 2em">&nbsp;</td>
<td style="text-align: right">
</td>
</tr>
</table>
</div>
</div>
</body>
</html>