/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_FolderListEntry_idl__
#define __com_sun_star_ucb_FolderListEntry_idl__


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Information about a single folder in a <type>FolderList</type>.
*/
published struct FolderListEntry
{
    //-------------------------------------------------------------------------
    /** The title of the folder.
    */
    string Title;

    //-------------------------------------------------------------------------
    /** A (unique) identifier for the folder (used by IMAP, where different
        folders with equal human-readable titles may exist; otherwise, it may
        be left empty).
    */
    string ID;

    //-------------------------------------------------------------------------
    /** The folder is subscribed.
    */
    boolean Subscribed;

    //-------------------------------------------------------------------------
    /** The folder is new.
    */
    boolean New;

    //-------------------------------------------------------------------------
    /** The folder has been removed.
    */
    boolean Removed;

    //-------------------------------------------------------------------------
    /** The folder shall be purged (only used in conjunction with the
        <member>FolderListCommand::SET</member>).
    */
    boolean Purge;
};

//=============================================================================

}; }; }; };

#endif
