diff options
author | Tino Rachui <tra@openoffice.org> | 2001-05-03 12:22:29 +0000 |
---|---|---|
committer | Tino Rachui <tra@openoffice.org> | 2001-05-03 12:22:29 +0000 |
commit | 7ef8cb78fc7b9b2295544231b8b5ee02a795eecd (patch) | |
tree | b1e0614c0dcba636daac0f48f714be3d633cdeee /offapi/com/sun/star/system | |
parent | b26aa8247affef5641723ae5fa39a98de5096155 (diff) |
*** empty log message ***
Diffstat (limited to 'offapi/com/sun/star/system')
-rw-r--r-- | offapi/com/sun/star/system/SimpleMailClientFlags.idl | 107 | ||||
-rw-r--r-- | offapi/com/sun/star/system/SimpleSystemMail.idl | 112 | ||||
-rw-r--r-- | offapi/com/sun/star/system/XSimpleMailClient.idl | 136 | ||||
-rw-r--r-- | offapi/com/sun/star/system/XSimpleMailClientSupplier.idl | 109 | ||||
-rw-r--r-- | offapi/com/sun/star/system/XSimpleMailMessage.idl | 193 |
5 files changed, 657 insertions, 0 deletions
diff --git a/offapi/com/sun/star/system/SimpleMailClientFlags.idl b/offapi/com/sun/star/system/SimpleMailClientFlags.idl new file mode 100644 index 000000000000..90b4e010101d --- /dev/null +++ b/offapi/com/sun/star/system/SimpleMailClientFlags.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * $RCSfile: SimpleMailClientFlags.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-05-03 13:22:22 $ + * + * 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_SimpleMailClientFlags_idl__ +#define __com_sun_star_system_SimpleMailClientFlags_idl__ + + +module com { module sun { module star { module system { + +//============================================================================= +/** These constants are used to specify how the SimpleMailClient Service + should behave + */ + +constants SimpleMailClientFlags +{ + //--------------------------------------------------------------------- + /** Uses the default settings when sending a mail, e.g. + launches the current configured system mail client + */ + const long MCF_DEFAULTS = 0; + + //--------------------------------------------------------------------- + /** Does not show the current configured system mail client but sends + the mail without any further user interaction + if this flags is specified a recipient address must have been + specified for the given ::com::sun::star::system::XMail object + given to the sendMail method. + + @see ::som::sun::star::system::XSimpleMailClient + */ + const long MCF_NO_USER_INTERFACE = 1; + + //--------------------------------------------------------------------- + /** No logon dialog should be displayed to prompt the user for logon + information if necessary. + When this flag is specified and the user needs to logon in order + to send the mail via the method sendMail of + ::com::sun::star::system::XSimpleMailClient an Exception will + be thrown + */ + const long MCF_NO_LOGON_DIALOG = 2; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/SimpleSystemMail.idl b/offapi/com/sun/star/system/SimpleSystemMail.idl new file mode 100644 index 000000000000..91ce199fcd09 --- /dev/null +++ b/offapi/com/sun/star/system/SimpleSystemMail.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: SimpleSystemMail.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-05-03 13:22:29 $ + * + * 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_SimpleSystemMail_idl__ +#define __com_sun_star_system_SimpleSystemMail_idl__ + +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +#ifndef __com_sun_star_lang_XTypeProvider_idl__ +#include <com/sun/star/lang/XTypeProvider.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module system { + +//============================================================================= + +//============================================================================= +/** A SimpleSystemMail service implements an interface to send mail messages + via the current configured system mail client + + @see XSimpleMailClient +*/ + +interface XSimpleMailClientSupplier; + +service SimpleSystemMail +{ + //------------------------------------------------------------------------- + /** Provides access to a XSimpleMailClientSupplier interface. + + @see XSimpleMailClientSupplier + */ + interface XSimpleMailClientSupplier; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XServiceInfo; + + //------------------------------------------------------------------------- + /** service should always support this interface. + */ + interface com::sun::star::lang::XTypeProvider; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/system/XSimpleMailClient.idl b/offapi/com/sun/star/system/XSimpleMailClient.idl new file mode 100644 index 000000000000..a9b52cca29cd --- /dev/null +++ b/offapi/com/sun/star/system/XSimpleMailClient.idl @@ -0,0 +1,136 @@ +/************************************************************************* + * + * $RCSfile: XSimpleMailClient.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-05-03 13:21:54 $ + * + * 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 MCF_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 MCF_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 + diff --git a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl new file mode 100644 index 000000000000..706f856b22b9 --- /dev/null +++ b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl @@ -0,0 +1,109 @@ +/************************************************************************* + * + * $RCSfile: XSimpleMailClientSupplier.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-05-03 13:22:04 $ + * + * 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_XSimpleMailClientSupplier_idl__ +#define __com_sun_star_system_XSimpleMailClientSupplier_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_XSimpleMailClient_idl__ +#include <com/sun/star/system/XSimpleMailClient.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module system { + +//============================================================================= +/** specifies an interface for executing a system command + + @author tra + @version 0.1 +*/ + + +interface XSimpleMailClientSupplier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** + @returns + an interface to a mail client if there is one available on the system + or an empty reference + */ + XSimpleMailClient querySimpleMailClient( ); +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/system/XSimpleMailMessage.idl b/offapi/com/sun/star/system/XSimpleMailMessage.idl new file mode 100644 index 000000000000..9cb4e9f843de --- /dev/null +++ b/offapi/com/sun/star/system/XSimpleMailMessage.idl @@ -0,0 +1,193 @@ +/************************************************************************* + * + * $RCSfile: XSimpleMailMessage.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tra $ $Date: 2001-05-03 13:22:14 $ + * + * 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 { + +//============================================================================= +/** + + @author tra + @version 0.1 +*/ + + +interface XSimpleMailMessage: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** + @param aRecipient + the email address of an recipient, the method doesn't check if + the given address is valid + */ + void setRecipient( [in] string aRecipient ); + + //------------------------------------------------------------------------- + /** + @returns + the specified email address of a recipient + if any has been specified or an empty string + */ + string getRecipient( ); + + //------------------------------------------------------------------------- + /** + @param aCcRecipient + set a sequence with the email addresses of one or more cc recipients, + the method doesn't check if the given addresses are valid + */ + void setCcRecipient( [in] sequence< string > aCcRecipient ); + + //------------------------------------------------------------------------- + /** + @returns + a sequence with the email addresses of one or more cc recipients + or an empty sequence if no cc recipients have been specified + */ + sequence< string > getCcRecipient( ); + + //------------------------------------------------------------------------- + /** + @param aBccRecipient + set a sequence with the email addresses of one ore more bcc recipients + */ + void setBccRecipient( [in] sequence< string > aBccRecipient ); + + //------------------------------------------------------------------------- + /** + @returns + a sequence with the email addresses of one or more bcc recipients or an + empty sequence if no cc recipients have been specified + */ + sequence< string > getBccRecipient( ); + + //------------------------------------------------------------------------- + /** + @param aOriginator + sets the email address of an originator of the mail + */ + void setOriginator( [in] string aOriginator ); + + //------------------------------------------------------------------------- + /** + @returns + the email address of the originator of the mail if any has been specified + */ + string getOriginator( ); + + //------------------------------------------------------------------------- + /** + @param aSubject + sets the subject of the mail + */ + void setSubject( [in] string aSubject ); + + //------------------------------------------------------------------------- + /** + @returns + the subject of the mail if any has been specified + */ + string getSubject( ); + + //------------------------------------------------------------------------- + /** + @param aAttachement + sets a sequence of File-URL specifying the files that should be + attached to the mail, 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-URL is invalid + */ + void setAttachement( [in] sequence< string > aAttachement ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** + @returns + a sequence of File-URLs specifying the files that should be attached to + the mail or an empty sequence if no attachements have been specified yet + */ + sequence< string > getAttachement( ); +}; + +//============================================================================= + +}; }; }; }; + +#endif + |