Location: PHPKode > scripts > XS PHP Library > xs-php-library/doc/net/_mail_inc_php.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:46:42 +0100' -->
	<TITLE>Docs for page mail.inc.php</TITLE>
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
</HEAD>
<BODY BGCOLOR='white'>

<h2>Page: Program_Root/mail.inc.php</h2>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>

</pre>
<UL>
	
	<LI><b>Package</b> - <CODE>net</CODE></LI>
	
</UL>

<br>
Classes defined on this page: <a href="../net/Mail.html">Mail</a><br>
<!-- =========== CONSTANT SUMMARY =========== -->
<A NAME='constant_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Include Statements Summary</B></FONT>
		</TD>
	</TR>
</TABLE>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<THEAD>
		<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR>
	</THEAD>
	<TBODY>
		
	</TBODY>
</TABLE>
<br>

<br>
<!-- =========== CONSTANT SUMMARY =========== -->
<A NAME='global_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Global Variable Summary</B></FONT>
		</TD>
	</TR>
</TABLE>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<THEAD>
		<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR>
	</THEAD>
	<TBODY>
		
	</TBODY>
</TABLE>
<br>


<br>
<!-- =========== CONSTANT SUMMARY =========== -->
<A NAME='constant_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Constant Summary</B></FONT>
		</TD>
	</TR>
</TABLE>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<THEAD>
		<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR>
	</THEAD>
	<TBODY>
		
	</TBODY>
</TABLE>
<br>

<br>
<!-- =========== Function SUMMARY =========== -->
<A NAME='Function_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Function Summary</B></FONT>
		</TD>
	</TR>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mail_inc_php.html#mail_extractAddr'>string mail_extractAddr ( $string )</A></B></CODE>
			<BR>
			<blockquote> Extracts email address. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mail_inc_php.html#mail_fetchMime'>string mail_fetchMime ( $boundary, $content )</A></B></CODE>
			<BR>
			<blockquote> Splits MIME subparts content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mail_inc_php.html#mail_parseMime'>boolean mail_parseMime ( &$mpart, $content )</A></B></CODE>
			<BR>
			<blockquote> Parses message received from POP3 server. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mail_inc_php.html#mail_splitMime'>array mail_splitMime ( $boundary, $content )</A></B></CODE>
			<BR>
			<blockquote> Splits MIME subparts content. </blockquote>
		</TD>
	</TR>
	
</TABLE>

<br>
<!-- ============ CONSTANT DETAIL =========== -->

<A NAME='constant_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Include Statements Detail</B></FONT>
		</TD>
	</TR>
</TABLE>



<br>
<!-- ============ CONSTANT DETAIL =========== -->

<A NAME='global_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Global Variable Detail</B></FONT>
		</TD>
	</TR>
</TABLE>



<br>
<!-- ============ CONSTANT DETAIL =========== -->

<A NAME='constant_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
	<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
		<TD>
			<FONT SIZE='+2'><B>Constant Detail</B></FONT>
		</TD>
	</TR>
</TABLE>



<br>
<!-- ============ 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>Function Detail</B></FONT>
		</TD>
	</TR>
</TABLE>


<A NAME='mail_extractAddr'><!-- --></A><H3>mail_extractAddr</H3>
<P><B>string mail_extractAddr ( $string )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Extracts email address.</b>
<pre>
Returns valid email address from the string on success, empty string
 otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $string</i>: the string from which email is extracted.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
	<DD><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></DD>
	
</DL>

<HR>

<A NAME='mail_fetchMime'><!-- --></A><H3>mail_fetchMime</H3>
<P><B>string mail_fetchMime ( $boundary, $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Splits MIME subparts content.</b>
<pre>
This is helper function used to separat nested mulipart MIME subparts entities.
 Used internally by <a href="../net/_mail_inc_php.html#mail_splitMime">mail_splitMime()</a> function.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>object $boundary</i>: the MIME subparts boundary.</CODE></DD>
	
	<DD><CODE>- <i>string $content</i>: the message content to split.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>private</CODE></DD>
	
	<DD><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></DD>
	
</DL>

<HR>

<A NAME='mail_parseMime'><!-- --></A><H3>mail_parseMime</H3>
<P><B>boolean mail_parseMime ( &$mpart, $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Parses message received from POP3 server.</b>
<pre>
Parses passed message contents and sets extracted properties to <a href="../net/Mail.html">Mail</a>
 object. Returns true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>object $mpart</i>: the reference to <a href="../net/Mail.html">Mail</a> object.</CODE></DD>
	
	<DD><CODE>- <i>string $content</i>: the message content to parse.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>public</CODE></DD>
	
	<DD><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></DD>
	
</DL>

<HR>

<A NAME='mail_splitMime'><!-- --></A><H3>mail_splitMime</H3>
<P><B>array mail_splitMime ( $boundary, $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Splits MIME subparts content.</b>
<pre>
This is helper function used to separat nested mulipart MIME subparts entities.
 Used internally by <a href="../net/_mail_inc_php.html#mail_parseMime">mail_parseMime()</a> function.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>object $boundary</i>: the MIME subparts boundary.</CODE></DD>
	
	<DD><CODE>- <i>string $content</i>: the message content to split.</CODE></DD>
	

	<DT>Function Info:</DT>
	
	<DD><b>Access</b> - <CODE>private</CODE></DD>
	
	<DD><b>Author</b> - <CODE>Robert Bala &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</CODE></DD>
	
</DL>

<HR>


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