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

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

<p>
	<b><i>Located in File: Program_Root/mail.inc.php</i></b><br>
</p>
<hr>
<!-- ========== Info from phpDoc block ========= -->
<b>MIME Mail entity class.</b>
<pre>
MIME Mail class is a wrapper to the Internet mail message. It enables to
 parse received messages from POP3 server, writes new simple or multipart
 messages ready to send throught SMTP connection.
</pre>
<UL>
	
	<LI><b>Package</b> - <CODE>net</CODE></LI>
	
	<LI><b>Version</b> - <CODE>$Id: Mail.html,v 1.2 2002/11/28 09:45:11 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='Mail.html#$_bcc'>$_bcc</A></B></CODE>
			<BR>
			<blockquote> The Mail message blind carbon copy recipients. </blockquote>
			<blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#$_headers'>$_headers</A></B></CODE>
			<BR>
			<blockquote> The Mail message headers. </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>

	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<FONT SIZE='+2'><B>Inherited From Class <a href="../net/Mime.html">Mime</a></B></FONT>
			<blockquote>
			<table BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
			<tr>
				<th>Variable</th>
				<th>Default Value</th>
				<th>Description</th>
			</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_boundary'>$_boundary</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The unique boundary of the MIME entity used with multipart entities.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_content'>$_content</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The content of the MIME entity.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_description'>$_description</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The content description (Content-Description) of the MIME entity.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_disposition'>$_disposition</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The content disposition (Content-Disposition) of the MIME entity.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_encoding'>$_encoding</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The encoding of the MIME entity.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_mimeparams'>$_mimeparams</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td></td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_mimeparts'>$_mimeparts</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td></td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_mtype'>$_mtype</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The MIME type the MIME entity.</td>
				</tr>
				
				<tr>
				<td><CODE><B><A HREF='../net/Mime.html#$_stype'>$_stype</A></B></CODE></td>
				<td><CODE>-><-</CODE></td>
				<td>The MIME subtype the MIME entity.</td>
				</tr>
				
			</table>
			</blockquote>
		</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="../net/Mime.html">Mime</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='../net/Mime.html#constructor Mime'>constructor Mime ( [$mtype = 'text'], [$stype = 'plain'] )</A></B></CODE></td>
					<td>MIME class constructor.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#addMimePart'>addMimePart ( $part, [$mtype = 'text'], [$stype = 'plain'] )</A></B></CODE></td>
					<td>Adds MIME entity subpart entity object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#decode'>decode ( $content )</A></B></CODE></td>
					<td>Decodes MIME entity content.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#encode'>encode (  )</A></B></CODE></td>
					<td>Encodes MIME entity content.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getContent'>getContent (  )</A></B></CODE></td>
					<td>Gets content of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getDescription'>getDescription (  )</A></B></CODE></td>
					<td>Gets content description of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getDisposition'>getDisposition (  )</A></B></CODE></td>
					<td>Gets content disposition of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getEncoding'>getEncoding (  )</A></B></CODE></td>
					<td>Gets encoding of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getMimeParam'>getMimeParam ( $param )</A></B></CODE></td>
					<td>Gets param for MIME entity headers.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#getMimePart'>getMimePart ( $part )</A></B></CODE></td>
					<td>Gets MIME entity subpart entity object.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#isMultipart'>isMultipart (  )</A></B></CODE></td>
					<td>Finds whether the MIME entity is multipart.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#mimeHeaders'>mimeHeaders (  )</A></B></CODE></td>
					<td>Retrieves MIME entity headers.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#mimeMessage'>mimeMessage (  )</A></B></CODE></td>
					<td>Retrieves MIME entity message.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#setContent'>setContent ( $content )</A></B></CODE></td>
					<td>Sets content of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#setDescription'>setDescription ( $description )</A></B></CODE></td>
					<td>Sets content description of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#setDisposition'>setDisposition ( $disposition )</A></B></CODE></td>
					<td>Sets content disposition of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#setEncoding'>setEncoding ( $encoding )</A></B></CODE></td>
					<td>Sets encoding of the MIME entity.</td>
				
				<tr>
					<td><CODE><B><A HREF='../net/Mime.html#setMimeParam'>setMimeParam ( $param, $value )</A></B></CODE></td>
					<td>Sets param for MIME entity headers.</td>
				
			</table>
			</blockquote>
		</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='Mail.html#constructor Mail'>void constructor Mail ( [$mtype = 'text'], [$stype = 'plain'] )</A></B></CODE>
			<BR>
			<blockquote> Mail class constructor. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#parseMessage'>boolean parseMessage ( $message )</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.html#readRcpts'>string readRcpts (  )</A></B></CODE>
			<BR>
			<blockquote> Retrieves recipient list of Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setBcc'>mixed setBcc ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Sets blind carbon copy recipients of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setCc'>mixed setCc ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Sets CC header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setFrom'>mixed setFrom ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Sets FROM header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setHeader'>mixed setHeader ( $header, $value )</A></B></CODE>
			<BR>
			<blockquote> Sets specified header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setSubject'>mixed setSubject ( $subject )</A></B></CODE>
			<BR>
			<blockquote> Sets SUBJECT header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#setTo'>mixed setTo ( $addr )</A></B></CODE>
			<BR>
			<blockquote> Sets TO header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#mailMessage'>string mailMessage (  )</A></B></CODE>
			<BR>
			<blockquote> Retrieves Mail message content. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getBcc'>string getBcc (  )</A></B></CODE>
			<BR>
			<blockquote> Gets blind carbon copy recipients of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getCc'>string getCc (  )</A></B></CODE>
			<BR>
			<blockquote> Gets CC header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getFrom'>string getFrom (  )</A></B></CODE>
			<BR>
			<blockquote> Gets FROM header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getHeader'>string getHeader ( $header )</A></B></CODE>
			<BR>
			<blockquote> Gets specified header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getSubject'>string getSubject (  )</A></B></CODE>
			<BR>
			<blockquote> Gets SUBJECT header of the Mail message. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#mailHeaders'>string mailHeaders (  )</A></B></CODE>
			<BR>
			<blockquote> Retrieves Mail message headers. </blockquote>
		</TD>
	</TR>
	
	<!-- =========== Summary =========== -->
	<TR BGCOLOR='white' CLASS='TableRowColor'>
		<TD>
			<CODE><B><A HREF='Mail.html#getTo'>string getTo (  )</A></B></CODE>
			<BR>
			<blockquote> Gets TO header of the Mail message. </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='$_bcc'><!-- --></A><H3>$_bcc</H3>
