1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
<refentry id="camel-camel-folder-thread">
<refmeta>
<refentrytitle role="top_of_page" id="camel-camel-folder-thread.top_of_page">camel-folder-thread</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>camel-folder-thread</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-camel-folder-thread.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="CamelFolderThreadNode">CamelFolderThreadNode</link>;
<link linkend="CamelFolderThread">CamelFolderThread</link>;
<link linkend="CamelFolderThread">CamelFolderThread</link>* <link linkend="camel-folder-thread-messages-new">camel_folder_thread_messages_new</link> (<link linkend="CamelFolder">CamelFolder</link> *folder,
<link linkend="GPtrArray">GPtrArray</link> *uids,
<link linkend="gboolean">gboolean</link> thread_subject);
<link linkend="void">void</link> <link linkend="camel-folder-thread-messages-apply">camel_folder_thread_messages_apply</link> (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *uids);
<link linkend="CamelFolderThread">CamelFolderThread</link>* <link linkend="camel-folder-thread-messages-new-summary">camel_folder_thread_messages_new_summary</link>
(<link linkend="GPtrArray">GPtrArray</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-thread-messages-add">camel_folder_thread_messages_add</link> (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-thread-messages-remove">camel_folder_thread_messages_remove</link> (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *uids);
<link linkend="void">void</link> <link linkend="camel-folder-thread-messages-ref">camel_folder_thread_messages_ref</link> (<link linkend="CamelFolderThread">CamelFolderThread</link> *threads);
<link linkend="void">void</link> <link linkend="camel-folder-thread-messages-unref">camel_folder_thread_messages_unref</link> (<link linkend="CamelFolderThread">CamelFolderThread</link> *threads);
<link linkend="int">int</link> <link linkend="camel-folder-threaded-messages-dump">camel_folder_threaded_messages_dump</link> (<link linkend="CamelFolderThreadNode">CamelFolderThreadNode</link> *c);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-camel-folder-thread.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-camel-folder-thread.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelFolderThreadNode" role="struct">
<title>CamelFolderThreadNode</title>
<indexterm zone="CamelFolderThreadNode"><primary>CamelFolderThreadNode</primary></indexterm><programlisting>typedef struct {
struct _CamelFolderThreadNode *next, *parent, *child;
const CamelMessageInfo *message;
char *root_subject; /* cached root equivalent subject */
guint32 order:31;
guint32 re:1; /* re version of subject? */
} CamelFolderThreadNode;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelFolderThread" role="struct">
<title>CamelFolderThread</title>
<indexterm zone="CamelFolderThread"><primary>CamelFolderThread</primary></indexterm><programlisting>typedef struct {
guint32 refcount : 31;
guint32 subject : 1;
struct _CamelFolderThreadNode *tree;
struct _EMemChunk *node_chunks;
CamelFolder *folder;
GPtrArray *summary;
} CamelFolderThread;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-folder-thread-messages-new" role="function">
<title>camel_folder_thread_messages_new ()</title>
<indexterm zone="camel-folder-thread-messages-new"><primary>camel_folder_thread_messages_new</primary></indexterm><programlisting><link linkend="CamelFolderThread">CamelFolderThread</link>* camel_folder_thread_messages_new (<link linkend="CamelFolder">CamelFolder</link> *folder,
<link linkend="GPtrArray">GPtrArray</link> *uids,
<link linkend="gboolean">gboolean</link> thread_subject);</programlisting>
<para>
Thread a (subset) of the messages in a folder. And sort the result
in summary order.
</para>
<para>
If <parameter>thread_subject</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, messages with
related subjects will also be threaded. The default behaviour is to
only thread based on message-id.
</para>
<para>
This function is probably to be removed soon.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>folder</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uids</parameter> :</term>
<listitem><simpara> The subset of uid's to thread. If NULL. then thread all
uid's in <parameter>folder</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>thread_subject</parameter> :</term>
<listitem><simpara> thread based on subject also
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-apply" role="function">
<title>camel_folder_thread_messages_apply ()</title>
<indexterm zone="camel-folder-thread-messages-apply"><primary>camel_folder_thread_messages_apply</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_thread_messages_apply (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *uids);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thread</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uids</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-new-summary" role="function">
<title>camel_folder_thread_messages_new_summary ()</title>
<indexterm zone="camel-folder-thread-messages-new-summary"><primary>camel_folder_thread_messages_new_summary</primary></indexterm><programlisting><link linkend="CamelFolderThread">CamelFolderThread</link>* camel_folder_thread_messages_new_summary
(<link linkend="GPtrArray">GPtrArray</link> *summary);</programlisting>
<para>
Thread a list of MessageInfo's. The summary must remain valid for the
life of the CamelFolderThread created by this function, and it is upto the
caller to ensure this.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> Array of CamelMessageInfo's to thread.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-add" role="function">
<title>camel_folder_thread_messages_add ()</title>
<indexterm zone="camel-folder-thread-messages-add"><primary>camel_folder_thread_messages_add</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_thread_messages_add (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *summary);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thread</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-remove" role="function">
<title>camel_folder_thread_messages_remove ()</title>
<indexterm zone="camel-folder-thread-messages-remove"><primary>camel_folder_thread_messages_remove</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_thread_messages_remove (<link linkend="CamelFolderThread">CamelFolderThread</link> *thread,
<link linkend="GPtrArray">GPtrArray</link> *uids);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>thread</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uids</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-ref" role="function">
<title>camel_folder_thread_messages_ref ()</title>
<indexterm zone="camel-folder-thread-messages-ref"><primary>camel_folder_thread_messages_ref</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_thread_messages_ref (<link linkend="CamelFolderThread">CamelFolderThread</link> *threads);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>threads</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-thread-messages-unref" role="function">
<title>camel_folder_thread_messages_unref ()</title>
<indexterm zone="camel-folder-thread-messages-unref"><primary>camel_folder_thread_messages_unref</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_thread_messages_unref (<link linkend="CamelFolderThread">CamelFolderThread</link> *threads);</programlisting>
<para>
Free all memory associated with the thread descriptor <parameter>thread</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>threads</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-threaded-messages-dump" role="function">
<title>camel_folder_threaded_messages_dump ()</title>
<indexterm zone="camel-folder-threaded-messages-dump"><primary>camel_folder_threaded_messages_dump</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_threaded_messages_dump (<link linkend="CamelFolderThreadNode">CamelFolderThreadNode</link> *c);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>c</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
