offapi/com/sun/star/system/XSimpleMailClient.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSimpleMailClient.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_system_XSimpleMailClient_idl__
  32 #define __com_sun_star_system_XSimpleMailClient_idl__
  33
  34 #ifndef __com_sun_star_uno_RuntimeException_idl__
  35 #include <com/sun/star/uno/RuntimeException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_system_XSimpleMailMessage_idl__
  47 #include <com/sun/star/system/XSimpleMailMessage.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_system_SimpleMailClientFlags_idl__
  51 #include <com/sun/star/system/SimpleMailClientFlags.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56 module com { module sun { module star { module system {
  57
  58 //=============================================================================
  59 /** Specifies an interface for creating and sending email messages.
  60 */
  61
  62 published interface XSimpleMailClient: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65     /** Create a simple mail message object that implements the interface
  66         <type>XSimpleMailMessage</type>.
  67         @returns
  68         An object that implements the <type>XSimpleMailMessage</type> interface.
  69     */
  70     XSimpleMailMessage createSimpleMailMessage( );
  71
  72     //-------------------------------------------------------------------------
  73     /** Sends a given simple mail message object that implements the interface
  74         <type>XSimpleMailMessage</type>.
  75
  76         @param xSimpleMailMessage
  77         Specifies a configured mail object to be sent.
  78
  79         @param aFlag
  80         Specifies different flags that control the send process
  81         if the flag NO_USER_INTERFACE is specified. A recipient
  82         address must have been specified for the given xMailMessage object.
  83
  84         @throws com::sun::star::lang::IllegalArgumentException
  85         <ul>
  86             <li>If invalid or excluding flags have been specified.</li>
  87             <li>The flag NO_USER_INTERFACE is specified and no recipient
  88             address has been specified for the given xSimpleMailMessage object.</li>
  89             <li>The parameter xSimpleMailMessage is NULL.</li>
  90         </ul>
  91
  92         @throws com::sun::star::uno::Exception
  93         if an error occurs while sending the mail.
  94         <p>The Message member of the exception may contain an error description.</p>
  95
  96         @see com::sun::star::system::XSimpleMailMessage
  97         @see com::sun::star::system::SimpleMailClientFlags
  98     */
  99     void sendSimpleMailMessage( [in] XSimpleMailMessage xSimpleMailMessage, [in] long aFlag )
 100         raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception );
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif
 108