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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MailServer.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_mail_MailServer_idl__
  32 #define __com_sun_star_mail_MailServer_idl__
  33
  34 #ifndef __com_sun_star_mail_NoMailTransportProviderException_idl__
  35 #include <com/sun/star/mail/NoMailTransportProviderException.idl>
  36 #endif
  37
  38 module com { module sun { module star { module mail {
  39
  40 interface XMailServer;
  41
  42 /**
  43     @since OOo 2.0.0
  44  */
  45 service MailServer: XMailServer
  46 {
  47     /**
  48         Creation method.
  49
  50         @param sServerName
  51         [in] the full qualified domain name of the mail server.
  52
  53         @throws com::sun::star::mail::NoMailTransportProviderException
  54         if an appropriate provider for sending mail messages could not be found or
  55         could not be created.
  56
  57         @throws com::sun::star::uno::Exception
  58         on any other error which prevents the construction of an instance of this service.
  59
  60         @see com::sun::star::mail::XMailServer
  61     */
  62     create([in] string sServerName)
  63         raises(com::sun::star::mail::NoMailTransportProviderException, com::sun::star::uno::Exception);
  64 };
  65
  66 }; }; }; };
  67
  68 #endif