<b>Data type:</b> string<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The Mail message blind carbon copy recipients.</b>
<pre>

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

<HR>

<A NAME='$_headers'><!-- --></A><H3>$_headers</H3>
<b>Data type:</b> array<br>
<!-- ========== Info from phpDoc block ========= -->
<b>The Mail message headers.</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 Mail'><!-- --></A><H3>constructor Mail</H3>
<P><B>void constructor Mail ( [$mtype = 'text'], [$stype = 'plain'] )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Mail class constructor.</b>
<pre>
Creates the new instance of Mail 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='parseMessage'><!-- --></A><H3>parseMessage</H3>
<P><B>boolean parseMessage ( $message )</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.
 Returns true on success, false otherwise.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $message</i>: the message content to parse.</CODE></DD>
	

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

<HR>

<A NAME='readRcpts'><!-- --></A><H3>readRcpts</H3>
<P><B>string readRcpts (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Retrieves recipient list of Mail message.</b>
<pre>
Returns recipient list extracted from TO, CC headers and blind carbon
 copy. Returned email addresses are separated by commas.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='setBcc'><!-- --></A><H3>setBcc</H3>
<P><B>mixed setBcc ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets blind carbon copy recipients of the Mail message.</b>
<pre>
Returns true on success or a error object with an error message on any
 kind of failure. The $addr param can be a list of recipients separated by
 commas. Error object will be returned if specified email address is in
 invalid format.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the message recipients.</CODE></DD>
	

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

<HR>

<A NAME='setCc'><!-- --></A><H3>setCc</H3>
<P><B>mixed setCc ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets CC header of the Mail message.</b>
<pre>
Returns true on success or a error object with an error message on any
 kind of failure. The $addr param can be a list of recipients separated by
 commas. Error object will be returned if specified email address is in
 invalid format.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the message recipients.</CODE></DD>
	

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

<HR>

<A NAME='setFrom'><!-- --></A><H3>setFrom</H3>
<P><B>mixed setFrom ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets FROM header of the Mail message.</b>
<pre>
Returns true on success or a error object with an error message on any
 kind of failure. Error object will be returned if specified email address
 is in invalid format.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the message recipients.</CODE></DD>
	

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

<HR>

<A NAME='setHeader'><!-- --></A><H3>setHeader</H3>
<P><B>mixed setHeader ( $header, $value )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets specified header of the Mail message.</b>
<pre>
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 $header</i>: the header value.</CODE></DD>
	

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

<HR>

<A NAME='setSubject'><!-- --></A><H3>setSubject</H3>
<P><B>mixed setSubject ( $subject )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets SUBJECT header of the Mail message.</b>
<pre>
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 $subject</i>: the message subject.</CODE></DD>
	

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

<HR>

<A NAME='setTo'><!-- --></A><H3>setTo</H3>
<P><B>mixed setTo ( $addr )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Sets TO header of the Mail message.</b>
<pre>
Returns true on success or a error object with an error message on any
 kind of failure. The $addr param can be a list of recipients separated by
 commas. Error object will be returned if specified email address is in
 invalid format.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	
	<DD><CODE>- <i>string $addr</i>: the message recipients.</CODE></DD>
	

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

<HR>

<A NAME='mailMessage'><!-- --></A><H3>mailMessage</H3>
<P><B>string mailMessage (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Retrieves Mail message content.</b>
<pre>
Returns Mail message content. If the Mail message is MIME entity
 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='getBcc'><!-- --></A><H3>getBcc</H3>
<P><B>string getBcc (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets blind carbon copy recipients of the Mail message.</b>
<pre>
Returns blind carbon copy recipients of the Mail message or empty
 string if it is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getCc'><!-- --></A><H3>getCc</H3>
<P><B>string getCc (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets CC header of the Mail message.</b>
<pre>
Returns CC header of the Mail message or empty string if it is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getFrom'><!-- --></A><H3>getFrom</H3>
<P><B>string getFrom (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets FROM header of the Mail message.</b>
<pre>
Returns FROM header of the Mail message or empty string if it is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getHeader'><!-- --></A><H3>getHeader</H3>
<P><B>string getHeader ( $header )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets specified header of the Mail message.</b>
<pre>
Returns specified header value of the Mail message or empty string if it
 is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

<A NAME='getSubject'><!-- --></A><H3>getSubject</H3>
<P><B>string getSubject (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets SUBJECT header of the Mail message.</b>
<pre>
Returns SUBJECT header of the Mail message or empty string if it is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>

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

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

<HR>

<A NAME='getTo'><!-- --></A><H3>getTo</H3>
<P><B>string getTo (  )</B></P>
<P></P>
<!-- ========== Info from phpDoc block ========= -->
<b>Gets TO header of the Mail message.</b>
<pre>
Returns TO header of the Mail message or empty string if it is not set.
</pre>
<DL>
	<DT>Function Parameters:</DT>
	

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

<HR>


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