phpmailer.html

PHPMailer Full Featured Email Transfer Class for PHP

<HR>

<A NAME="$Helo"><!-- --></A><H3>
$Helo</H3>
<PRE>
public string <B>$Helo</B></PRE>
<DL>
<DD>Sets the SMTP HELO of the message.
  Default value is "localhost.localdomain".</DL>
<HR>

<A NAME="$SMTPAuth"><!-- --></A><H3>
$SMTPAuth</H3>
<PRE>
public bool <B>$SMTPAuth</B></PRE>
<DL>
<DD>Sets SMTP authentication. Utilizes the Username and Password variables.
  Default value is false (off).</DL>
<HR>

<A NAME="$Username"><!-- --></A><H3>
$Username</H3>
<PRE>
public string <B>$Username</B></PRE>
<DL>
<DD>Sets SMTP username. Default value is "".</DL>
<HR>

<A NAME="$Password"><!-- --></A><H3>
$Password</H3>
<PRE>
public string <B>$Password</B></PRE>
<DL>
<DD>Sets SMTP password. Default value is "".</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="phpmailer()"><!-- --></A><H3>
phpmailer</H3>
<PRE>
public <B>phpmailer</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="IsHTML(var)"><!-- --></A><H3>
IsHTML</H3>
<PRE>
public void <B>IsHTML</B>(var&nbsp;$bool)</PRE>
<DL>
<DD>Sets message type to HTML.  Returns void.</DL>
<HR>

<A NAME="IsSMTP()"><!-- --></A><H3>
IsSMTP</H3>
<PRE>
public void <B>IsSMTP</B>()</PRE>
<DL>
<DD>Sets Mailer to send message using SMTP.
 Returns void.</DL>
<HR>

<A NAME="IsMail()"><!-- --></A><H3>
IsMail</H3>
<PRE>
public void <B>IsMail</B>()</PRE>
<DL>
<DD>Sets Mailer to send message using PHP mail() function.
 Returns void.</DL>
<HR>

<A NAME="IsSendmail()"><!-- --></A><H3>
IsSendmail</H3>
<PRE>
public void <B>IsSendmail</B>()</PRE>
<DL>
<DD>Sets Mailer to send message using the $Sendmail program.
 Returns void.</DL>
<HR>

<A NAME="IsQmail()"><!-- --></A><H3>
IsQmail</H3>
<PRE>
public void <B>IsQmail</B>()</PRE>
<DL>
<DD>Sets Mailer to send message using the qmail MTA.  Returns void.</DL>
<HR>

<A NAME="AddAddress(var, var)"><!-- --></A><H3>
AddAddress</H3>
<PRE>
public void <B>AddAddress</B>(var&nbsp;$address,
                       var&nbsp;$name)</PRE>
<DL>
<DD>Adds a "To" address.  Returns void.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$name</CODE> - <b>Default Value</b>: ""</DL>
</DD>
</DL>
<HR>

<A NAME="AddCC(var, var)"><!-- --></A><H3>
AddCC</H3>
<PRE>
public void <B>AddCC</B>(var&nbsp;$address,
                  var&nbsp;$name)</PRE>
<DL>
<DD>Adds a "Cc" address. 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:     * functions correctly. Returns void.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$name</CODE> - <b>Default Value</b>: ""</DL>
</DD>
</DL>
<HR>

<A NAME="AddBCC(var, var)"><!-- --></A><H3>
AddBCC</H3>
<PRE>
public void <B>AddBCC</B>(var&nbsp;$address,
                   var&nbsp;$name)</PRE>
<DL>
<DD>Adds a "Bcc" address. 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:     * functions correctly.
 Returns void.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$name</CODE> - <b>Default Value</b>: ""</DL>
</DD>
</DL>
<HR>

<A NAME="AddReplyTo(var, var)"><!-- --></A><H3>
AddReplyTo</H3>
<PRE>
public void <B>AddReplyTo</B>(var&nbsp;$address,
                       var&nbsp;$name)</PRE>
<DL>
<DD>Adds a "Reply-to" address.  Returns void.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$name</CODE> - <b>Default Value</b>: ""</DL>
</DD>
</DL>
<HR>

<A NAME="Send()"><!-- --></A><H3>
Send</H3>
<PRE>
public bool <B>Send</B>()</PRE>
<DL>
<DD>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.  Returns bool.</DL>
<HR>

<A NAME="SendToQueue(var, var)"><!-- --></A><H3>
SendToQueue</H3>
<PRE>
public string <B>SendToQueue</B>(var&nbsp;$queue_path,
                          var&nbsp;$send_time)</PRE>
<DL>
<DD>Sends mail message to an assigned queue directory.  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.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$send_time</CODE> - <b>Default Value</b>: 0</DL>
</DD>
</DL>
<HR>

