Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: mail ::

unpublished interface XMailMessage
Usage Restrictions
not published
Description
Represents a mail message.
Since
OOo 2.0
See also
XMailServer
Methods' Summary
addRecipient Add an recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to RFC 822 sending the mail message will fail.  
addCcRecipient 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 RFC 822 sending the mail message will fail.  
addBccRecipient 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 RFC 822 sending the mail message will fail.  
getRecipients Return a sequence of the e-mail addresses of all recipients of this mail message.  
getCcRecipients Return a sequence of the e-mail addresses of all the Cc recipients of this mail message.  
getBccRecipients Return a sequence of the e-mail addresses of all the Bcc recipients of this mail message.  
addAttachment Add a file attachment to a mail message. param aMailAttachment [in] specifies a file which should be attached to this mail message.  
getAttachments Return a sequence of MailAttachment's that will be attached to this mail message.  
Attributes' Summary
SenderName The display name of the sender of this mail message.  
SenderAddress The e-mail address of the sender of this mail message. The e-mail address has to conform to RFC 822.  
ReplyToAddress The e-mail address where replies on this mail message should be sent to. If the e-mail address doesn't conform to RFC 822 sending the mail message later will fail. If no ReplyToAddress is set replies go to the SenderAddress.  
Subject The subject of a mail message.  
Body 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.  
Methods' Details
addRecipient
void
addRecipient( [in] string  sRecipientAddress );
Description
Add an recipients e-mail address to the list of recipients of this mail message. If the e-mail address doesn't conform to RFC 822 sending the mail message will fail.
Parameter sRecipientAddress
[in] the e-mail address of the recipient.
addCcRecipient
void
addCcRecipient( [in] string  sRecipientAddress );
Description
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 RFC 822 sending the mail message will fail.
Parameter sRecipientAddress
[in] the e-mail address of the Cc recipient.
addBccRecipient
void
addBccRecipient( [in] string  sRecipientAddress );
Description
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 RFC 822 sending the mail message will fail.
Parameter sRecipientAddress
[in] the e-mail address of the Bcc recipient.
getRecipients
sequence< string >
getRecipients();
Description
Return a sequence of the e-mail addresses of all recipients of this mail message.
getCcRecipients
sequence< string >
getCcRecipients();
Description
Return a sequence of the e-mail addresses of all the Cc recipients of this mail message.
getBccRecipients
sequence< string >
getBccRecipients();
Description
Return a sequence of the e-mail addresses of all the Bcc recipients of this mail message.
addAttachment
void
addAttachment( [in] MailAttachment  aMailAttachment );
Description
Add a file attachment to a mail message. param aMailAttachment [in] specifies a file which should be attached to this mail message.
See also
MailAttachment
getAttachments
sequence< MailAttachment >
getAttachments();
Description
Return a sequence of MailAttachment's that will be attached to this mail message.
See also
MailAttachment
Attributes' Details
SenderName
[ readonly ] string SenderName;
Description
The display name of the sender of this mail message.
SenderAddress
[ readonly ] string SenderAddress;
Description
The e-mail address of the sender of this mail message. The e-mail address has to conform to RFC 822.
ReplyToAddress
string ReplyToAddress;
Description
The e-mail address where replies on this mail message should be sent to. If the e-mail address doesn't conform to RFC 822 sending the mail message later will fail. If no ReplyToAddress is set replies go to the SenderAddress.
Subject
string Subject;
Description
The subject of a mail message.
Body
::com::sun::star::datatransfer::XTransferable Body;
Description
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.
See also
::com::sun::star::datatransfer::XTransferable
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.