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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module mail {
  21
  22 /**
  23    Represents an interface that will be used to query for user
  24    information which are necessary to login to a network resource.
  25    An implementation of this interface may for instance show a
  26    dialog to query the user for the necessary data.
  27
  28    @since OOo 2.0
  29  */
  30 interface XAuthenticator: ::com::sun::star::uno::XInterface {
  31
  32     /**
  33         Will be called when the user name is needed.
  34
  35         @returns
  36         the user name.
  37     */
  38     string getUserName();
  39
  40     /**
  41         Will be called when the password of the user is needed.
  42
  43         @returns
  44         the password of the user.
  45     */
  46     string getPassword();
  47 };
  48
  49 }; }; }; };
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */