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

<h2>Page: Program_Root/mime.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/Mime.html">Mime</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>
		
		<TR BGCOLOR='white' CLASS='TableRowColor'>
			<TD><A HREF='_mime_inc_php.html#MIME_ENCODING_7BIT'>MIME_ENCODING_7BIT</A></TD>
			<TD>7bit</TD>
			<TD>7 bit MIME encoding.</TD>
		</TR>
		
		<TR BGCOLOR='white' CLASS='TableRowColor'>
			<TD><A HREF='_mime_inc_php.html#MIME_ENCODING_BASE64'>MIME_ENCODING_BASE64</A></TD>
			<TD>base64</TD>
			<TD>Base64 MIME encoding.</TD>
		</TR>
		
		<TR BGCOLOR='white' CLASS='TableRowColor'>
			<TD><A HREF='_mime_inc_php.html#MIME_ENCODING_QUOTEDPRINTABLE'>MIME_ENCODING_QUOTEDPRINTABLE</A></TD>
			<TD>quoted-printable</TD>
			<TD>Quoted-Printable MIME encoding.</TD>
		</TR>
		
	</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='_mime_inc_php.html#mime_boundary'>string mime_boundary (  )</A></B></CODE>
			<BR>
			<blockquote> Generates unique MIME boundary. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mime_inc_php.html#mime_decode'>boolean mime_decode ( $encoding, $content )</A></B></CODE>
			<BR>
			<blockquote> Decode MIME entity content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mime_inc_php.html#mime_encode'>boolean mime_encode ( $encoding, $content )</A></B></CODE>
			<BR>
			<blockquote> Encode MIME entity content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='_mime_inc_php.html#mime_validateEncoding'>boolean mime_validateEncoding ( $string )</A></B></CODE>
			<BR>
			<blockquote> Check if specified encoding is supported. </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>


<A NAME='MIME_ENCODING_7BIT'><!-- --></A><H3>MIME_ENCODING_7BIT</H3>
<P><B>MIME_ENCODING_7BIT = ->7bit<-</B></P>

<!-- ========== Info from phpDoc block ========= -->
<b>7 bit MIME encoding.</b>
<pre>
7bit data refers to data that is all represented as relatively short lines
 with 998 octets or less between CRLF line separation sequences [RFC-821].
 No octets with decimal values greater than 127 are allowed and neither are
 NULs (octets with decimal value 0). CRLF octets only occur as part of CRLF
 line separation sequences.
</pre>
<UL>
	
</UL>

<HR>

<A NAME='MIME_ENCODING_BASE64'><!-- --></A><H3>MIME_ENCODING_BASE64</H3>
<P><B>MIME_ENCODING_BASE64 = ->base64<-</B></P>

<!-- ========== Info from phpDoc block ========= -->
<b>Base64 MIME encoding.</b>
<pre>
The Base64 content-transfer-encoding is designed to represent arbitrary
 sequences of octets in a form that need not be humanly readable.
 The encoding and decoding algorithms are simple, but the encoded data are
 consistently only about 33 percent larger than the  unencoded data.
</pre>
<UL>
	
</UL>

<HR>

<A NAME='MIME_ENCODING_QUOTEDPRINTABLE'><!-- --></A><H3>MIME_ENCODING_QUOTEDPRINTABLE</H3>
<P><B>MIME_ENCODING_QUOTEDPRINTABLE = ->quoted-printable<-</B></P>

<!-- ========== Info from phpDoc block ========= -->
<b>Quoted-Printable MIME encoding.</b>
<pre>
&quot;Quoted-Printable&quot; refers to content-transfer-encoding defined in RFC 2045.
 It is designed to allow text containing mostly ASCII characters to be
 decipherable on an ASCII terminal without decoding.
</pre>
<UL>
	
</UL>

<HR>


<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='mime_boundary'><!-- --></A><H3>mime_boundary</H3>
<P><B>string mime_boundary (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Generates unique MIME boundary.</b>
<pre>
Returns generated unique MIME boundary
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

	<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='mime_decode'><!-- --></A><H3>mime_decode</H3>
<P><B>boolean mime_decode ( $encoding, $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Decode MIME entity content.</b>
<pre>
Returns decoded content of the MIME entity if the specified encoding is 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>, empty
 string otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $encoding</i>: the MIME entity encoding.</CODE></DD>
	
	<DD><CODE>- <i>string $content</i>: the MIME entity content.</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='mime_encode'><!-- --></A><H3>mime_encode</H3>
<P><B>boolean mime_encode ( $encoding, $content )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Encode MIME entity content.</b>
<pre>
Returns encoded content of the MIME entity if the specified encoding is 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>,
 unchanged content otherwise. Note - Quote-printable encoding is not supported.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $encoding</i>: the MIME entity encoding.</CODE></DD>
	
	<DD><CODE>- <i>string $content</i>: the MIME entity content.</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='mime_validateEncoding'><!-- --></A><H3>mime_validateEncoding</H3>
<P><B>boolean mime_validateEncoding ( $string )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Check if specified encoding is supported.</b>
<pre>
Returns true is specified encoding is supported, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $string</i>: the MIME entity encoding.</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