<html> <head> <title>Interface XMailMessage</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="XMailMessage-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="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">mail</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XMailMessage</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>Represents a mail message. </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> <dt><b>See also</b></dt> <dd><a href="XMailService.html">XMailService</a></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="#addRecipient">addRecipient</a></td> <td class="imsum_right">Add an recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </td> </tr> <tr> <td class="imsum_left"><a href="#addCcRecipient">addCcRecipient</a></td> <td class="imsum_right">Add an Cc recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </td> </tr> <tr> <td class="imsum_left"><a href="#addBccRecipient">addBccRecipient</a></td> <td class="imsum_right">Add an BCC recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </td> </tr> <tr> <td class="imsum_left"><a href="#getRecipients">getRecipients</a></td> <td class="imsum_right">Return a sequence of the e-mail addresses of all recipients of this mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getCcRecipients">getCcRecipients</a></td> <td class="imsum_right">Return a sequence of the e-mail addresses of all the Cc recipients of this mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getBccRecipients">getBccRecipients</a></td> <td class="imsum_right">Return a sequence of the e-mail addresses of all the BCC recipients of this mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#addAttachment">addAttachment</a></td> <td class="imsum_right">Add a file attachment to a mail message. param aMailAttachment [in] specifies a file which should be attached to this mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#getAttachments">getAttachments</a></td> <td class="imsum_right">Return a sequence of <a href="MailAttachment.html">MailAttachment</a>'s that will be attached to this mail message. </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#SenderName">SenderName</a></td> <td class="imsum_right">The display name of the sender of this mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#SenderAddress">SenderAddress</a></td> <td class="imsum_right">The e-mail address of the sender of this mail message. The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#ReplyToAddress">ReplyToAddress</a></td> <td class="imsum_right">The e-mail address where replies on this mail message should be sent to. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message later will fail. If no ReplyToAddress is set replies go to the SenderAddress. </td> </tr> <tr> <td class="imsum_left"><a href="#Subject">Subject</a></td> <td class="imsum_right">The subject of a mail message. </td> </tr> <tr> <td class="imsum_left"><a href="#Body">Body</a></td> <td class="imsum_right">The body of the mail message. It is expected that the transferable delivers the data as a string. Although a transferable may support multiple data flavors only the first data flavor supplied will be used to retrieve the data and it is expected that the data will be provided as a string. </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="addRecipient" class="membertitle">addRecipient</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>addRecipient</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sRecipientAddress );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add an recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </dd> <dt><b>Parameter sRecipientAddress</b></dt> <dd>[in] the e-mail address of the recipient. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addCcRecipient" class="membertitle">addCcRecipient</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>addCcRecipient</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sRecipientAddress );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add an Cc recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </dd> <dt><b>Parameter sRecipientAddress</b></dt> <dd>[in] the e-mail address of the Cc recipient. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addBccRecipient" class="membertitle">addBccRecipient</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>addBccRecipient</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sRecipientAddress );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add an BCC recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message will fail. </dd> <dt><b>Parameter sRecipientAddress</b></dt> <dd>[in] the e-mail address of the BCC recipient. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRecipients" class="membertitle">getRecipients</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>getRecipients</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a sequence of the e-mail addresses of all recipients of this mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCcRecipients" class="membertitle">getCcRecipients</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>getCcRecipients</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a sequence of the e-mail addresses of all the Cc recipients of this mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBccRecipients" class="membertitle">getBccRecipients</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>getBccRecipients</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a sequence of the e-mail addresses of all the BCC recipients of this mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addAttachment" class="membertitle">addAttachment</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>addAttachment</b>(</td> <td valign="top">[in] <a href="MailAttachment.html">MailAttachment</a></td> <td valign="bottom"> aMailAttachment );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add a file attachment to a mail message. param aMailAttachment [in] specifies a file which should be attached to this mail message. </dd> <dt><b>See also</b></dt> <dd><a href="MailAttachment.html">MailAttachment</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAttachments" class="membertitle">getAttachments</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< <a href="MailAttachment.html">MailAttachment</a> ></td> </tr> <tr> <td valign="top"><b>getAttachments</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a sequence of <a href="MailAttachment.html">MailAttachment</a>'s that will be attached to this mail message. </dd> <dt><b>See also</b></dt> <dd><a href="MailAttachment.html">MailAttachment</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="SenderName" class="membertitle">SenderName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>SenderName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The display name of the sender of this mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SenderAddress" class="membertitle">SenderAddress</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>SenderAddress</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The e-mail address of the sender of this mail message. The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReplyToAddress" class="membertitle">ReplyToAddress</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ReplyToAddress</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The e-mail address where replies on this mail message should be sent to. If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a> sending the mail message later will fail. If no ReplyToAddress is set replies go to the SenderAddress. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Subject" class="membertitle">Subject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Subject</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The subject of a mail message. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Body" class="membertitle">Body</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../datatransfer/module-ix.html">datatransfer</a>::<a href="../datatransfer/XTransferable.html">XTransferable</a> <b>Body</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The body of the mail message. It is expected that the transferable delivers the data as a string. Although a transferable may support multiple data flavors only the first data flavor supplied will be used to retrieve the data and it is expected that the data will be provided as a string. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../datatransfer/module-ix.html">datatransfer</a>::<a href="../datatransfer/XTransferable.html">XTransferable</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 © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
