Location: PHPKode > scripts > XS PHP Library > xs-php-library/doc/net/SMTP.html
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
<!--NewPage-->
<HTML>
<HEAD>
	<!-- Generated by PhpDoc date: 'Mon, 11 Nov 2002 23:47:26 +0100' -->
	<TITLE>Docs For Class SMTP</TITLE>
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
</HEAD>
<BODY BGCOLOR='white'>

<!-- Start of Class Data -->
<H2>
	Class SMTP
</H2>
<pre>
<pre><a href="../core/Object.html">Object</a>
   |
   --SMTP</pre>
</pre>
<H3>
	Classes extended from SMTP:
</H3>

<p>
	<b><i>Located in File: Program_Root/smtp.inc.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>SMTP access class.</b>
<pre>
SMTP class is a wrapper to the SMTP protocol, as specified by RFC 821.
 All mandatory SMTP commands are available, as are a few optional SMTP
 commands. It can be used to construct SMTP based web mail program, seding
 new mail from the web, or even to authenticate secured areas of the web site.
</pre>
<UL>
	
	<LI><b>Package</b> - <CODE>net</CODE></LI>
	
	<LI><b>Version</b> - <CODE>$Id: SMTP.html,v 1.3 2003/01/25 23:25:02 rbala Exp $</CODE></LI>
	
	<LI><b>Access</b> - <CODE>public</CODE></LI>
	
	<LI><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></LI>
	<LI><b>Author</b> - <CODE>Hans Zaunere &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</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='SMTP.html#$_banner'>$_banner</A></B></CODE>
			<BR>
			<blockquote> The banner returned by the SMTP server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#$_esmtp'>$_esmtp</A></B></CODE>
			<BR>
			<blockquote> Stores detected features of the SMTP server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#$_host'>$_host</A></B></CODE>
			<BR>
			<blockquote> IP address or host name. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#$_port'>$_port</A></B></CODE>
			<BR>
			<blockquote> TCP port number. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#$_socket'>$_socket</A></B></CODE>
			<BR>
			<blockquote> The socket resource being used to connect to the SMTP server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#$_status'>$_status</A></B></CODE>
			<BR>
			<blockquote> The last response status returned by the SMTP server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</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>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited From Class <a href="../core/Object.html">Object</a></B></FONT>
			<blockquote>
			<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
				<tr>
					<th>Function</th>
					<th>Description</th>
				</tr>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#constructor Object'>constructor Object (  )</A></B></CODE></td>
					<td>Object class constructor.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classMethods'>classMethods (  )</A></B></CODE></td>
					<td>Retrieves the class methods names of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#className'>className (  )</A></B></CODE></td>
					<td>Retrieves the name of the class of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classParent'>classParent (  )</A></B></CODE></td>
					<td>Retrieves the parent class name for the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#classProperties'>classProperties (  )</A></B></CODE></td>
					<td>Retrieves the class properties names of the object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../core/Object.html#inheritsFrom'>inheritsFrom ( [$class = ] )</A></B></CODE></td>
					<td>Check if the objects inherits from the specified class.</td>
				
			</table>
			</blockquote>
		</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='SMTP.html#constructor SMTP'>void constructor SMTP ( [$host = ''], [$port = ''25''] )</A></B></CODE>
			<BR>
			<blockquote> SMTP class constructor. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#auth'>mixed auth ( $user, $pass )</A></B></CODE>
			<BR>
			<blockquote> Attempt to do SMTP authentication. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#close'>mixed close (  )</A></B></CODE>
			<BR>
			<blockquote> Attempt to close connection from the SMTP server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#data'>mixed data ( $data )</A></B></CODE>
			<BR>
			<blockquote> Send the DATA command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#ehlo'>mixed ehlo ( $domain )</A></B></CODE>
			<BR>
			<blockquote> Send the EHLO command and obtain a list of available ESMTP extensions. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#expn'>void expn ( $string )</A></B></CODE>
			<BR>
			<blockquote>  </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#getBanner'>string getBanner (  )</A></B></CODE>
			<BR>
			<blockquote> Gets the banner returned by the SMTP server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#getHost'>string getHost (  )</A></B></CODE>
			<BR>
			<blockquote> Gets the IP address or host name. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#getPort'>int getPort (  )</A></B></CODE>
			<BR>
			<blockquote> Gets the TCP port number. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#getStatus'>string getStatus (  )</A></B></CODE>
			<BR>
			<blockquote> Gets the last response message returned by the POP3 server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#helo'>mixed helo ( $domain )</A></B></CODE>
			<BR>
			<blockquote> Send the HELO command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#isOpened'>boolean isOpened (  )</A></B></CODE>
			<BR>
			<blockquote> Finds whether the socket connection is opened. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#mail'>mixed mail ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Send the MAIL FROM command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#noop'>mixed noop (  )</A></B></CODE>
			<BR>
			<blockquote> Send the NOOP command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#open'>mixed open (  )</A></B></CODE>
			<BR>
			<blockquote> Attempt to open connection to the SMTP server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#rcpt'>mixed rcpt ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Send the RCPT TO command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#rset'>mixed rset (  )</A></B></CODE>
			<BR>
			<blockquote> Send the RSET command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#saml'>mixed saml ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Send the SAML FROM command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#send'>mixed send ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Send the SEND FROM command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#setHost'>mixed setHost ( $host )</A></B></CODE>
			<BR>
			<blockquote> Sets the IP address or host name. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#setPort'>mixed setPort ( $port )</A></B></CODE>
			<BR>
			<blockquote> Sets the TCP port number. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#soml'>mixed soml ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Send the SOML FROM command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='SMTP.html#vrfy'>mixed vrfy ( $string )</A></B></CODE>
			<BR>
			<blockquote> Send the VRFY command. </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='$_banner'><!-- --></A><H3>$_banner</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The banner returned by the SMTP server.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</CODE></LI>
	
