The Free and Open Productivity Suite
QA Volunteers Needed -- Help us test OpenOffice

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for Apache OpenOffice version 3.4.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XSimpleMailClient
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
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] 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
XSimpleMailMessage, SimpleMailClientFlags
Top of Page

Copyright © 2012, 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 Feather

Copyright & License | Privacy | Contact Us | Donate

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.