199 lines
7.9 KiB
Text
199 lines
7.9 KiB
Text
/*************************************************************************
|
|
*
|
|
* $RCSfile: XSimpleMailMessage.idl,v $
|
|
*
|
|
* $Revision: 1.5 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2004-06-03 23:35:55 $
|
|
*
|
|
* 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_XSimpleMailMessage_idl__
|
|
#define __com_sun_star_system_XSimpleMailMessage_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
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module system {
|
|
|
|
//=============================================================================
|
|
/** This interface lets a client set or get the information of a simple mail
|
|
message.
|
|
*/
|
|
|
|
|
|
published interface XSimpleMailMessage: com::sun::star::uno::XInterface
|
|
{
|
|
//-------------------------------------------------------------------------
|
|
/** To set the recipient of the simple mail message.
|
|
@param aRecipient
|
|
The email address of a recipient. The method doesn't check if
|
|
the given email address is valid.
|
|
*/
|
|
void setRecipient( [in] string aRecipient );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the recipient of the simple mail message.
|
|
@returns
|
|
The specified email address of a recipient
|
|
if any has been specified or an empty string.
|
|
*/
|
|
string getRecipient( );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To set the cc recipients of a simple mail message.
|
|
|
|
@param aCcRecipient
|
|
Sets a sequence with the email addresses of one or more cc recipients.
|
|
<p>The method does not check if the given addresses are valid. An empty
|
|
sequence means there are no cc recipients.</p>
|
|
*/
|
|
void setCcRecipient( [in] sequence< string > aCcRecipient );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the cc recipients of a simple mail message.
|
|
@returns
|
|
A sequence with the email addresses of one or more cc recipients.
|
|
<p>If no cc recipients have been specified an empty sequence will be returned.</p>
|
|
*/
|
|
sequence< string > getCcRecipient( );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To set the bcc recipient of a simple mail message.
|
|
@param aBccRecipient
|
|
A sequence with the email addresses of one or more bcc recipients. An empty
|
|
sequence means there are no bcc recipients.</p>
|
|
*/
|
|
void setBccRecipient( [in] sequence< string > aBccRecipient );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the bcc recipients of a simple mail message.
|
|
@returns
|
|
A sequence with the email addresses of one or more bcc recipients.
|
|
<p>If no bcc recipients have been specified an empty sequence will be returned.</p>
|
|
*/
|
|
sequence< string > getBccRecipient( );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To set the email address of the originator of a simple mail message.
|
|
@param aOriginator
|
|
Sets the email address of the originator of the mail.
|
|
*/
|
|
void setOriginator( [in] string aOriginator );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the email address of the originator of a simple mail message.
|
|
@returns
|
|
The email address of the originator of the mail.
|
|
<p>If no originator has been specified an empty string will be returned.</p>
|
|
*/
|
|
string getOriginator( );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To set the subject of a simple mail message.
|
|
@param aSubject
|
|
Sets the subject of the simple mail message.
|
|
*/
|
|
void setSubject( [in] string aSubject );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the subject of a simple mail message.
|
|
@returns
|
|
The subject of the simple mail message.
|
|
<p>If no subject has been specified an empty string will be returned.</p>
|
|
*/
|
|
string getSubject( );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To set an attachment of a simple mail message.
|
|
@param aAttachement
|
|
Sets a sequence of file URLs specifying the files that should be
|
|
attached to the mail. The given file URLs must be conform to
|
|
<a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
|
|
The method does not check if the specified file or files really exist.
|
|
|
|
@throws ::com::sun::star::lang::IllegalArgumentException
|
|
if at least one of the given file URLs is invalid (doesn't conform to
|
|
<a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>).
|
|
*/
|
|
void setAttachement( [in] sequence< string > aAttachement )
|
|
raises( ::com::sun::star::lang::IllegalArgumentException );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** To get the attachment of a simple mail message.
|
|
@returns
|
|
A sequence of file URLs specifying the files that should be attached to
|
|
the mail or an empty sequence if no attachments have been specified.
|
|
The returned file URLs are conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
|
|
*/
|
|
sequence< string > getAttachement( );
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|
|
|