offapi/com/sun/star/mail/XAuthenticator.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: XAuthenticator.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_XAuthenticator_idl__
  32 #define __com_sun_star_mail_XAuthenticator_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module mail {
  39
  40 /**
  41    Represents an interface that will be used to query for user
  42    information which are necessary to login to a network resource.
  43    An implementation of this interface may for instance show a
  44    dialog to query the user for the necessary data.
  45
  46    @since OOo 2.0.0
  47  */
  48 interface XAuthenticator: ::com::sun::star::uno::XInterface {
  49
  50     /**
  51         Will be called when the user name is needed.
  52
  53         @returns
  54         the user name.
  55     */
  56     string getUserName();
  57
  58     /**
  59         Will be called when the password of the user is needed.
  60
  61         @returns
  62         the password of the user.
  63     */
  64     string getPassword();
  65 };
  66
  67 }; }; }; };
  68
  69 #endif