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

<!-- Start of Class Data -->
<H2>
	Class Mime
</H2>
<pre>
<pre><a href="../core/Object.html">Object</a>
   |
   --Mime</pre>
</pre>
<H3>
	Classes extended from Mime:
</H3>
<a href="../net/Mail.html">Mail</a>
<p>
	<b><i>Located in File: Program_Root/mime.inc.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>MIME entity class.</b>
<pre>
MIME entity class is a wrapper to the MIME-defined header fields and contents
 of either a message or one of the parts in the body of a multipart entity.
 Any sort of field may be present in the header of an entity, but only those
 fields whose names begin with &quot;content-&quot; actually have any MIME-related
 meaning. Note - this class is not finished yet. There are still some things
 to implement according to MIME standards.
</pre>
<UL>
	
	<LI><b>Package</b> - <CODE>net</CODE></LI>
	
	<LI><b>Version</b> - <CODE>$Id: Mime.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='Mime.html#$_boundary'>$_boundary</A></B></CODE>
			<BR>
			<blockquote> The unique boundary of the MIME entity used with multipart entities. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_content'>$_content</A></B></CODE>
			<BR>
			<blockquote> The content of the MIME entity. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_description'>$_description</A></B></CODE>
			<BR>
			<blockquote> The content description (Content-Description) of the MIME entity. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_disposition'>$_disposition</A></B></CODE>
			<BR>
			<blockquote> The content disposition (Content-Disposition) of the MIME entity. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_encoding'>$_encoding</A></B></CODE>
			<BR>
			<blockquote> The encoding of the MIME entity. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_mimeparams'>$_mimeparams</A></B></CODE>
			<BR>
			<blockquote>  </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_mimeparts'>$_mimeparts</A></B></CODE>
			<BR>
			<blockquote>  </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_mtype'>$_mtype</A></B></CODE>
			<BR>
			<blockquote> The MIME type the MIME entity. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#$_stype'>$_stype</A></B></CODE>
			<BR>
			<blockquote> The MIME subtype the MIME entity. </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='Mime.html#constructor Mime'>void constructor Mime ( [$mtype = 'text'], [$stype = 'plain'] )</A></B></CODE>
			<BR>
			<blockquote> MIME class constructor. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#addMimePart'>mixed &addMimePart ( $part, [$mtype = 'text'], [$stype = 'plain'] )</A></B></CODE>
			<BR>
			<blockquote> Adds MIME entity subpart entity object. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#decode'>boolean decode ( $content )</A></B></CODE>
			<BR>
			<blockquote> Decodes MIME entity content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#mimeMessage'>string mimeMessage (  )</A></B></CODE>
			<BR>
			<blockquote> Retrieves MIME entity message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#encode'>boolean encode (  )</A></B></CODE>
			<BR>
			<blockquote> Encodes MIME entity content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getContent'>string getContent (  )</A></B></CODE>
			<BR>
			<blockquote> Gets content of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getDescription'>string getDescription (  )</A></B></CODE>
			<BR>
			<blockquote> Gets content description of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getDisposition'>string getDisposition (  )</A></B></CODE>
			<BR>
			<blockquote> Gets content disposition of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#mimeHeaders'>string mimeHeaders (  )</A></B></CODE>
			<BR>
			<blockquote> Retrieves MIME entity headers. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getEncoding'>string getEncoding (  )</A></B></CODE>
			<BR>
			<blockquote> Gets encoding of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getMimeParam'>boolean getMimeParam ( $param )</A></B></CODE>
			<BR>
			<blockquote> Gets param for MIME entity headers. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#getMimePart'>mixed &getMimePart ( $part )</A></B></CODE>
			<BR>
			<blockquote> Gets MIME entity subpart entity object. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#isMultipart'>boolean isMultipart (  )</A></B></CODE>
			<BR>
			<blockquote> Finds whether the MIME entity is multipart. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#setContent'>mixed setContent ( $content )</A></B></CODE>
			<BR>
			<blockquote> Sets content of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#setDescription'>boolean setDescription ( $description )</A></B></CODE>
			<BR>
			<blockquote> Sets content description of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#setDisposition'>boolean setDisposition ( $disposition )</A></B></CODE>
			<BR>
			<blockquote> Sets content disposition of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#setEncoding'>boolean setEncoding ( $encoding )</A></B></CODE>
			<BR>
			<blockquote> Sets encoding of the MIME entity. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mime.html#setMimeParam'>boolean setMimeParam ( $param, $value )</A></B></CODE>
			<BR>
			<blockquote> Sets param for MIME entity headers. </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='$_boundary'><!-- --></A><H3>$_boundary</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The unique boundary of the MIME entity used with multipart entities.</b>
