This file is indexed.

/usr/share/gtk-doc/html/camel/CamelFolderSearch.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelFolderSearch</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="CamelFolder.html" title="CamelFolder">
<link rel="next" href="CamelFolderSummary.html" title="CamelFolderSummary">
<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="CamelFolder.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="CamelFolderSummary.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelFolderSearch.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#CamelFolderSearch.description" class="shortcut">Description</a>
                   | 
                  <a href="#CamelFolderSearch.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelFolderSearch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelFolderSearch.top_of_page"></a>CamelFolderSearch</span></h2>
<p>CamelFolderSearch</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelFolderSearch.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="CamelFolderSearch.html#CamelFolderSearch-struct" title="struct CamelFolderSearch">CamelFolderSearch</a>;
<a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="returnvalue">CamelFolderSearch</span></a> * <a class="link" href="CamelFolderSearch.html#camel-folder-search-new" title="camel_folder_search_new ()">camel_folder_search_new</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelFolderSearch.html#camel-folder-search-construct" title="camel_folder_search_construct ()">camel_folder_search_construct</a>       (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelFolderSearch.html#camel-folder-search-set-folder" title="camel_folder_search_set_folder ()">camel_folder_search_set_folder</a>      (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelFolderSearch.html#camel-folder-search-set-summary" title="camel_folder_search_set_summary ()">camel_folder_search_set_summary</a>     (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelFolderSearch.html#camel-folder-search-set-body-index" title="camel_folder_search_set_body_index ()">camel_folder_search_set_body_index</a>  (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelIndex.html" title="CamelIndex"><span class="type">CamelIndex</span></a> *index</code></em>);
<span class="returnvalue">GPtrArray</span> *         <a class="link" href="CamelFolderSearch.html#camel-folder-search-execute-expression" title="camel_folder_search_execute_expression ()">camel_folder_search_execute_expression</a>
                                                        (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GPtrArray</span> *         <a class="link" href="CamelFolderSearch.html#camel-folder-search-search" title="camel_folder_search_search ()">camel_folder_search_search</a>          (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">guint32</span>             <a class="link" href="CamelFolderSearch.html#camel-folder-search-count" title="camel_folder_search_count ()">camel_folder_search_count</a>           (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CamelFolderSearch.html#camel-folder-search-free-result" title="camel_folder_search_free_result ()">camel_folder_search_free_result</a>     (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *Param2</code></em>);
<span class="returnvalue">time_t</span>              <a class="link" href="CamelFolderSearch.html#camel-folder-search-util-add-months" title="camel_folder_search_util_add_months ()">camel_folder_search_util_add_months</a> (<em class="parameter"><code><span class="type">time_t</span> t</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> months</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelFolderSearch.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
         +----CamelFolderSearch
</pre>
</div>
<div class="refsect1">
<a name="CamelFolderSearch.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelFolderSearch.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelFolderSearch-struct"></a><h3>struct CamelFolderSearch</h3>
<pre class="programlisting">struct CamelFolderSearch;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-new"></a><h3>camel_folder_search_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="returnvalue">CamelFolderSearch</span></a> * camel_folder_search_new             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new CamelFolderSearch object.
</p>
<p>
A CamelFolderSearch is a subclassable, extensible s-exp
evaluator which enforces a particular set of s-expressions.
Particular methods may be overriden by an implementation to
implement a search for any sort of backend.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new CamelFolderSearch widget.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-construct"></a><h3>camel_folder_search_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_search_construct       (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-set-folder"></a><h3>camel_folder_search_set_folder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_search_set_folder      (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>);</pre>
<p>
Set the folder attribute of the search.  This is currently unused, but
could be used to perform a slow-search when indexes and so forth are not
available.  Or for use by subclasses.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
<td>A folder.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-set-summary"></a><h3>camel_folder_search_set_summary ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_search_set_summary     (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *summary</code></em>);</pre>
<p>
Set the array of summary objects representing the span of the search.
</p>
<p>
If this is not set, then a subclass must provide the functions
for searching headers and for the match-all operator.
</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>An array of CamelMessageInfo pointers.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-set-body-index"></a><h3>camel_folder_search_set_body_index ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_search_set_body_index  (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><a class="link" href="CamelIndex.html" title="CamelIndex"><span class="type">CamelIndex</span></a> *index</code></em>);</pre>
<p>
Set the index representing the contents of all messages
in this folder.  If this is not set, then the folder implementation
should sub-class the CamelFolderSearch and provide its own
body-contains function.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-execute-expression"></a><h3>camel_folder_search_execute_expression ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> *         camel_folder_search_execute_expression
                                                        (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Execute the search expression <em class="parameter"><code>expr</code></em>, returning an array of
all matches as a GPtrArray of uid's of matching messages.
</p>
<p>
Note that any settings such as <code class="function">set_body_index()</code>, <code class="function">set_folder()</code>,
and so on are reset to <code class="literal">NULL</code> once the search has completed.
</p>
<p>
TODO: The interface should probably return summary items instead
(since they are much more useful to any client).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A GPtrArray of strings of all matching messages.
This must only be freed by camel_folder_search_free_result.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-search"></a><h3>camel_folder_search_search ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> *         camel_folder_search_search          (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Run a search.  Search must have had Folder already set on it, and
it must implement summaries.
</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>to search against, NULL for all uid's.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-count"></a><h3>camel_folder_search_count ()</h3>
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_folder_search_count           (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *expr</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Run a search.  Search must have had Folder already set on it, and
it must implement summaries.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Number of messages that match the query.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-free-result"></a><h3>camel_folder_search_free_result ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_folder_search_free_result     (<em class="parameter"><code><a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch"><span class="type">CamelFolderSearch</span></a> *search</code></em>,
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> *Param2</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-folder-search-util-add-months"></a><h3>camel_folder_search_util_add_months ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span>              camel_folder_search_util_add_months (<em class="parameter"><code><span class="type">time_t</span> t</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> months</code></em>);</pre>
<p>
Increases time <em class="parameter"><code>t</code></em> by the given number of months (or decreases, if
<em class="parameter"><code>months</code></em> is negative).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
<td>Initial time</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>months</code></em> :</span></p></td>
<td>number of months to add or subtract</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <span class="type">time_t</span> value</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>