54
54
</tr></table></div>
55
55
<div class="refsynopsisdiv">
56
56
<a name="camel-CamelStore.synopsis"></a><h2>Synopsis</h2>
57
<pre class="synopsis">struct <a class="link" href="camel-CamelStore.html#CamelStore" title="struct CamelStore">CamelStore</a>;
57
<pre class="synopsis">
58
struct <a class="link" href="camel-CamelStore.html#CamelStore" title="struct CamelStore">CamelStore</a>;
58
59
<a class="link" href="camel-CamelStore.html#CamelFolderInfo" title="CamelFolderInfo">CamelFolderInfo</a>;
59
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOSELECT:CAPS" title="CAMEL_FOLDER_NOSELECT">CAMEL_FOLDER_NOSELECT</a>
60
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOINFERIORS:CAPS" title="CAMEL_FOLDER_NOINFERIORS">CAMEL_FOLDER_NOINFERIORS</a>
61
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-CHILDREN:CAPS" title="CAMEL_FOLDER_CHILDREN">CAMEL_FOLDER_CHILDREN</a>
62
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOCHILDREN:CAPS" title="CAMEL_FOLDER_NOCHILDREN">CAMEL_FOLDER_NOCHILDREN</a>
63
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SUBSCRIBED:CAPS" title="CAMEL_FOLDER_SUBSCRIBED">CAMEL_FOLDER_SUBSCRIBED</a>
64
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-VIRTUAL:CAPS" title="CAMEL_FOLDER_VIRTUAL">CAMEL_FOLDER_VIRTUAL</a>
65
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SYSTEM:CAPS" title="CAMEL_FOLDER_SYSTEM">CAMEL_FOLDER_SYSTEM</a>
66
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-VTRASH:CAPS" title="CAMEL_FOLDER_VTRASH">CAMEL_FOLDER_VTRASH</a>
67
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SHARED-TO-ME:CAPS" title="CAMEL_FOLDER_SHARED_TO_ME">CAMEL_FOLDER_SHARED_TO_ME</a>
68
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SHARED-BY-ME:CAPS" title="CAMEL_FOLDER_SHARED_BY_ME">CAMEL_FOLDER_SHARED_BY_ME</a>
69
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-MASK:CAPS" title="CAMEL_FOLDER_TYPE_MASK">CAMEL_FOLDER_TYPE_MASK</a>
70
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-BIT:CAPS" title="CAMEL_FOLDER_TYPE_BIT">CAMEL_FOLDER_TYPE_BIT</a>
71
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-NORMAL:CAPS" title="CAMEL_FOLDER_TYPE_NORMAL">CAMEL_FOLDER_TYPE_NORMAL</a>
72
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-INBOX:CAPS" title="CAMEL_FOLDER_TYPE_INBOX">CAMEL_FOLDER_TYPE_INBOX</a>
73
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-OUTBOX:CAPS" title="CAMEL_FOLDER_TYPE_OUTBOX">CAMEL_FOLDER_TYPE_OUTBOX</a>
74
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-TRASH:CAPS" title="CAMEL_FOLDER_TYPE_TRASH">CAMEL_FOLDER_TYPE_TRASH</a>
75
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-JUNK:CAPS" title="CAMEL_FOLDER_TYPE_JUNK">CAMEL_FOLDER_TYPE_JUNK</a>
76
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-SENT:CAPS" title="CAMEL_FOLDER_TYPE_SENT">CAMEL_FOLDER_TYPE_SENT</a>
77
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-READ:CAPS" title="CAMEL_STORE_READ">CAMEL_STORE_READ</a>
78
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-WRITE:CAPS" title="CAMEL_STORE_WRITE">CAMEL_STORE_WRITE</a>
60
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOSELECT--CAPS" title="CAMEL_FOLDER_NOSELECT">CAMEL_FOLDER_NOSELECT</a>
61
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOINFERIORS--CAPS" title="CAMEL_FOLDER_NOINFERIORS">CAMEL_FOLDER_NOINFERIORS</a>
62
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-CHILDREN--CAPS" title="CAMEL_FOLDER_CHILDREN">CAMEL_FOLDER_CHILDREN</a>
63
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-NOCHILDREN--CAPS" title="CAMEL_FOLDER_NOCHILDREN">CAMEL_FOLDER_NOCHILDREN</a>
64
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SUBSCRIBED--CAPS" title="CAMEL_FOLDER_SUBSCRIBED">CAMEL_FOLDER_SUBSCRIBED</a>
65
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-VIRTUAL--CAPS" title="CAMEL_FOLDER_VIRTUAL">CAMEL_FOLDER_VIRTUAL</a>
66
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SYSTEM--CAPS" title="CAMEL_FOLDER_SYSTEM">CAMEL_FOLDER_SYSTEM</a>
67
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-VTRASH--CAPS" title="CAMEL_FOLDER_VTRASH">CAMEL_FOLDER_VTRASH</a>
68
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SHARED-TO-ME--CAPS" title="CAMEL_FOLDER_SHARED_TO_ME">CAMEL_FOLDER_SHARED_TO_ME</a>
69
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-SHARED-BY-ME--CAPS" title="CAMEL_FOLDER_SHARED_BY_ME">CAMEL_FOLDER_SHARED_BY_ME</a>
70
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-MASK--CAPS" title="CAMEL_FOLDER_TYPE_MASK">CAMEL_FOLDER_TYPE_MASK</a>
71
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-BIT--CAPS" title="CAMEL_FOLDER_TYPE_BIT">CAMEL_FOLDER_TYPE_BIT</a>
72
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-NORMAL--CAPS" title="CAMEL_FOLDER_TYPE_NORMAL">CAMEL_FOLDER_TYPE_NORMAL</a>
73
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-INBOX--CAPS" title="CAMEL_FOLDER_TYPE_INBOX">CAMEL_FOLDER_TYPE_INBOX</a>
74
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-OUTBOX--CAPS" title="CAMEL_FOLDER_TYPE_OUTBOX">CAMEL_FOLDER_TYPE_OUTBOX</a>
75
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-TRASH--CAPS" title="CAMEL_FOLDER_TYPE_TRASH">CAMEL_FOLDER_TYPE_TRASH</a>
76
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-JUNK--CAPS" title="CAMEL_FOLDER_TYPE_JUNK">CAMEL_FOLDER_TYPE_JUNK</a>
77
#define <a class="link" href="camel-CamelStore.html#CAMEL-FOLDER-TYPE-SENT--CAPS" title="CAMEL_FOLDER_TYPE_SENT">CAMEL_FOLDER_TYPE_SENT</a>
78
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-READ--CAPS" title="CAMEL_STORE_READ">CAMEL_STORE_READ</a>
79
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-WRITE--CAPS" title="CAMEL_STORE_WRITE">CAMEL_STORE_WRITE</a>
79
80
<a class="link" href="camel-CamelStore.html#CamelRenameInfo" title="CamelRenameInfo">CamelRenameInfo</a>;
80
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-SUBSCRIPTIONS:CAPS" title="CAMEL_STORE_SUBSCRIPTIONS">CAMEL_STORE_SUBSCRIPTIONS</a>
81
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-VTRASH:CAPS" title="CAMEL_STORE_VTRASH">CAMEL_STORE_VTRASH</a>
82
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FILTER-INBOX:CAPS" title="CAMEL_STORE_FILTER_INBOX">CAMEL_STORE_FILTER_INBOX</a>
83
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-VJUNK:CAPS" title="CAMEL_STORE_VJUNK">CAMEL_STORE_VJUNK</a>
84
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-PROXY:CAPS" title="CAMEL_STORE_PROXY">CAMEL_STORE_PROXY</a>
85
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-IS-MIGRATING:CAPS" title="CAMEL_STORE_IS_MIGRATING">CAMEL_STORE_IS_MIGRATING</a>
86
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-CREATE:CAPS" title="CAMEL_STORE_FOLDER_CREATE">CAMEL_STORE_FOLDER_CREATE</a>
87
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-EXCL:CAPS" title="CAMEL_STORE_FOLDER_EXCL">CAMEL_STORE_FOLDER_EXCL</a>
88
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-BODY-INDEX:CAPS" title="CAMEL_STORE_FOLDER_BODY_INDEX">CAMEL_STORE_FOLDER_BODY_INDEX</a>
89
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-PRIVATE:CAPS" title="CAMEL_STORE_FOLDER_PRIVATE">CAMEL_STORE_FOLDER_PRIVATE</a>
90
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-CREATE-EXCL:CAPS" title="CAMEL_STORE_FOLDER_CREATE_EXCL">CAMEL_STORE_FOLDER_CREATE_EXCL</a>
91
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-FAST:CAPS" title="CAMEL_STORE_FOLDER_INFO_FAST">CAMEL_STORE_FOLDER_INFO_FAST</a>
92
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-RECURSIVE:CAPS" title="CAMEL_STORE_FOLDER_INFO_RECURSIVE">CAMEL_STORE_FOLDER_INFO_RECURSIVE</a>
93
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIBED:CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIBED">CAMEL_STORE_FOLDER_INFO_SUBSCRIBED</a>
94
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-NO-VIRTUAL:CAPS" title="CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL">CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL</a>
95
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIPTION-LIST:CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIPTION_LIST">CAMEL_STORE_FOLDER_INFO_SUBSCRIPTION_LIST</a>
81
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-SUBSCRIPTIONS--CAPS" title="CAMEL_STORE_SUBSCRIPTIONS">CAMEL_STORE_SUBSCRIPTIONS</a>
82
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-VTRASH--CAPS" title="CAMEL_STORE_VTRASH">CAMEL_STORE_VTRASH</a>
83
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FILTER-INBOX--CAPS" title="CAMEL_STORE_FILTER_INBOX">CAMEL_STORE_FILTER_INBOX</a>
84
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-VJUNK--CAPS" title="CAMEL_STORE_VJUNK">CAMEL_STORE_VJUNK</a>
85
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-PROXY--CAPS" title="CAMEL_STORE_PROXY">CAMEL_STORE_PROXY</a>
86
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-IS-MIGRATING--CAPS" title="CAMEL_STORE_IS_MIGRATING">CAMEL_STORE_IS_MIGRATING</a>
87
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-CREATE--CAPS" title="CAMEL_STORE_FOLDER_CREATE">CAMEL_STORE_FOLDER_CREATE</a>
88
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-EXCL--CAPS" title="CAMEL_STORE_FOLDER_EXCL">CAMEL_STORE_FOLDER_EXCL</a>
89
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-BODY-INDEX--CAPS" title="CAMEL_STORE_FOLDER_BODY_INDEX">CAMEL_STORE_FOLDER_BODY_INDEX</a>
90
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-PRIVATE--CAPS" title="CAMEL_STORE_FOLDER_PRIVATE">CAMEL_STORE_FOLDER_PRIVATE</a>
91
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-CREATE-EXCL--CAPS" title="CAMEL_STORE_FOLDER_CREATE_EXCL">CAMEL_STORE_FOLDER_CREATE_EXCL</a>
92
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-FAST--CAPS" title="CAMEL_STORE_FOLDER_INFO_FAST">CAMEL_STORE_FOLDER_INFO_FAST</a>
93
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-RECURSIVE--CAPS" title="CAMEL_STORE_FOLDER_INFO_RECURSIVE">CAMEL_STORE_FOLDER_INFO_RECURSIVE</a>
94
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIBED--CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIBED">CAMEL_STORE_FOLDER_INFO_SUBSCRIBED</a>
95
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-NO-VIRTUAL--CAPS" title="CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL">CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL</a>
96
#define <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIPTION-LIST--CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIPTION_LIST">CAMEL_STORE_FOLDER_INFO_SUBSCRIPTION_LIST</a>
96
97
<a class="link" href="camel-CamelFolder.html#CamelFolder" title="struct CamelFolder">CamelFolder</a> * <a class="link" href="camel-CamelStore.html#camel-store-get-folder" title="camel_store_get_folder ()">camel_store_get_folder</a> (<a class="link" href="camel-CamelStore.html#CamelStore" title="struct CamelStore">CamelStore</a> *store,
97
98
const gchar *folder_name,
780
803
This fetches information about the folder structure of <em class="parameter"><code>store</code></em>,
781
804
starting with <em class="parameter"><code>top</code></em>, and returns a tree of CamelFolderInfo
782
structures. If <em class="parameter"><code>flags</code></em> includes <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIBED:CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIBED"><span class="type">CAMEL_STORE_FOLDER_INFO_SUBSCRIBED</span></a>,
805
structures. If <em class="parameter"><code>flags</code></em> includes <a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-SUBSCRIBED--CAPS" title="CAMEL_STORE_FOLDER_INFO_SUBSCRIBED"><span class="type">CAMEL_STORE_FOLDER_INFO_SUBSCRIBED</span></a>,
783
806
only subscribed folders will be listed. If the store doesn't support
784
807
subscriptions, then it will list all folders. If <em class="parameter"><code>flags</code></em> includes
785
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-RECURSIVE:CAPS" title="CAMEL_STORE_FOLDER_INFO_RECURSIVE"><span class="type">CAMEL_STORE_FOLDER_INFO_RECURSIVE</span></a>, the returned tree will include
808
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-RECURSIVE--CAPS" title="CAMEL_STORE_FOLDER_INFO_RECURSIVE"><span class="type">CAMEL_STORE_FOLDER_INFO_RECURSIVE</span></a>, the returned tree will include
786
809
all levels of hierarchy below <em class="parameter"><code>top</code></em>. If not, it will only include
787
810
the immediate subfolders of <em class="parameter"><code>top</code></em>. If <em class="parameter"><code>flags</code></em> includes
788
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-FAST:CAPS" title="CAMEL_STORE_FOLDER_INFO_FAST"><span class="type">CAMEL_STORE_FOLDER_INFO_FAST</span></a>, the unread_message_count fields of
811
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-FAST--CAPS" title="CAMEL_STORE_FOLDER_INFO_FAST"><span class="type">CAMEL_STORE_FOLDER_INFO_FAST</span></a>, the unread_message_count fields of
789
812
some or all of the structures may be set to <code class="literal">-1</code>, if the store cannot
790
813
determine that information quickly. If <em class="parameter"><code>flags</code></em> includes
791
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-NO-VIRTUAL:CAPS" title="CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL"><span class="type">CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL</span></a>, don't include special virtual
814
<a class="link" href="camel-CamelStore.html#CAMEL-STORE-FOLDER-INFO-NO-VIRTUAL--CAPS" title="CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL"><span class="type">CAMEL_STORE_FOLDER_INFO_NO_VIRTUAL</span></a>, don't include special virtual
792
815
folders (such as vTrash or vJunk).