xref: /AOO41X/main/offapi/com/sun/star/mail/XAuthenticator.idl (revision 96af39f745f380c70aec9fab3a79dc8b37f680ac)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_mail_XAuthenticator_idl__
#define __com_sun_star_mail_XAuthenticator_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module mail {

/**
   Represents an interface that will be used to query for user
   information which are necessary to login to a network resource.
   An implementation of this interface may for instance show a
   dialog to query the user for the necessary data.

   @since OpenOffice 2.0
 */
interface XAuthenticator: ::com::sun::star::uno::XInterface {

    /**
        Will be called when the user name is needed.

        @returns
        the user name.
    */
    string getUserName();

    /**
        Will be called when the password of the user is needed.

        @returns
        the password of the user.
    */
    string getPassword();
};

}; }; }; };

#endif