offapi/com/sun/star/mail/XMailServiceProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_mail_XMailServiceProvider_idl__
  29 #define __com_sun_star_mail_XMailServiceProvider_idl__
  30
  31 #ifndef __com_sun_star_mail_XMailService_idl__
  32 #include <com/sun/star/mail/XMailService.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_mail_NoMailServiceProviderException_idl__
  36 #include <com/sun/star/mail/NoMailServiceProviderException.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_mail_MailServiceType_idl__
  40 #include <com/sun/star/mail/MailServiceType.idl>
  41 #endif
  42
  43 module com { module sun { module star { module mail {
  44
  45 /**
  46    A factory for creating different mail services.
  47
  48    @since OOo 2.0.0
  49  */
  50 interface XMailServiceProvider: ::com::sun::star::uno::XInterface {
  51
  52     /**
  53         A factory method.
  54
  55         @param aType
  56         [in] the type of the requested mail service.
  57
  58         @returns
  59         A XMailService interface.
  60
  61         @see com::sun::star::mail::XMailServiceProvider
  62         @see com::sun::star::mail::MailServiceType
  63     */
  64     XMailService create([in] MailServiceType aType)
  65         raises(com::sun::star::mail::NoMailServiceProviderException, com::sun::star::uno::Exception);
  66 };
  67
  68 }; }; }; };
  69
  70 #endif