office-gobmx/offapi/com/sun/star/system/XSimpleMailClient.idl
2001-05-07 04:39:26 +00:00

136 lines
4.9 KiB
Text

/*************************************************************************
*
* $RCSfile: XSimpleMailClient.idl,v $
*
* $Revision: 1.2 $
*
* last change: $Author: tra $ $Date: 2001-05-07 05:39:26 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_system_XSimpleMailClient_idl__
#define __com_sun_star_system_XSimpleMailClient_idl__
#ifndef __com_sun_star_uno_RuntimeException_idl__
#include <com/sun/star/uno/RuntimeException.idl>
#endif
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_system_XSimpleMailMessage_idl__
#include <com/sun/star/system/XSimpleMailMessage.idl>
#endif
#ifndef __com_sun_star_system_SimpleMailClientFlags_idl__
#include <com/sun/star/system/SimpleMailClientFlags.idl>
#endif
//=============================================================================
module com { module sun { module star { module system {
//=============================================================================
/** specifies an interface
@author tra
@version 0.1
*/
interface XSimpleMailClient: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/**
@returns
an object that implements the ::com::sun::star::system::XSimpleMailMessage interface
*/
XSimpleMailMessage createSimpleMailMessage( );
//-------------------------------------------------------------------------
/** Sends the given mail object
@param xSimpleMailMessage
specifies a configured mail object to be sent
@param 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 or if the
flag NO_USER_INTERFACE is specified and no recipient
address has been specified for the given xMailMessage object
@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 ::com::sun::star::system::SimpleMailClientFlags
*/
void sendSimpleMailMessage( [in] XSimpleMailMessage xSimpleMailMessage, [in] long aFlag )
raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception );
};
//=============================================================================
}; }; }; };
#endif