Location: PHPKode > scripts > XS PHP Library > xs-php-library/doc/net/POP3.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:10 +0100' -->
	<TITLE>Docs For Class POP3</TITLE>
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
</HEAD>
<BODY BGCOLOR='white'>

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

<p>
	<b><i>Located in File: Program_Root/pop3.inc.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>POP3 access class.</b>
<pre>
POP3 class is a wrapper to the POP3 protocol, as specified by RFC 1939.
 All mandatory POP3 commands are available, as are a few optional POP3
 commands. It can be used to construct POP3 based web mail program, check for
 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: POP3.html,v 1.2 2002/11/28 09:45:12 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>
	
</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='POP3.html#$_banner'>$_banner</A></B></CODE>
			<BR>
			<blockquote> The banner returned by the POP3 server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.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='POP3.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='POP3.html#$_socket'>$_socket</A></B></CODE>
			<BR>
			<blockquote> The socket resource being used to connect to the POP3 server. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#$_status'>$_status</A></B></CODE>
			<BR>
			<blockquote> The last response status returned by the POP3 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='POP3.html#constructor POP3'>void constructor POP3 ( [$host = ''], [$port = ''110''] )</A></B></CODE>
			<BR>
			<blockquote> POP3 class constructor. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#auth'>mixed auth ( $user, $pass )</A></B></CODE>
			<BR>
			<blockquote> Attempt to do user authentication. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#close'>mixed close (  )</A></B></CODE>
			<BR>
			<blockquote> Attempt to close connection from the POP3 server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#dele'>mixed dele ( $index )</A></B></CODE>
			<BR>
			<blockquote> Send the DELE command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#getBanner'>string getBanner (  )</A></B></CODE>
			<BR>
			<blockquote> Gets the banner returned by the POP3 server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.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='POP3.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='POP3.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='POP3.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='POP3.html#lst'>mixed lst ( [$index = null] )</A></B></CODE>
			<BR>
			<blockquote> Send the LIST command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.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='POP3.html#open'>mixed open (  )</A></B></CODE>
			<BR>
			<blockquote> Attempt to open connection to the POP3 server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#pass'>mixed pass ( $pass )</A></B></CODE>
			<BR>
			<blockquote> Send the PASS command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#retr'>mixed retr ( $index )</A></B></CODE>
			<BR>
			<blockquote> Send the RETR command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.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='POP3.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='POP3.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='POP3.html#stat'>mixed stat (  )</A></B></CODE>
			<BR>
			<blockquote> Send the STAT command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#top'>mixed top ( $index, $lines )</A></B></CODE>
			<BR>
			<blockquote> Send the TOP command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#uidl'>mixed uidl ( [$index = null] )</A></B></CODE>
			<BR>
			<blockquote> Send the UIDL command. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='POP3.html#user'>mixed user ( $user )</A></B></CODE>
			<BR>
			<blockquote> Send the USER 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 POP3 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 POP3 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 POP3 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 POP3'><!-- --></A><H3>constructor POP3</H3>
<P><B>void constructor POP3 ( [$host = ''], [$port = ''110''] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>POP3 class constructor.</b>
<pre>
Creates the new instance of POP3 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 110.</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 user authentication.</b>
<pre>
Attempt to do user authentication at single command. 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 POP3 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='dele'><!-- --></A><H3>dele</H3>
<P><B>mixed dele ( $index )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the DELE 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>int $index</i>: the message index to delete.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
</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 POP3 server.</b>
<pre>
If called when the connection is already established, it returns the
 banner 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='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='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='lst'><!-- --></A><H3>lst</H3>
<P><B>mixed lst ( [$index = null] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the LIST command.</b>
<pre>
If called when the connection is not established, it returns error
 object. If the index param was given the returned value is exact size of
 the message in octets otherwise it returns array of arrays which consists
 of index and exact size of the message in octets as the value. In any
 kind of failure it returns error object with an error message.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>int $index</i>: the message index (optional), defaults to null.</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 POP3 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='pass'><!-- --></A><H3>pass</H3>
<P><B>mixed pass ( $pass )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the PASS 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 $pass</i>: the password to login.</CODE></DD>
	

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

<HR>

<A NAME='retr'><!-- --></A><H3>retr</H3>
<P><B>mixed retr ( $index )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the RETR command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns mail message on success or a error object
 with an error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>int $index</i>: the message index to retrieve.</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='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='stat'><!-- --></A><H3>stat</H3>
<P><B>mixed stat (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the STAT command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns array of number of messages and maildrop
 size 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='top'><!-- --></A><H3>top</H3>
<P><B>mixed top ( $index, $lines )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the TOP command.</b>
<pre>
If called when the connection is not established, it returns error
 object otherwise it returns headers of the message, the blank
 line separating the headers from the body, and then the number of lines
 of the indicated message's body on success or a error object with
  an error message on any kind of failure.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>int $index</i>: the non-negative number of lines.</CODE></DD>
	

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

<HR>

<A NAME='uidl'><!-- --></A><H3>uidl</H3>
<P><B>mixed uidl ( [$index = null] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the UIDL command.</b>
<pre>
If called when the connection is not established, it returns error
 object. If the index param was given the returned value is unique-id of
 the message otherwise it returns array indexed by message index and
 unique-id of the message as the value. In any kind of failure it
 returns error object with an error message.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>int $index</i>: the message index (optional), defaults to null.</CODE></DD>
	

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

<HR>

<A NAME='user'><!-- --></A><H3>user</H3>
<P><B>mixed user ( $user )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Send the USER 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 $user</i>: the username to login.</CODE></DD>
	

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

<HR>


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