libgmime-3.0-doc 3.2.0-1 / usr / share / gtk-doc / html / gmime-3.2 / GMimeMessagePartial.html

This file is indexed.

/usr/share/gtk-doc/html/gmime-3.2/GMimeMessagePartial.html is in libgmime-3.0-doc 3.2.0-1.

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>GMimeMessagePartial: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
<link rel="prev" href="GMimeMessagePart.html" title="GMimeMessagePart">
<link rel="next" href="gmime-GMimePartIter.html" title="GMimePartIter">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><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="#GMimeMessagePartial.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeMessagePartial.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="MimeParts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeMessagePart.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gmime-GMimePartIter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeMessagePartial"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeMessagePartial.top_of_page"></a>GMimeMessagePartial</span></h2>
<p>GMimeMessagePartial — Partial MIME parts</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeMessagePartial.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-new" title="g_mime_message_partial_new ()">g_mime_message_partial_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-id" title="g_mime_message_partial_get_id ()">g_mime_message_partial_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-number" title="g_mime_message_partial_get_number ()">g_mime_message_partial_get_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-total" title="g_mime_message_partial_get_total ()">g_mime_message_partial_get_total</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-reconstruct-message" title="g_mime_message_partial_reconstruct_message ()">g_mime_message_partial_reconstruct_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> **
</td>
<td class="function_name">
<a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-split-message" title="g_mime_message_partial_split_message ()">g_mime_message_partial_split_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeMessagePartial.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeMessagePartial.html#GMimeMessagePartial-struct" title="struct GMimeMessagePartial">GMimeMessagePartial</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeMessagePartial.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
        <span class="lineart">╰──</span> <a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a>
            <span class="lineart">╰──</span> GMimeMessagePartial
</pre>
</div>
<div class="refsect1">
<a name="GMimeMessagePartial.description"></a><h2>Description</h2>
<p>A <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> represents the message/partial MIME part.</p>
</div>
<div class="refsect1">
<a name="GMimeMessagePartial.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-message-partial-new"></a><h3>g_mime_message_partial_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> *
g_mime_message_partial_new (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>,
                            <em class="parameter"><code><span class="type">int</span> number</code></em>,
                            <em class="parameter"><code><span class="type">int</span> total</code></em>);</pre>
<p>Creates a new MIME message/partial object.</p>
<div class="refsect3">
<a name="g-mime-message-partial-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>id</p></td>
<td class="parameter_description"><p>message/partial part id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>number</p></td>
<td class="parameter_description"><p>message/partial part number</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>total</p></td>
<td class="parameter_description"><p>total number of message/partial parts</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-new.returns"></a><h4>Returns</h4>
<p> an empty MIME message/partial object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-message-partial-get-id"></a><h3>g_mime_message_partial_get_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
g_mime_message_partial_get_id (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
<p>Gets the message/partial id parameter value.</p>
<div class="refsect3">
<a name="g-mime-message-partial-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>partial</p></td>
<td class="parameter_description"><p>message/partial object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-get-id.returns"></a><h4>Returns</h4>
<p> the message/partial id or <code class="literal">NULL</code> on fail.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-message-partial-get-number"></a><h3>g_mime_message_partial_get_number ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
g_mime_message_partial_get_number (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
<p>Gets the message/partial part number.</p>
<div class="refsect3">
<a name="g-mime-message-partial-get-number.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>partial</p></td>
<td class="parameter_description"><p>message/partial object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-get-number.returns"></a><h4>Returns</h4>
<p> the message/partial part number or <code class="literal">-1</code> on fail.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-message-partial-get-total"></a><h3>g_mime_message_partial_get_total ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
g_mime_message_partial_get_total (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
<p>Gets the total number of message/partial parts needed to
reconstruct the original message.</p>
<div class="refsect3">
<a name="g-mime-message-partial-get-total.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>partial</p></td>
<td class="parameter_description"><p>message/partial object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-get-total.returns"></a><h4>Returns</h4>
<p> the total number of message/partial parts needed to
reconstruct the original message or -1 on fail.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-message-partial-reconstruct-message"></a><h3>g_mime_message_partial_reconstruct_message ()</h3>
<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *
g_mime_message_partial_reconstruct_message
                               (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> **partials</code></em>,
                                <em class="parameter"><code><span class="type">size_t</span> num</code></em>);</pre>
<p>Reconstructs the GMimeMessage from the given message/partial parts
in <em class="parameter"><code>partials</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-message-partial-reconstruct-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>partials</p></td>
<td class="parameter_description"><p>an array of message/partial mime parts</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num</p></td>
<td class="parameter_description"><p>the number of elements in <em class="parameter"><code>partials</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-reconstruct-message.returns"></a><h4>Returns</h4>
<p> a GMimeMessage object on success or <code class="literal">NULL</code>
on fail. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-message-partial-split-message"></a><h3>g_mime_message_partial_split_message ()</h3>
<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> **
g_mime_message_partial_split_message (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
                                      <em class="parameter"><code><span class="type">size_t</span> max_size</code></em>,
                                      <em class="parameter"><code><span class="type">size_t</span> *nparts</code></em>);</pre>
<p>Splits <em class="parameter"><code>message</code></em>
 into an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects each
containing a single <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> object containing
<em class="parameter"><code>max_size</code></em>
 bytes or fewer. <em class="parameter"><code>nparts</code></em>
 is set to the number of
<a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> objects created.</p>
<div class="refsect3">
<a name="g-mime-message-partial-split-message.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>message</p></td>
<td class="parameter_description"><p>message object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_size</p></td>
<td class="parameter_description"><p>max size</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nparts</p></td>
<td class="parameter_description"><p> number of parts. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-message-partial-split-message.returns"></a><h4>Returns</h4>
<p> an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects and
sets <em class="parameter"><code>nparts</code></em>
to the number of messages returned or <code class="literal">NULL</code> on fail. </p>
<p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeMessagePartial.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeMessagePartial-struct"></a><h3>struct GMimeMessagePartial</h3>
<pre class="programlisting">struct GMimeMessagePartial;</pre>
<p>A message/partial MIME part.</p>
<div class="refsect3">
<a name="GMimeMessagePartial.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.