1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_mail_XAuthenticator_idl__
25#define __com_sun_star_mail_XAuthenticator_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31module com { module sun { module star { module mail {
32
33/**
34   Represents an interface that will be used to query for user
35   information which are necessary to login to a network resource.
36   An implementation of this interface may for instance show a
37   dialog to query the user for the necessary data.
38
39   @since OpenOffice 2.0
40 */
41interface XAuthenticator: ::com::sun::star::uno::XInterface {
42
43    /**
44        Will be called when the user name is needed.
45
46        @returns
47        the user name.
48    */
49    string getUserName();
50
51    /**
52        Will be called when the password of the user is needed.
53
54        @returns
55        the password of the user.
56    */
57    string getPassword();
58};
59
60}; }; }; };
61
62#endif
63