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