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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_mail_XMailServiceProvider_idl__
  21 #define __com_sun_star_mail_XMailServiceProvider_idl__
  22
  23 #include <com/sun/star/mail/XMailService.idl>
  24 #include <com/sun/star/mail/NoMailServiceProviderException.idl>
  25 #include <com/sun/star/mail/MailServiceType.idl>
  26
  27 module com { module sun { module star { module mail {
  28
  29 /**
  30    A factory for creating different mail services.
  31
  32    @since OOo 2.0
  33  */
  34 interface XMailServiceProvider: ::com::sun::star::uno::XInterface {
  35
  36     /**
  37         A factory method.
  38
  39         @param aType
  40         [in] the type of the requested mail service.
  41
  42         @returns
  43         A XMailService interface.
  44
  45         @see com::sun::star::mail::XMailServiceProvider
  46         @see com::sun::star::mail::MailServiceType
  47     */
  48     XMailService create([in] MailServiceType aType)
  49         raises(com::sun::star::mail::NoMailServiceProviderException, com::sun::star::uno::Exception);
  50 };
  51
  52 }; }; }; };
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */