<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by PhpDoc date: 'Wed, 22 Jan 2003 18:41:33 -0500' -->
<TITLE>Docs For Class phpmailer</TITLE>
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
</HEAD>
<BODY BGCOLOR='white'>
<!-- Start of Class Data -->
<H2>
Class phpmailer
</H2>
<pre>
phpmailer
</pre>
<H3>
Classes extended from phpmailer:
</H3>
<p>
<b><i>Located in File: Program_Root/class.phpmailer.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>phpmailer - PHP email transport class</b>
<pre>
</pre>
<UL>
<LI><b>Package</b> - <CODE>default</CODE></LI>
<LI><b>Author</b> - <CODE>Brent R. Matzelle</CODE></LI>
</UL>
<hr>
<!-- =========== VAR SUMMARY =========== -->
<A NAME='var_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Class Variable Summary</B></FONT>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$AltBody'>$AltBody</A></B></CODE>
<BR>
<blockquote> Sets the text-only body of the message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Body'>$Body</A></B></CODE>
<BR>
<blockquote> Sets the Body of the message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$CharSet'>$CharSet</A></B></CODE>
<BR>
<blockquote> Sets the CharSet of the message. </blockquote>
<blockquote> Default Value: <CODE>->iso-8859-1<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$ConfirmReadingTo'>$ConfirmReadingTo</A></B></CODE>
<BR>
<blockquote> Sets the email address that a reading confirmation will be sent. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$ContentType'>$ContentType</A></B></CODE>
<BR>
<blockquote> Sets the Content-type of the message. </blockquote>
<blockquote> Default Value: <CODE>->text/plain<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$CustomHeader'>$CustomHeader</A></B></CODE>
<BR>
<blockquote> Holds all custom headers. </blockquote>
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Encoding'>$Encoding</A></B></CODE>
<BR>
<blockquote> Sets the Encoding of the message. </blockquote>
<blockquote> Default Value: <CODE>->8bit<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$ErrorInfo'>$ErrorInfo</A></B></CODE>
<BR>
<blockquote> Holds the most recent mailer error message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$From'>$From</A></B></CODE>
<BR>
<blockquote> Sets the From email address for the message. </blockquote>
<blockquote> Default Value: <CODE>->hide@address.com<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$FromName'>$FromName</A></B></CODE>
<BR>
<blockquote> Sets the From name of the message. </blockquote>
<blockquote> Default Value: <CODE>->Root User<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Helo'>$Helo</A></B></CODE>
<BR>
<blockquote> Sets the SMTP HELO of the message (Default is $Hostname). </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Host'>$Host</A></B></CODE>
<BR>
<blockquote> Sets the SMTP hosts. </blockquote>
<blockquote> Default Value: <CODE>->localhost<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Hostname'>$Hostname</A></B></CODE>
<BR>
<blockquote> Sets the hostname to use in Message-Id and Received headers
and as default HELO string. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$LE'>$LE</A></B></CODE>
<BR>
<blockquote> Sets the line endings of the message. </blockquote>
<blockquote> Default Value: <CODE>->\n<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Mailer'>$Mailer</A></B></CODE>
<BR>
<blockquote> Method to send mail: ("mail", "sendmail", or "smtp"). </blockquote>
<blockquote> Default Value: <CODE>->mail<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$message_type'>$message_type</A></B></CODE>
<BR>
<blockquote> Holds the type of the message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Password'>$Password</A></B></CODE>
<BR>
<blockquote> Sets SMTP password. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$PluginDir'>$PluginDir</A></B></CODE>
<BR>
<blockquote> Path to phpmailer plugins. This is now only useful if the SMTP class
is in a different directory than the PHP include path. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Port'>$Port</A></B></CODE>
<BR>
<blockquote> Sets the default SMTP server port. </blockquote>
<blockquote> Default Value: <CODE>->25<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Priority'>$Priority</A></B></CODE>
<BR>
<blockquote> Email priority (1 = High, 3 = Normal, 5 = low). </blockquote>
<blockquote> Default Value: <CODE>->3<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$ReplyTo'>$ReplyTo</A></B></CODE>
<BR>
<blockquote> Holds all "Reply-To" addresses. </blockquote>
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Sender'>$Sender</A></B></CODE>
<BR>
<blockquote> Sets the Sender email of the message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Sendmail'>$Sendmail</A></B></CODE>
<BR>
<blockquote> Sets the path of the sendmail program. </blockquote>
<blockquote> Default Value: <CODE>->/usr/sbin/sendmail<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$SMTPAuth'>$SMTPAuth</A></B></CODE>
<BR>
<blockquote> Sets SMTP authentication. </blockquote>
<blockquote> Default Value: <CODE>->false<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$SMTPDebug'>$SMTPDebug</A></B></CODE>
<BR>
<blockquote> Sets SMTP class debugging on or off. </blockquote>
<blockquote> Default Value: <CODE>->false<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Subject'>$Subject</A></B></CODE>
<BR>
<blockquote> Sets the Subject of the message. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Timeout'>$Timeout</A></B></CODE>
<BR>
<blockquote> Sets the SMTP server timeout in seconds. </blockquote>
<blockquote> Default Value: <CODE>->10<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$UseMSMailHeaders'>$UseMSMailHeaders</A></B></CODE>
<BR>
<blockquote> Turns Microsoft mail client headers on and off. </blockquote>
<blockquote> Default Value: <CODE>->false<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Username'>$Username</A></B></CODE>
<BR>
<blockquote> Sets SMTP username. </blockquote>
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$Version'>$Version</A></B></CODE>
<BR>
<blockquote> Holds phpmailer version. </blockquote>
<blockquote> Default Value: <CODE>->1.65<-</CODE> </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#$WordWrap'>$WordWrap</A></B></CODE>
<BR>
<blockquote> Sets word wrapping on the body of the message to a given number of
characters. </blockquote>
<blockquote> Default Value: <CODE>->0<-</CODE> </blockquote>
</TD>
</TR>
</TABLE>
<hr>
<!-- =========== VAR SUMMARY =========== -->
<A NAME='var_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Inherited Class Variable Summary</B></FONT>
</TD>
</TR>
</TABLE>
<hr>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Inherited Method Summary</B></FONT>
</TD>
</TR>
</TABLE>
<br>
<!-- should have constructor at some point -->
<!-- =========== Method SUMMARY =========== -->
<A NAME='Method_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Method Summary</B></FONT>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddAddress'>void AddAddress ( $address, $name )</A></B></CODE>
<BR>
<blockquote> Adds a "To" address. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddAttachment'>bool AddAttachment ( $path, $name, [$encoding = "base64"], [$type = "application/octet-stream"] )</A></B></CODE>
<BR>
<blockquote> Adds an attachment from a path on the filesystem. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddBCC'>void AddBCC ( $address, $name )</A></B></CODE>
<BR>
<blockquote> Adds a "Bcc" address. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddCC'>void AddCC ( $address, $name )</A></B></CODE>
<BR>
<blockquote> Adds a "Cc" address. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddCustomHeader'>void AddCustomHeader ( $custom_header )</A></B></CODE>
<BR>
<blockquote> Adds a custom header. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddEmbeddedImage'>bool AddEmbeddedImage ( $path, $cid, $name, [$encoding = "base64"], [$type = "application/octet-stream"] )</A></B></CODE>
<BR>
<blockquote> Adds an embedded attachment. This can include images, sounds, and
just about any other document. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddReplyTo'>void AddReplyTo ( $address, $name )</A></B></CODE>
<BR>
<blockquote> Adds a "Reply-to" address. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#AddStringAttachment'>void AddStringAttachment ( $string, $filename, [$encoding = "base64"], [$type = "application/octet-stream"] )</A></B></CODE>
<BR>
<blockquote> Adds a string or binary attachment (non-filesystem) to the list. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearAddresses'>void ClearAddresses ( )</A></B></CODE>
<BR>
<blockquote> Clears all recipients assigned in the TO array. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearAllRecipients'>void ClearAllRecipients ( )</A></B></CODE>
<BR>
<blockquote> Clears all recipients assigned in the TO, CC and BCC
array. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearAttachments'>void ClearAttachments ( )</A></B></CODE>
<BR>
<blockquote> Clears all previously set filesystem, string, and binary
attachments. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearBCCs'>void ClearBCCs ( )</A></B></CODE>
<BR>
<blockquote> Clears all recipients assigned in the BCC array. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearCCs'>void ClearCCs ( )</A></B></CODE>
<BR>
<blockquote> Clears all recipients assigned in the CC array. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearCustomHeaders'>void ClearCustomHeaders ( )</A></B></CODE>
<BR>
<blockquote> Clears all custom headers. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#ClearReplyTos'>void ClearReplyTos ( )</A></B></CODE>
<BR>
<blockquote> Clears all recipients assigned in the ReplyTo array. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#IsHTML'>void IsHTML ( $bool )</A></B></CODE>
<BR>
<blockquote> Sets message type to HTML. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#IsMail'>void IsMail ( )</A></B></CODE>
<BR>
<blockquote> Sets Mailer to send message using PHP mail() function.
Returns void. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#IsQmail'>void IsQmail ( )</A></B></CODE>
<BR>
<blockquote> Sets Mailer to send message using the qmail MTA. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#IsSendmail'>void IsSendmail ( )</A></B></CODE>
<BR>
<blockquote> Sets Mailer to send message using the $Sendmail program.
Returns void. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#IsSMTP'>void IsSMTP ( )</A></B></CODE>
<BR>
<blockquote> Sets Mailer to send message using SMTP.
Returns void. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#Send'>bool Send ( )</A></B></CODE>
<BR>
<blockquote> Creates message and assigns Mailer. </blockquote>
</TD>
</TR>
<!-- =========== Summary =========== -->
<TR BGCOLOR='white' CLASS='TableRowColor'>
<TD>
<CODE><B><A HREF='phpmailer.html#SendToQueue'>string SendToQueue ( $queue_path, [$send_time = 0] )</A></B></CODE>
<BR>
<blockquote> Sends mail message to an assigned queue directory. </blockquote>
</TD>
</TR>
</TABLE>
<hbr>
<!-- ============ VARIABLE DETAIL =========== -->
<A NAME='variable_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Variable Detail</B></FONT>
</TD>
</TR>
</TABLE>
<A NAME='$AltBody'><!-- --></A><H3>$AltBody</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the text-only body of the message.</b>
<pre>
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.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Body'><!-- --></A><H3>$Body</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the Body of the message.</b>
<pre>
This can be either an HTML or text body.
If HTML then run IsHTML(true).
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$CharSet'><!-- --></A><H3>$CharSet</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the CharSet of the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$ConfirmReadingTo'><!-- --></A><H3>$ConfirmReadingTo</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the email address that a reading confirmation will be sent.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$ContentType'><!-- --></A><H3>$ContentType</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the Content-type of the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$CustomHeader'><!-- --></A><H3>$CustomHeader</H3>
<b>Data type:</b> array<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Holds all custom headers.</b>
<pre>
</pre>
<UL>
</UL>
<HR>
<A NAME='$Encoding'><!-- --></A><H3>$Encoding</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the Encoding of the message.</b>
<pre>
Options for this are "8bit",
"7bit", "binary", "base64", and "quoted-printable".
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$ErrorInfo'><!-- --></A><H3>$ErrorInfo</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Holds the most recent mailer error message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$From'><!-- --></A><H3>$From</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the From email address for the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$FromName'><!-- --></A><H3>$FromName</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the From name of the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Helo'><!-- --></A><H3>$Helo</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the SMTP HELO of the message (Default is $Hostname).</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Host'><!-- --></A><H3>$Host</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the SMTP hosts.</b>
<pre>
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. "smtp1.example.com:25;smtp2.example.com").
Hosts will be tried in order.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Hostname'><!-- --></A><H3>$Hostname</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the hostname to use in Message-Id and Received headers
and as default HELO string.</b>
<pre>
If empty, the value returned
by SERVER_NAME is used or 'localhost.localdomain'.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$LE'><!-- --></A><H3>$LE</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the line endings of the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Mailer'><!-- --></A><H3>$Mailer</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Method to send mail: ("mail", "sendmail", or "smtp").</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$message_type'><!-- --></A><H3>$message_type</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Holds the type of the message.</b>
<pre>
</pre>
<UL>
</UL>
<HR>
<A NAME='$Password'><!-- --></A><H3>$Password</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets SMTP password.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$PluginDir'><!-- --></A><H3>$PluginDir</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Path to phpmailer plugins. This is now only useful if the SMTP class
is in a different directory than the PHP include path.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Port'><!-- --></A><H3>$Port</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the default SMTP server port.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Priority'><!-- --></A><H3>$Priority</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Email priority (1 = High, 3 = Normal, 5 = low).</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$ReplyTo'><!-- --></A><H3>$ReplyTo</H3>
<b>Data type:</b> array<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Holds all "Reply-To" addresses.</b>
<pre>
</pre>
<UL>
</UL>
<HR>
<A NAME='$Sender'><!-- --></A><H3>$Sender</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the Sender email of the message.</b>
<pre>
If not empty, will be sent via -f to sendmail
or as 'MAIL FROM' in smtp mode.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Sendmail'><!-- --></A><H3>$Sendmail</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the path of the sendmail program.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$SMTPAuth'><!-- --></A><H3>$SMTPAuth</H3>
<b>Data type:</b> bool<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets SMTP authentication.</b>
<pre>
Utilizes the Username and Password variables.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$SMTPDebug'><!-- --></A><H3>$SMTPDebug</H3>
<b>Data type:</b> bool<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets SMTP class debugging on or off.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Subject'><!-- --></A><H3>$Subject</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the Subject of the message.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Timeout'><!-- --></A><H3>$Timeout</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the SMTP server timeout in seconds.</b>
<pre>
This function will not
work with the win32 version.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$UseMSMailHeaders'><!-- --></A><H3>$UseMSMailHeaders</H3>
<b>Data type:</b> bool<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Turns Microsoft mail client headers on and off.</b>
<pre>
Useful mostly
for older clients.
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Username'><!-- --></A><H3>$Username</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets SMTP username.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$Version'><!-- --></A><H3>$Version</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Holds phpmailer version.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<A NAME='$WordWrap'><!-- --></A><H3>$WordWrap</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets word wrapping on the body of the message to a given number of
characters.</b>
<pre>
</pre>
<UL>
<LI><b>Access</b> - <CODE>public</CODE></LI>
</UL>
<HR>
<hr>
<!-- ============ FUNCTION DETAIL =========== -->
<A NAME='function_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
<TD>
<FONT SIZE='+2'><B>Method Detail</B></FONT>
</TD>
</TR>
</TABLE>
<A NAME='AddAddress'><!-- --></A><H3>AddAddress</H3>
<P><B>void AddAddress ( $address, $name )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a "To" address.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddAttachment'><!-- --></A><H3>AddAttachment</H3>
<P><B>bool AddAttachment ( $path, $name, [$encoding = "base64"], [$type = "application/octet-stream"] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds an attachment from a path on the filesystem.</b>
<pre>
Checks if attachment is valid and then adds
the attachment to the list.
Returns false if the file could not be found
or accessed.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddBCC'><!-- --></A><H3>AddBCC</H3>
<P><B>void AddBCC ( $address, $name )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a "Bcc" address.</b>
<pre>
Note: this function works
with the SMTP mailer on win32, not with the "mail"
mailer. This is a PHP bug that has been submitted
on http://bugs.php.net. The *NIX version of PHP
functions correctly.
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddCC'><!-- --></A><H3>AddCC</H3>
<P><B>void AddCC ( $address, $name )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a "Cc" address.</b>
<pre>
Note: this function works
with the SMTP mailer on win32, not with the "mail"
mailer. This is a PHP bug that has been submitted
on http://bugs.php.net. The *NIX version of PHP
functions correctly. Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddCustomHeader'><!-- --></A><H3>AddCustomHeader</H3>
<P><B>void AddCustomHeader ( $custom_header )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a custom header.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddEmbeddedImage'><!-- --></A><H3>AddEmbeddedImage</H3>
<P><B>bool AddEmbeddedImage ( $path, $cid, $name, [$encoding = "base64"], [$type = "application/octet-stream"] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds an embedded attachment. This can include images, sounds, and
just about any other document.</b>
<pre>
</pre>
<DL>
<DT>Function Parameters:</DT>
<DD><CODE>- <i>cid $path</i>: this is the Content Id of the attachment. Use this to identify
the Id for accessing the image in an HTML form.</CODE></DD>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddReplyTo'><!-- --></A><H3>AddReplyTo</H3>
<P><B>void AddReplyTo ( $address, $name )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a "Reply-to" address.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='AddStringAttachment'><!-- --></A><H3>AddStringAttachment</H3>
<P><B>void AddStringAttachment ( $string, $filename, [$encoding = "base64"], [$type = "application/octet-stream"] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds a string or binary attachment (non-filesystem) to the list.</b>
<pre>
This method can be used to attach ascii or binary data,
such as a BLOB record from a database.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearAddresses'><!-- --></A><H3>ClearAddresses</H3>
<P><B>void ClearAddresses ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all recipients assigned in the TO array.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearAllRecipients'><!-- --></A><H3>ClearAllRecipients</H3>
<P><B>void ClearAllRecipients ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all recipients assigned in the TO, CC and BCC
array.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearAttachments'><!-- --></A><H3>ClearAttachments</H3>
<P><B>void ClearAttachments ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all previously set filesystem, string, and binary
attachments.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearBCCs'><!-- --></A><H3>ClearBCCs</H3>
<P><B>void ClearBCCs ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all recipients assigned in the BCC array.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearCCs'><!-- --></A><H3>ClearCCs</H3>
<P><B>void ClearCCs ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all recipients assigned in the CC array.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearCustomHeaders'><!-- --></A><H3>ClearCustomHeaders</H3>
<P><B>void ClearCustomHeaders ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all custom headers.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='ClearReplyTos'><!-- --></A><H3>ClearReplyTos</H3>
<P><B>void ClearReplyTos ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Clears all recipients assigned in the ReplyTo array.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='IsHTML'><!-- --></A><H3>IsHTML</H3>
<P><B>void IsHTML ( $bool )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets message type to HTML.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='IsMail'><!-- --></A><H3>IsMail</H3>
<P><B>void IsMail ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets Mailer to send message using PHP mail() function.
Returns void.</b>
<pre>
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='IsQmail'><!-- --></A><H3>IsQmail</H3>
<P><B>void IsQmail ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets Mailer to send message using the qmail MTA.</b>
<pre>
Returns void.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='IsSendmail'><!-- --></A><H3>IsSendmail</H3>
<P><B>void IsSendmail ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets Mailer to send message using the $Sendmail program.
Returns void.</b>
<pre>
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='IsSMTP'><!-- --></A><H3>IsSMTP</H3>
<P><B>void IsSMTP ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets Mailer to send message using SMTP.
Returns void.</b>
<pre>
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='Send'><!-- --></A><H3>Send</H3>
<P><B>bool Send ( )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Creates message and assigns Mailer.</b>
<pre>
If the message is
not sent successfully then it returns false. Use the ErrorInfo
variable to view description of the error. Returns bool.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<A NAME='SendToQueue'><!-- --></A><H3>SendToQueue</H3>
<P><B>string SendToQueue ( $queue_path, [$send_time = 0] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sends mail message to an assigned queue directory.</b>
<pre>
Has an optional
sendTime argument. This is used when the user wants the
message to be sent from the queue at a predetermined time.
The data must be a valid timestamp like that returned from
the time() or strtotime() functions. Returns false on failure
or the message file name if success.
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Access</b> - <CODE>public</CODE></DD>
</DL>
<HR>
<hr>
</HTML>