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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#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 for creating and sending email messages.  
*/
 
published interface XSimpleMailClient: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**	Create a simple mail message object that implements the interface 
		<type>XSimpleMailMessage</type>.
		@returns 
		An object that implements the <type>XSimpleMailMessage</type> interface.		
	*/
	XSimpleMailMessage createSimpleMailMessage( );

	//-------------------------------------------------------------------------
	/**	Sends a given simple mail message object that implements the interface 
		<type>XSimpleMailMessage</type>.
		
		@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
		<ul>
			<li>If invalid or excluding flags have been specified.</li>
			<li>The flag NO_USER_INTERFACE is specified and no recipient
			address has been specified for the given xSimpleMailMessage object.</li>
			<li>The parameter xSimpleMailMessage is NULL.</li>
		</ul>
		
		@throws com::sun::star::uno::Exception
		if an error occurs while sending the mail. 
		<p>The Message member of the exception may contain an error description.</p>
		
		@see com::sun::star::system::XSimpleMailMessage
		@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