LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
MailMessage Service Reference

import"MailMessage.idl";

Inheritance diagram for MailMessage:
XMailMessage XInterface

Public Member Functions

 create ([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody)
 Constructs an instance of a mail message. More...
 
 createWithAttachment ([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment)
 Constructs an instance of a mail message. More...
 
- Public Member Functions inherited from XMailMessage
void addRecipient ([in] string sRecipientAddress)
 Add a recipients e-mail address to the list of recipients of this mail message. More...
 
void addCcRecipient ([in] string sRecipientAddress)
 Add a Cc recipients e-mail address to the list of recipients of this mail message. More...
 
void addBccRecipient ([in] string sRecipientAddress)
 Add a BCC recipients e-mail address to the list of recipients of this mail message. More...
 
sequence< string > getRecipients ()
 Return a sequence of the e-mail addresses of all recipients of this mail message. More...
 
sequence< string > getCcRecipients ()
 Return a sequence of the e-mail addresses of all the Cc recipients of this mail message. More...
 
sequence< string > getBccRecipients ()
 Return a sequence of the e-mail addresses of all the BCC recipients of this mail message. More...
 
void addAttachment ([in] MailAttachment aMailAttachment)
 Add a file attachment to a mail message. More...
 
sequence< MailAttachmentgetAttachments ()
 Return a sequence of MailAttachment's that will be attached to this mail message. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Additional Inherited Members

- Public Attributes inherited from XMailMessage
string SenderName
 The display name of the sender of this mail message. More...
 
string SenderAddress
 The e-mail address of the sender of this mail message. More...
 
string ReplyToAddress
 The e-mail address where replies on this mail message should be sent to. More...
 
string Subject
 The subject of a mail message. More...
 
com::sun::star::datatransfer::XTransferable Body
 The body of the mail message. More...
 

Detailed Description

Since
OOo 2.0

Member Function Documentation

◆ create()

create ( [in] string  sTo,
[in] string  sFrom,
[in] string  sSubject,
[in] com::sun::star::datatransfer::XTransferable  xBody 
)

Constructs an instance of a mail message.

Parameters
sTo[in] the e-mail address of the recipient. The e-mail address has to conform to RFC 822.
sFrom[in] the e-mail address of the sender of this mail message. The e-mail address has to conform to RFC 822.
sSubject[in] the subject of the mail message.
xBody[in] 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::mail::XMailMessage
com::sun::star::datatransfer::XTransferable

◆ createWithAttachment()

createWithAttachment ( [in] string  sTo,
[in] string  sFrom,
[in] string  sSubject,
[in] com::sun::star::datatransfer::XTransferable  xBody,
[in] MailAttachment  aMailAttachment 
)

Constructs an instance of a mail message.

Parameters
sTo[in] the e-mail address of the recipient. The e-mail address has to conform to RFC 822.
sFrom[in] the e-mail address of the sender of this mail message. The e-mail address has to conform to RFC 822.
sSubject[in] the subject of the mail message.
xBody[in] 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.
aMailAttachment[in] specifies an attachment which should be send with this mail message.
See also
com::sun::star::mail::XMailMessage
com::sun::star::datatransfer::XTransferable
com::sun::star::mail::MailAttachment

The documentation for this service was generated from the following file: