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 :: system ::

unpublished interface XMailClient
Usage Restrictions
not published
Description
Specifies an interface for creating and sending email messages through a mail client.
Methods' Summary
createMailMessage Create a mail message object that implements the interface XMailMessage.  
sendMailMessage Sends a given mail message object that implements the interface XMailMessage.  
Methods' Details
createMailMessage
XMailMessage
createMailMessage();
Description
Create a mail message object that implements the interface XMailMessage.
Returns
An object that implements the XMailMessage interface.
sendMailMessage
void
sendMailMessage( [in] XMailMessage  xMailMessage,
[in] long  aFlag )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::Exception );
Description
Sends a given mail message object that implements the interface XMailMessage.
Parameter xMailMessage
Specifies a configured mail object to be sent.
Parameter aFlag
Specifies different flags that control the send process.

Possible flags are specified in MailClientFlags.

If the flag MailClientFlags::NO_USER_INTERFACE is specified, a recipient address must have been specified for the given XMailMessage.

Throws
com::sun::star::lang::IllegalArgumentException
  • If invalid or excluding flags have been specified.
  • The flag MailClientFlags::NO_USER_INTERFACE is specified and no recipient address has been specified for the given XMailMessage object.
  • The parameter XMailMessage is NULL.
Throws
com::sun::star::uno::Exception if an error occurs while sending the mail.

The com::sun::star::uno::Execption::Message may contain an error description.
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.