<A NAME="AddAttachment(var, var, var, var)"><!-- --></A><H3>
AddAttachment</H3>
<PRE>
public bool <B>AddAttachment</B>(var&nbsp;$path,
                          var&nbsp;$name,
                          var&nbsp;$encoding,
                          var&nbsp;$type)</PRE>
<DL>
<DD>Adds an attachment from a path on the filesystem.
 Checks if attachment is valid and then adds
 the attachment to the list.
 Returns false if the file could not be found
 or accessed.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$name</CODE> - <b>Default Value</b>: ""<DD><CODE>$encoding</CODE> - <b>Default Value</b>: "base64"<DD><CODE>$type</CODE> - <b>Default Value</b>: "application/octet-stream"</DL>
</DD>
</DL>
<HR>

<A NAME="AddStringAttachment(var, var, var, var)"><!-- --></A><H3>
AddStringAttachment</H3>
<PRE>
public void <B>AddStringAttachment</B>(var&nbsp;$string,
                                var&nbsp;$filename,
                                var&nbsp;$encoding,
                                var&nbsp;$type)</PRE>
<DL>
<DD>Adds a string or binary attachment (non-filesystem) to the list.
 This method can be used to attach ascii or binary data,
 such as a BLOB record from a database.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>$encoding</CODE> - <b>Default Value</b>: "base64"<DD><CODE>$type</CODE> - <b>Default Value</b>: "application/octet-stream"</DL>
</DD>
</DL>
<HR>

<A NAME="AddEmbeddedImage(var, var, var, var, var)"><!-- --></A><H3>
AddEmbeddedImage</H3>
<PRE>
public bool <B>AddEmbeddedImage</B>(var&nbsp;$path,
                             var&nbsp;$cid,
                             var&nbsp;$name,
                             var&nbsp;$encoding,
                             var&nbsp;$type)</PRE>
<DL>
<DD>Adds an embedded attachment.  This can include images, sounds, and 
 just about any other document.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cid</CODE> - this is the Content Id of the attachment.  Use this to identify
        the Id for accessing the image in an HTML form.<DD><CODE>$name</CODE> - <b>Default Value</b>: ""<DD><CODE>$encoding</CODE> - <b>Default Value</b>: "base64"<DD><CODE>$type</CODE> - <b>Default Value</b>: "application/octet-stream"</DL>
</DD>
</DL>
<HR>

<A NAME="ClearAddresses()"><!-- --></A><H3>
ClearAddresses</H3>
<PRE>
public void <B>ClearAddresses</B>()</PRE>
<DL>
<DD>Clears all recipients assigned in the TO array.  Returns void.</DL>
<HR>

<A NAME="ClearCCs()"><!-- --></A><H3>
ClearCCs</H3>
<PRE>
public void <B>ClearCCs</B>()</PRE>
<DL>
<DD>Clears all recipients assigned in the CC array.  Returns void.</DL>
<HR>

<A NAME="ClearBCCs()"><!-- --></A><H3>
ClearBCCs</H3>
<PRE>
public void <B>ClearBCCs</B>()</PRE>
<DL>
<DD>Clears all recipients assigned in the BCC array.  Returns void.</DL>
<HR>

<A NAME="ClearReplyTos()"><!-- --></A><H3>
ClearReplyTos</H3>
<PRE>
public void <B>ClearReplyTos</B>()</PRE>
<DL>
<DD>Clears all recipients assigned in the ReplyTo array.  Returns void.</DL>
<HR>

<A NAME="ClearAllRecipients()"><!-- --></A><H3>
ClearAllRecipients</H3>
<PRE>
public void <B>ClearAllRecipients</B>()</PRE>
<DL>
<DD>Clears all recipients assigned in the TO, CC and BCC
 array.  Returns void.</DL>
<HR>

<A NAME="ClearAttachments()"><!-- --></A><H3>
ClearAttachments</H3>
<PRE>
public void <B>ClearAttachments</B>()</PRE>
<DL>
<DD>Clears all previously set filesystem, string, and binary
 attachments.  Returns void.</DL>
<HR>

<A NAME="ClearCustomHeaders()"><!-- --></A><H3>
ClearCustomHeaders</H3>
<PRE>
public void <B>ClearCustomHeaders</B>()</PRE>
<DL>
<DD>Clears all custom headers.  Returns void.</DL>
<HR>

<A NAME="AddCustomHeader(var)"><!-- --></A><H3>
AddCustomHeader</H3>
<PRE>
public void <B>AddCustomHeader</B>(var&nbsp;$custom_header)</PRE>
<DL>
<DD>Adds a custom header.  Returns void.</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="Boundary.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="phpmailer.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>