<html> <head> <title>Interface XSimpleMailMessage</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSimpleMailMessage-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">system</a> :: </p> </td> </tr> <tr> <td class="title">interface XSimpleMailMessage</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface lets a client set or get the information of a simple mail message. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#setRecipient">setRecipient</a></td> <td class="imsum_right">To set the recipient of the simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getRecipient">getRecipient</a></td> <td class="imsum_right">To get the recipient of the simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#setCcRecipient">setCcRecipient</a></td> <td class="imsum_right">To set the cc recipients of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getCcRecipient">getCcRecipient</a></td> <td class="imsum_right">To get the cc recipients of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#setBccRecipient">setBccRecipient</a></td> <td class="imsum_right">To set the bcc recipient of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getBccRecipient">getBccRecipient</a></td> <td class="imsum_right">To get the bcc recipients of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#setOriginator">setOriginator</a></td> <td class="imsum_right">To set the email address of the originator of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getOriginator">getOriginator</a></td> <td class="imsum_right">To get the email address of the originator of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#setSubject">setSubject</a></td> <td class="imsum_right">To set the subject of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getSubject">getSubject</a></td> <td class="imsum_right">To get the subject of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#setAttachement">setAttachement</a></td> <td class="imsum_right">To set an attachment of a simple mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getAttachement">getAttachement</a></td> <td class="imsum_right">To get the attachment of a simple mail message. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="setRecipient" class="membertitle">setRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setRecipient</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aRecipient );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set the recipient of the simple mail message. </dd> <dt><b>Parameter aRecipient</b></dt> <dd>The email address of a recipient. The method doesn't check if the given email address is valid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRecipient" class="membertitle">getRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getRecipient</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the recipient of the simple mail message. </dd> <dt><b>Returns</b></dt> <dd>The specified email address of a recipient if any has been specified or an empty string. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setCcRecipient" class="membertitle">setCcRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setCcRecipient</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aCcRecipient );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set the cc recipients of a simple mail message. </dd> <dt><b>Parameter aCcRecipient</b></dt> <dd>Sets a sequence with the email addresses of one or more cc recipients. <p>The method does not check if the given addresses are valid. An empty sequence means there are no cc recipients.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCcRecipient" class="membertitle">getCcRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getCcRecipient</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the cc recipients of a simple mail message. </dd> <dt><b>Returns</b></dt> <dd>A sequence with the email addresses of one or more cc recipients. <p>If no cc recipients have been specified an empty sequence will be returned.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setBccRecipient" class="membertitle">setBccRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setBccRecipient</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aBccRecipient );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set the bcc recipient of a simple mail message. </dd> <dt><b>Parameter aBccRecipient</b></dt> <dd>A sequence with the email addresses of one or more bcc recipients. An empty sequence means there are no bcc recipients.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBccRecipient" class="membertitle">getBccRecipient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getBccRecipient</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the bcc recipients of a simple mail message. </dd> <dt><b>Returns</b></dt> <dd>A sequence with the email addresses of one or more bcc recipients. <p>If no bcc recipients have been specified an empty sequence will be returned.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setOriginator" class="membertitle">setOriginator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setOriginator</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aOriginator );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set the email address of the originator of a simple mail message. </dd> <dt><b>Parameter aOriginator</b></dt> <dd>Sets the email address of the originator of the mail. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getOriginator" class="membertitle">getOriginator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getOriginator</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the email address of the originator of a simple mail message. </dd> <dt><b>Returns</b></dt> <dd>The email address of the originator of the mail. <p>If no originator has been specified an empty string will be returned.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setSubject" class="membertitle">setSubject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setSubject</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aSubject );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set the subject of a simple mail message. </dd> <dt><b>Parameter aSubject</b></dt> <dd>Sets the subject of the simple mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubject" class="membertitle">getSubject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getSubject</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the subject of a simple mail message. </dd> <dt><b>Returns</b></dt> <dd>The subject of the simple mail message. <p>If no subject has been specified an empty string will be returned.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setAttachement" class="membertitle">setAttachement</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setAttachement</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aAttachement )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To set an attachment of a simple mail message. </dd> <dt><b>Parameter aAttachement</b></dt> <dd>Sets a sequence of file URLs specifying the files that should be attached to the mail. The given file URLs must be conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. The method does not check if the specified file or files really exist. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if at least one of the given file URLs is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAttachement" class="membertitle">getAttachement</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAttachement</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the attachment of a simple mail message. </dd> <dt><b>Returns</b></dt> <dd>A sequence of file URLs specifying the files that should be attached to the mail or an empty sequence if no attachments have been specified. The returned file URLs are conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
6145