<pre>

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

<HR>

<A NAME='$_content'><!-- --></A><H3>$_content</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The content of the MIME entity.</b>
<pre>

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

<HR>

<A NAME='$_description'><!-- --></A><H3>$_description</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The content description (Content-Description) of the MIME entity.</b>
<pre>

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

<HR>

<A NAME='$_disposition'><!-- --></A><H3>$_disposition</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The content disposition (Content-Disposition) of the MIME entity.</b>
<pre>

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

<HR>

<A NAME='$_encoding'><!-- --></A><H3>$_encoding</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The encoding of the MIME entity.</b>
<pre>

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

<HR>

<A NAME='$_mimeparams'><!-- --></A><H3>$_mimeparams</H3>
<b>Data type:</b> mixed<br>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>

</pre>
<UL>
	
</UL>

<HR>

<A NAME='$_mimeparts'><!-- --></A><H3>$_mimeparts</H3>
<b>Data type:</b> mixed<br>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>

</pre>
<UL>
	
</UL>

<HR>

<A NAME='$_mtype'><!-- --></A><H3>$_mtype</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The MIME type the MIME entity.</b>
<pre>

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

<HR>

<A NAME='$_stype'><!-- --></A><H3>$_stype</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The MIME subtype the MIME entity.</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 Mime'><!-- --></A><H3>constructor Mime</H3>
<P><B>void constructor Mime ( [$mtype = 'text'], [$stype = 'plain'] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>MIME class constructor.</b>
<pre>
Creates the new instance of MIME class and sets up basic properties.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $mtype</i>: the MIME type, defaults to "text".</CODE></DD>
	
	<DD><CODE>- <i>string $stype</i>: the MIME subtype, defaults to "plain".</CODE></DD>
	

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

<HR>

<A NAME='addMimePart'><!-- --></A><H3>addMimePart</H3>
<P><B>mixed &addMimePart ( $part, [$mtype = 'text'], [$stype = 'plain'] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Adds MIME entity subpart entity object.</b>
<pre>
Returns the referenct to added subpart object, error object otherwise.
 Added subpart object is stored internally and can be accessible by its
 name specified in part name using the MIME::getMimeParam(). Error
 object will be returned if master entity type is not set to multipart.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $part</i>: the subpart name.</CODE></DD>
	
	<DD><CODE>- <i>string $mtype</i>: the subpart MIME type, defaults to "text".</CODE></DD>
	
	<DD><CODE>- <i>string $stype</i>: the subpart MIME subtype, defaults to "plain".</CODE></DD>
	

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

<HR>

<A NAME='decode'><!-- --></A><H3>decode</H3>
<P><B>boolean decode ( $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Decodes MIME entity content.</b>
<pre>
Set content, decode it according to MIME entity encoding and returns
 true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $content</i>: the MIME entity content.</CODE></DD>
	

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

<HR>

<A NAME='mimeMessage'><!-- --></A><H3>mimeMessage</H3>
<P><B>string mimeMessage (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Retrieves MIME entity message.</b>
<pre>
Returns MIME entity content. If MIME entity is multipart type and has
 subpart objects their headers and message bodies are included.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='encode'><!-- --></A><H3>encode</H3>
<P><B>boolean encode (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Encodes MIME entity content.</b>
<pre>
Returns encoded MIME entity content according to MIME entity encoding.
 If MIME entity content is not encoded it is returned as it is.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getContent'><!-- --></A><H3>getContent</H3>
<P><B>string getContent (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets content of the MIME entity.</b>
<pre>
Returns content of the MIME entity, or empty string.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getDescription'><!-- --></A><H3>getDescription</H3>
<P><B>string getDescription (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets content description of the MIME entity.</b>
<pre>
Returns content description (Content-Description) of the MIME entity.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getDisposition'><!-- --></A><H3>getDisposition</H3>
<P><B>string getDisposition (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets content disposition of the MIME entity.</b>
<pre>
Returns content disposition (Content-Disposition) of the MIME entity.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='mimeHeaders'><!-- --></A><H3>mimeHeaders</H3>
<P><B>string mimeHeaders (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Retrieves MIME entity headers.</b>
<pre>
Returns MIME entity headers.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getEncoding'><!-- --></A><H3>getEncoding</H3>
<P><B>string getEncoding (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets encoding of the MIME entity.</b>
<pre>
Returns cencoding of the MIME entity. Encoding could be one of the
 following constants (or strings): <a href="../net/_mime_inc_php.html#MIME_ENCODING_7BIT">MIME_ENCODING_7BIT</a>,
 <a href="../net/_mime_inc_php.html#MIME_ENCODING_BASE64">MIME_ENCODING_BASE64</a>, <a href="../net/_mime_inc_php.html#MIME_ENCODING_QUOTEDPRINTABLE">MIME_ENCODING_QUOTEDPRINTABLE</a>
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getMimeParam'><!-- --></A><H3>getMimeParam</H3>
<P><B>boolean getMimeParam ( $param )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets param for MIME entity headers.</b>
<pre>
If the the param is registered returns its value or empty string otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $param</i>: the param name.</CODE></DD>
	

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

<HR>

<A NAME='getMimePart'><!-- --></A><H3>getMimePart</H3>
<P><B>mixed &getMimePart ( $part )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets MIME entity subpart entity object.</b>
<pre>
Returns the referenct to subpart object if it is registered, null otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $part</i>: the subpart name.</CODE></DD>
	

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

<HR>

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

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

<HR>

<A NAME='setContent'><!-- --></A><H3>setContent</H3>
<P><B>mixed setContent ( $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets content of the MIME entity.</b>
<pre>
If content Returns true on success, error object otherwise. If content
 param is path to readable file the file content is loaded.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $content</i>: the MIME entity content.</CODE></DD>
	

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

<HR>

<A NAME='setDescription'><!-- --></A><H3>setDescription</H3>
<P><B>boolean setDescription ( $description )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets content description of the MIME entity.</b>
<pre>
Returns true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $description</i>: the MIME entity content description.</CODE></DD>
	

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

<HR>

<A NAME='setDisposition'><!-- --></A><H3>setDisposition</H3>
<P><B>boolean setDisposition ( $disposition )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets content disposition of the MIME entity.</b>
<pre>
Returns true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $disposition</i>: the MIME entity content disposition.</CODE></DD>
	

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

<HR>

<A NAME='setEncoding'><!-- --></A><H3>setEncoding</H3>
<P><B>boolean setEncoding ( $encoding )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets encoding of the MIME entity.</b>
<pre>
Returns true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $encoding</i>: the MIME entity encoding.</CODE></DD>
	

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

<HR>

<A NAME='setMimeParam'><!-- --></A><H3>setMimeParam</H3>
<P><B>boolean setMimeParam ( $param, $value )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets param for MIME entity headers.</b>
<pre>
Returns true on success, error object otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $param</i>: the param value.</CODE></DD>
	

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

<HR>


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