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#ifndef __com_sun_star_ucb_FolderListEntry_idl__
24#define __com_sun_star_ucb_FolderListEntry_idl__
25
26
27//=============================================================================
28
29module com { module sun { module star { module ucb {
30
31//=============================================================================
32/** Information about a single folder in a <type>FolderList</type>.
33*/
34published struct FolderListEntry
35{
36	//-------------------------------------------------------------------------
37	/** The title of the folder.
38	*/
39	string Title;
40
41	//-------------------------------------------------------------------------
42	/** A (unique) identifier for the folder (used by IMAP, where different
43		folders with equal human-readable titles may exist; otherwise, it may
44		be left empty).
45	*/
46	string ID;
47
48	//-------------------------------------------------------------------------
49	/** The foler is subscribed.
50	*/
51	boolean Subscribed;
52
53	//-------------------------------------------------------------------------
54	/** The foler is new.
55	*/
56	boolean New;
57
58	//-------------------------------------------------------------------------
59	/** The foler has been removed.
60	*/
61	boolean Removed;
62
63	//-------------------------------------------------------------------------
64	/** The folder shall be purged (only used in conjunction with the
65		<member>FolderListCommand::SET</member>).
66	*/
67	boolean Purge;
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75