</UL>

<HR>

<A NAME='$_esmtp'><!-- --></A><H3>$_esmtp</H3>
<b>Data type:</b> array<br>
<!-- ========== Info from phpDoc block ========= -->
<b>Stores detected features of the SMTP server.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</CODE></LI>
	
</UL>

<HR>

<A NAME='$_host'><!-- --></A><H3>$_host</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>IP address or host name.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</CODE></LI>
	
</UL>

<HR>

<A NAME='$_port'><!-- --></A><H3>$_port</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>TCP port number.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</CODE></LI>
	
</UL>

<HR>

<A NAME='$_socket'><!-- --></A><H3>$_socket</H3>
<b>Data type:</b> resource<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The socket resource being used to connect to the SMTP server.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</CODE></LI>
	
</UL>

<HR>

<A NAME='$_status'><!-- --></A><H3>$_status</H3>
<b>Data type:</b> int<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The last response status returned by the SMTP server.</b>
<pre>

</pre>
<UL>
	
	<LI><b>Access</b> - <CODE>private</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='constructor SMTP'><!-- --></A><H3>constructor SMTP</H3>
<P><B>void constructor SMTP ( [$host = ''], [$port = ''25''] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>SMTP class constructor.</b>
<pre>
Creates the new instance of SMTP class and sets up basic properties.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $host</i>: IP address or host name, defaults to "".</CODE></DD>
	
	<DD><CODE>- <i>int $port</i>: TCP port number, defaults to 25.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='auth'><!-- --></A><H3>auth</H3>
<P><B>mixed auth ( $user, $pass )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Attempt to do SMTP authentication.</b>
<pre>
Attempt to do user authentication if this feature is supported by SMTP
 server. If called when the connection is not established, it returns
 error object otherwise it returns true on success or a error object
 with an error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $user</i>: the username to login.</CODE></DD>
	
	<DD><CODE>- <i>string $pass</i>: the password to login.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='close'><!-- --></A><H3>close</H3>
<P><B>mixed close (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Attempt to close connection from the SMTP server.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='data'><!-- --></A><H3>data</H3>
<P><B>mixed data ( $data )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the DATA command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $data</i>: the message body to send.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='ehlo'><!-- --></A><H3>ehlo</H3>
<P><B>mixed ehlo ( $domain )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the EHLO command and obtain a list of available ESMTP extensions.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $domain</i>: the domain name to say we are.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='expn'><!-- --></A><H3>expn</H3>
<P><B>void expn ( $string )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>

</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
</DL>

<HR>

<A NAME='getBanner'><!-- --></A><H3>getBanner</H3>
<P><B>string getBanner (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets the banner returned by the SMTP server.</b>
<pre>
If called when the connection is already established, it returns the
 banner returned by the SMTP server otherwise it returns empty string.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='getHost'><!-- --></A><H3>getHost</H3>
<P><B>string getHost (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets the IP address or host name.</b>
<pre>
Returns IP address or host name.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='getPort'><!-- --></A><H3>getPort</H3>
<P><B>int getPort (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets the TCP port number.</b>
<pre>
Returns TCP port number.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='getStatus'><!-- --></A><H3>getStatus</H3>
<P><B>string getStatus (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets the last response message returned by the POP3 server.</b>
<pre>
If called when the connection is already established, it returns the
 last response smessage returned by the POP3 server otherwise it returns
 empty string.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='helo'><!-- --></A><H3>helo</H3>
<P><B>mixed helo ( $domain )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the HELO command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $domain</i>: the domain name to say we are.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='isOpened'><!-- --></A><H3>isOpened</H3>
<P><B>boolean isOpened (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Finds whether the socket connection is opened.</b>
<pre>
Returns true if the connection is established, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='mail'><!-- --></A><H3>mail</H3>
<P><B>mixed mail ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the MAIL FROM command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the sender (reverse path) to set.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='noop'><!-- --></A><H3>noop</H3>
<P><B>mixed noop (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the NOOP command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='open'><!-- --></A><H3>open</H3>
<P><B>mixed open (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Attempt to open connection to the SMTP server.</b>
<pre>
If called when the connection is already established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='rcpt'><!-- --></A><H3>rcpt</H3>
<P><B>mixed rcpt ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the RCPT TO command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: recipient (forward path) to add.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='rset'><!-- --></A><H3>rset</H3>
<P><B>mixed rset (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the RSET command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='saml'><!-- --></A><H3>saml</H3>
<P><B>mixed saml ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the SAML FROM command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the reverse path to send.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='send'><!-- --></A><H3>send</H3>
<P><B>mixed send ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the SEND FROM command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the sender (reverse path) to send.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='setHost'><!-- --></A><H3>setHost</H3>
<P><B>mixed setHost ( $host )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the IP address or host name.</b>
<pre>
Returns True on success or a error object if the connection is
 already established.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='setPort'><!-- --></A><H3>setPort</H3>
<P><B>mixed setPort ( $port )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets the TCP port number.</b>
<pre>
Returns True on success or a error object if the connection is
 already established.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='soml'><!-- --></A><H3>soml</H3>
<P><B>mixed soml ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the SOML FROM command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the reverse path to send.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>

<A NAME='vrfy'><!-- --></A><H3>vrfy</H3>
<P><B>mixed vrfy ( $string )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the VRFY command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns true on success or a error object with an
 error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $string</i>: the string to verify.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</DL>

<HR>


<hr>
</HTML>
Return current item: XS PHP Library