XMailMessage Interface Reference

Represents a mail message. More...

import"XMailMessage.idl";

Inheritance diagram for XMailMessage:

Public Member Functions
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< MailAttachment >	getAttachments ()
	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...

Public Attributes
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

Represents a mail message.

See also

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

Since

OOo 2.0

Member Function Documentation

addAttachment()

void addAttachment

(

[in] MailAttachment

aMailAttachment

)

Add a file attachment to a mail message.

param aMailAttachment [in] specifies a file which should be attached to this mail message.

See also

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

addBccRecipient()

void addBccRecipient

(

[in] string

sRecipientAddress

)

Add a 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.

Parameters

sRecipientAddress

[in] the e-mail address of the BCC recipient.

addCcRecipient()

void addCcRecipient

(

[in] string

sRecipientAddress

)

Add a 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.

Parameters

sRecipientAddress

[in] the e-mail address of the Cc recipient.

addRecipient()

void addRecipient

(

[in] string

sRecipientAddress

)

Add a 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.

Parameters

sRecipientAddress

[in] the e-mail address of the recipient.

getAttachments()

sequence<MailAttachment> getAttachments

(

)

Return a sequence of MailAttachment's that will be attached to this mail message.

See also

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

getBccRecipients()

sequence<string> getBccRecipients

(

)

Return a sequence of the e-mail addresses of all the BCC recipients of this mail message.

getCcRecipients()

sequence<string> getCcRecipients

(

)

Return a sequence of the e-mail addresses of all the Cc recipients of this mail message.

getRecipients()

sequence<string> getRecipients

(

)

Return a sequence of the e-mail addresses of all recipients of this mail message.

Member Data Documentation

Body

com::sun::star::datatransfer::XTransferable Body

attribute

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

ReplyToAddress

string ReplyToAddress

attribute

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.

SenderAddress

string SenderAddress

attributereadonly

The e-mail address of the sender of this mail message.

The e-mail address has to conform to RFC 822.

SenderName

string SenderName

attributereadonly

The display name of the sender of this mail message.

Subject

string Subject

attribute

The subject of a mail message.

---

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

• com/sun/star/mail/XMailMessage.idl