Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: system ::

interface XSimpleMailClient

Base Interface
com::sun::star::uno::XInterface

Description
Specifies an interface for creating and sending email messages.


Methods' Summary

createSimpleMailMessage Create a simple mail message object that implements the interface XSimpleMailMessage .
sendSimpleMailMessage Sends a given simple mail message object that implements the interface XSimpleMailMessage .

Methods' Details

createSimpleMailMessage
 
com::sun::star::system::XSimpleMailMessage
createSimpleMailMessage();
Description
Create a simple mail message object that implements the interface XSimpleMailMessage .
Returns
An object that implements the XSimpleMailMessage interface.
sendSimpleMailMessage
 
void
sendSimpleMailMessage(
[ in ] com::sun::star::system::XSimpleMailMessage xSimpleMailMessage,
[ in ] long aFlag )
raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::uno::Exception );

Description
Sends a given simple mail message object that implements the interface XSimpleMailMessage .
Parameter xSimpleMailMessage
Specifies a configured mail object to be sent.
Parameter aFlag
Specifies different flags that control the send process if the flag NO_USER_INTERFACE is specified. A recipient address must have been specified for the given xMailMessage object.
Throws
com::sun::star::lang::IllegalArgumentException
  • If invalid or excluding flags have been specified.
  • The flag NO_USER_INTERFACE is specified and no recipient address has been specified for the given xSimpleMailMessage object.
  • The parameter xSimpleMailMessage is NULL.
Throws
com::sun::star::uno::Exception if an error occurs while sending the mail.

The Message member of the exception may contain an error description.

See also
com::sun::star::system::XSimpleMailMessage
See also
com::sun::star::system::SimpleMailClientFlags

Top of Page