This file is indexed.

/usr/share/gtk-doc/html/camel/camel-camel-folder-thread.html is in libcamel1.2-dev 3.2.3-0ubuntu6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-folder-thread</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Folders.html" title="Folders">
<link rel="prev" href="CamelFolderSummary.html" title="CamelFolderSummary">
<link rel="next" href="CamelOfflineFolder.html" title="CamelOfflineFolder">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelFolderSummary.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Folders.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelOfflineFolder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-folder-thread.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#camel-camel-folder-thread.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-camel-folder-thread"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-folder-thread.top_of_page"></a>camel-folder-thread</span></h2>
<p>camel-folder-thread</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-folder-thread.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode">CamelFolderThreadNode</a>;
                    <a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread">CamelFolderThread</a>;
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="returnvalue">CamelFolderThread</span></a> * <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-new" title="camel_folder_thread_messages_new ()">camel_folder_thread_messages_new</a>    (<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> thread_subject</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-apply" title="camel_folder_thread_messages_apply ()">camel_folder_thread_messages_apply</a>  (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);
<a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="returnvalue">CamelFolderThread</span></a> * <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-new-summary" title="camel_folder_thread_messages_new_summary ()">camel_folder_thread_messages_new_summary</a>
                                                        (<em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-add" title="camel_folder_thread_messages_add ()">camel_folder_thread_messages_add</a>    (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-remove" title="camel_folder_thread_messages_remove ()">camel_folder_thread_messages_remove</a> (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-ref" title="camel_folder_thread_messages_ref ()">camel_folder_thread_messages_ref</a>    (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-thread-messages-unref" title="camel_folder_thread_messages_unref ()">camel_folder_thread_messages_unref</a>  (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>);
<span class="returnvalue">gint</span>                <a class="link" href="camel-camel-folder-thread.html#camel-folder-threaded-messages-dump" title="camel_folder_threaded_messages_dump ()">camel_folder_threaded_messages_dump</a> (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode"><span class="type">CamelFolderThreadNode</span></a> *c</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-folder-thread.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-folder-thread.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelFolderThreadNode"></a><h3>CamelFolderThreadNode</h3>
<pre class="programlisting">typedef struct {
	struct _CamelFolderThreadNode *next, *parent, *child;
	const CamelMessageInfo *message;
	gchar *root_subject; /* cached root equivalent subject */
	guint32 order : 31;
	guint32 re:1;			/* re version of subject? */
} CamelFolderThreadNode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelFolderThread"></a><h3>CamelFolderThread</h3>
<pre class="programlisting">typedef struct {
	guint32 refcount  : 31;
	guint32 subject   : 1;

	struct _CamelFolderThreadNode *tree;
	struct _EMemChunk *node_chunks;
	CamelFolder *folder;
	GPtrArray *summary;
} CamelFolderThread;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-new"></a><h3>camel_folder_thread_messages_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="returnvalue">CamelFolderThread</span></a> * camel_folder_thread_messages_new    (<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> thread_subject</code></em>);</pre>
<p>
Thread a (subset) of the messages in a folder.  And sort the result
in summary order.
</p>
<p>
If <em class="parameter"><code>thread_subject</code></em> is <code class="literal">TRUE</code>, messages with
related subjects will also be threaded. The default behaviour is to
only thread based on message-id.
</p>
<p>
This function is probably to be removed soon.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>The subset of uid's to thread.  If NULL. then thread all
uid's in <em class="parameter"><code>folder</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread_subject</code></em> :</span></p></td>
<td>thread based on subject also</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-apply"></a><h3>camel_folder_thread_messages_apply ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_thread_messages_apply  (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-new-summary"></a><h3>camel_folder_thread_messages_new_summary ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="returnvalue">CamelFolderThread</span></a> * camel_folder_thread_messages_new_summary
                                                        (<em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);</pre>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>Array of CamelMessageInfo's to thread.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A CamelFolderThread contianing a tree of CamelFolderThreadNode's
which represent the threaded structure of the messages.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-add"></a><h3>camel_folder_thread_messages_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_thread_messages_add    (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-remove"></a><h3>camel_folder_thread_messages_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_thread_messages_remove (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-ref"></a><h3>camel_folder_thread_messages_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_thread_messages_ref    (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-thread-messages-unref"></a><h3>camel_folder_thread_messages_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_thread_messages_unref  (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThread" title="CamelFolderThread"><span class="type">CamelFolderThread</span></a> *thread</code></em>);</pre>
<p>
Free all memory associated with the thread descriptor <em class="parameter"><code>thread</code></em>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-threaded-messages-dump"></a><h3>camel_folder_threaded_messages_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_folder_threaded_messages_dump (<em class="parameter"><code><a class="link" href="camel-camel-folder-thread.html#CamelFolderThreadNode" title="CamelFolderThreadNode"><span class="type">CamelFolderThreadNode</span></a> *c</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>