Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: system ::
interface XSimpleMailMessage
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XSimpleMailMessage
Description This interface lets a client set or get the information of a simple mail message.

Methods' Summary
setRecipient | To set the recipient of the simple mail message.
getRecipient | To get the recipient of the simple mail message.
setCcRecipient | To set the cc recipients of a simple mail message.
getCcRecipient | To get the cc recipients of a simple mail message.
setBccRecipient | To set the bcc recipient of a simple mail message.
getBccRecipient | To get the bcc recipients of a simple mail message.
setOriginator | To set the email address of the originator of a simple mail message.
getOriginator | To get the email address of the originator of a simple mail message.
setSubject | To set the subject of a simple mail message.
getSubject | To get the subject of a simple mail message.
setAttachement | To set an attachment of a simple mail message.
getAttachement | To get the attachment of a simple mail message.

Methods' Details
setRecipient
void setRecipient( | [in] string | aRecipient );
Description To set the recipient of the simple mail message. Parameter aRecipient The email address of a recipient. The method doesn't check if the given email address is valid.
getRecipient
string getRecipient(); |  |
Description To get the recipient of the simple mail message. Returns The specified email address of a recipient if any has been specified or an empty string.
setCcRecipient
void setCcRecipient( | [in] sequence< string > | aCcRecipient );
Description To set the cc recipients of a simple mail message. Parameter aCcRecipient Sets a sequence with the email addresses of one or more cc recipients. The method does not check if the given addresses are valid. An empty sequence means there are no cc recipients.
getCcRecipient
sequence< string > getCcRecipient(); |  |
Description To get the cc recipients of a simple mail message. Returns A sequence with the email addresses of one or more cc recipients. If no cc recipients have been specified an empty sequence will be returned.
setBccRecipient
void setBccRecipient( | [in] sequence< string > | aBccRecipient );
Description To set the bcc recipient of a simple mail message. Parameter aBccRecipient A sequence with the email addresses of one or more bcc recipients. An empty sequence means there are no bcc recipients.
getBccRecipient
sequence< string > getBccRecipient(); |  |
Description To get the bcc recipients of a simple mail message. Returns A sequence with the email addresses of one or more bcc recipients. If no bcc recipients have been specified an empty sequence will be returned.
setOriginator
void setOriginator( | [in] string | aOriginator );
Description To set the email address of the originator of a simple mail message. Parameter aOriginator Sets the email address of the originator of the mail.
getOriginator
string getOriginator(); |  |
Description To get the email address of the originator of a simple mail message. Returns The email address of the originator of the mail. If no originator has been specified an empty string will be returned.
setSubject
void setSubject( | [in] string | aSubject );
Description To set the subject of a simple mail message. Parameter aSubject Sets the subject of the simple mail message.
getSubject
string getSubject(); |  |
Description To get the subject of a simple mail message. Returns The subject of the simple mail message. If no subject has been specified an empty string will be returned.
setAttachement
void setAttachement( | [in] sequence< string > raises( | aAttachement ) ::com::sun::star::lang::IllegalArgumentException );
Description To set an attachment of a simple mail message. Parameter aAttachement Sets a sequence of file URLs specifying the files that should be attached to the mail. The given file URLs must be conform to Rfc1738 . The method does not check if the specified file or files really exist. Throws ::com::sun::star::lang::IllegalArgumentException if at least one of the given file URLs is invalid (doesn't conform to Rfc1738 ).
getAttachement
sequence< string > getAttachement(); |  |
Description To get the attachment of a simple mail message. Returns 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 Rfc1738 .

Top of Page

Copyright © 2003 Sun Microsystems, Inc.