libgmime-2.6-doc 2.6.20-0ubuntu1 / usr / share / gtk-doc / html / gmime-2.6 / gmime-gmime.html

This file is indexed.

/usr/share/gtk-doc/html/gmime-2.6/gmime-gmime.html is in libgmime-2.6-doc 2.6.20-0ubuntu1.

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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMime 2.6 Reference Manual: gmime</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
<link rel="up" href="core.html" title="Part III. GMime Core Reference">
<link rel="prev" href="core.html" title="Part III. GMime Core Reference">
<link rel="next" href="gmime-gmime-charset.html" title="gmime-charset">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#gmime-gmime.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#gmime-gmime.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="core.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gmime-gmime-charset.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-gmime"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-gmime.top_of_page"></a>gmime</span></h2>
<p>gmime — Initialization, shutdown and version-check routines</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-gmime.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS" title="GMIME_MAJOR_VERSION">GMIME_MAJOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MICRO-VERSION:CAPS" title="GMIME_MICRO_VERSION">GMIME_MICRO_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MINOR-VERSION:CAPS" title="GMIME_MINOR_VERSION">GMIME_MINOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-BINARY-AGE:CAPS" title="GMIME_BINARY_AGE">GMIME_BINARY_AGE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS" title="GMIME_INTERFACE_AGE">GMIME_INTERFACE_AGE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#GMIME-CHECK-VERSION:CAPS" title="GMIME_CHECK_VERSION()">GMIME_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS" title="GMIME_ENABLE_RFC2047_WORKAROUNDS">GMIME_ENABLE_RFC2047_WORKAROUNDS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS" title="GMIME_ENABLE_USE_ONLY_USER_CHARSETS">GMIME_ENABLE_USE_ONLY_USER_CHARSETS</a></td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()">g_mime_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-shutdown" title="g_mime_shutdown ()">g_mime_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-check-version" title="g_mime_check_version ()">g_mime_check_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-gmime.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-major-version" title="gmime_major_version">gmime_major_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-minor-version" title="gmime_minor_version">gmime_minor_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-micro-version" title="gmime_micro_version">gmime_micro_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-binary-age" title="gmime_binary_age">gmime_binary_age</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-interface-age" title="gmime_interface_age">gmime_interface_age</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-gmime.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="gmime-gmime.description"></a><h2>Description</h2>
<p>Initialization, shutdown, and version-check functions.</p>
</div>
<div class="refsect1">
<a name="gmime-gmime.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GMIME-MAJOR-VERSION:CAPS"></a><h3>GMIME_MAJOR_VERSION</h3>
<pre class="programlisting">#define GMIME_MAJOR_VERSION (2)
</pre>
<p>GMime's major version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-MICRO-VERSION:CAPS"></a><h3>GMIME_MICRO_VERSION</h3>
<pre class="programlisting">#define GMIME_MICRO_VERSION (20)
</pre>
<p>GMime's micro version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-MINOR-VERSION:CAPS"></a><h3>GMIME_MINOR_VERSION</h3>
<pre class="programlisting">#define GMIME_MINOR_VERSION (6)
</pre>
<p>GMime's minor version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-BINARY-AGE:CAPS"></a><h3>GMIME_BINARY_AGE</h3>
<pre class="programlisting">#define GMIME_BINARY_AGE    (620)
</pre>
<p>GMime's binary age.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-INTERFACE-AGE:CAPS"></a><h3>GMIME_INTERFACE_AGE</h3>
<pre class="programlisting">#define GMIME_INTERFACE_AGE (0)
</pre>
<p>GMime's interface age.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-CHECK-VERSION:CAPS"></a><h3>GMIME_CHECK_VERSION()</h3>
<pre class="programlisting">#define             GMIME_CHECK_VERSION(major,minor,micro)</pre>
<p>Check whether a GMime version equal to or greater than
<em class="parameter"><code>major</code></em>
.<em class="parameter"><code>minor</code></em>
.<em class="parameter"><code>micro</code></em>
 is present.</p>
<div class="refsect3">
<a name="id-1.4.2.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>Minimum major version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>Minimum minor version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>Minimum micro version</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS"></a><h3>GMIME_ENABLE_RFC2047_WORKAROUNDS</h3>
<pre class="programlisting">#define GMIME_ENABLE_RFC2047_WORKAROUNDS     (1 &lt;&lt; 0)
</pre>
<p>Initialization flag to enable workarounds for badly formed rfc2047
encoded-words.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS"></a><h3>GMIME_ENABLE_USE_ONLY_USER_CHARSETS</h3>
<pre class="programlisting">#define GMIME_ENABLE_USE_ONLY_USER_CHARSETS  (1 &lt;&lt; 1)
</pre>
<p>Initialization flag that hints to the rfc2047 encoder to use only
the configured user-charsets (set via <a class="link" href="gmime-gmime-charset.html#g-mime-set-user-charsets" title="g_mime_set_user_charsets ()"><code class="function">g_mime_set_user_charsets()</code></a>)
instead of trying to first use iso-8859-1.</p>
<p class="since">Since 2.6.16</p>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-init"></a><h3>g_mime_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_init (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
<p>Initializes GMime.</p>
<p>Note: Calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()"><code class="function">g_mime_charset_map_init()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-init" title="g_mime_iconv_init ()"><code class="function">g_mime_iconv_init()</code></a> as
well.</p>
<div class="refsect3">
<a name="id-1.4.2.7.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>initialization flags</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-shutdown"></a><h3>g_mime_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Frees internally allocated tables created in <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a>. Also
calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-shutdown" title="g_mime_charset_map_shutdown ()"><code class="function">g_mime_charset_map_shutdown()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-shutdown" title="g_mime_iconv_shutdown ()"><code class="function">g_mime_iconv_shutdown()</code></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-check-version"></a><h3>g_mime_check_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_check_version (<em class="parameter"><code><span class="type">guint</span> major</code></em>,
                      <em class="parameter"><code><span class="type">guint</span> minor</code></em>,
                      <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre>
<p>Checks that the GMime library version meets the requirements of the
required version.</p>
<div class="refsect3">
<a name="id-1.4.2.7.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>Minimum major version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>Minimum minor version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>Minimum micro version</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.7.12.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the requirement is met or <code class="literal">FALSE</code> otherwise.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-gmime.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="gmime-major-version"></a><h3>gmime_major_version</h3>
<pre class="programlisting">extern const guint gmime_major_version;
</pre>
<p>GMime's major version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-minor-version"></a><h3>gmime_minor_version</h3>
<pre class="programlisting">extern const guint gmime_minor_version;
</pre>
<p>GMime's minor version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-micro-version"></a><h3>gmime_micro_version</h3>
<pre class="programlisting">extern const guint gmime_micro_version;
</pre>
<p>GMime's micro version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-binary-age"></a><h3>gmime_binary_age</h3>
<pre class="programlisting">extern const guint gmime_binary_age;
</pre>
<p>GMime's binary age.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-interface-age"></a><h3>gmime_interface_age</h3>
<pre class="programlisting">extern const guint gmime_interface_age;
</pre>
<p>GMime's interface age.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.