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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeParser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
<link rel="up" href="Parsers.html" title="Parsing Messages and MIME Parts">
<link rel="prev" href="Parsers.html" title="Parsing Messages and MIME Parts">
<link rel="next" href="CryptoContexts.html" title="Cryptography Contexts">
<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="Parsers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Parsers.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">GMime 2.6 Reference Manual</th>
<td><a accesskey="n" href="CryptoContexts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GMimeParser.synopsis" class="shortcut">Top</a>
|
<a href="#GMimeParser.description" class="shortcut">Description</a>
|
<a href="#GMimeParser.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GMimeParser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeParser.top_of_page"></a>GMimeParser</span></h2>
<p>GMimeParser — Message and MIME part parser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GMimeParser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GMimeParser.html#GMimeParser-struct" title="struct GMimeParser">GMimeParser</a>;
<span class="returnvalue">void</span> (<a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()">*GMimeParserHeaderRegexFunc</a>) (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>,
<em class="parameter"><code><span class="type">gint64</span> offset</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-new" title="g_mime_parser_new ()">g_mime_parser_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-new-with-stream" title="g_mime_parser_new_with_stream ()">g_mime_parser_new_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-init-with-stream" title="g_mime_parser_init_with_stream ()">g_mime_parser_init_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-persist-stream" title="g_mime_parser_get_persist_stream ()">g_mime_parser_get_persist_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-persist-stream" title="g_mime_parser_set_persist_stream ()">g_mime_parser_set_persist_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> persist</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-scan-from" title="g_mime_parser_get_scan_from ()">g_mime_parser_get_scan_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-scan-from" title="g_mime_parser_set_scan_from ()">g_mime_parser_set_scan_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-respect-content-length" title="g_mime_parser_get_respect_content_length ()">g_mime_parser_get_respect_content_length</a>
(<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-respect-content-length" title="g_mime_parser_set_respect_content_length ()">g_mime_parser_set_respect_content_length</a>
(<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> respect_content_length</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-header-regex" title="g_mime_parser_set_header_regex ()">g_mime_parser_set_header_regex</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *regex</code></em>,
<em class="parameter"><code><a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()"><span class="type">GMimeParserHeaderRegexFunc</span></a> header_cb</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-tell" title="g_mime_parser_tell ()">g_mime_parser_tell</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-eos" title="g_mime_parser_eos ()">g_mime_parser_eos</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-construct-part" title="g_mime_parser_construct_part ()">g_mime_parser_construct_part</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()">g_mime_parser_construct_message</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="GMimeParser.html#g-mime-parser-get-from" title="g_mime_parser_get_from ()">g_mime_parser_get_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-from-offset" title="g_mime_parser_get_from_offset ()">g_mime_parser_get_from_offset</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-headers-begin" title="g_mime_parser_get_headers_begin ()">g_mime_parser_get_headers_begin</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-headers-end" title="g_mime_parser_get_headers_end ()">g_mime_parser_get_headers_end</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GMimeParser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GMimeParser
</pre>
</div>
<div class="refsect1">
<a name="GMimeParser.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> parses a stream into a <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> or other
<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> and can also handle parsing MBox formatted streams
into multiple <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects.
</p>
</div>
<div class="refsect1">
<a name="GMimeParser.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GMimeParser-struct"></a><h3>struct GMimeParser</h3>
<pre class="programlisting">struct GMimeParser;</pre>
<p>
A MIME parser context.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GMimeParserHeaderRegexFunc"></a><h3>GMimeParserHeaderRegexFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GMimeParserHeaderRegexFunc) (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>,
<em class="parameter"><code><span class="type">gint64</span> offset</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Function signature for the callback to
<a class="link" href="GMimeParser.html#g-mime-parser-set-header-regex" title="g_mime_parser_set_header_regex ()"><code class="function">g_mime_parser_set_header_regex()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>The <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td>The header field matched.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The header field value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>The header field offset.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>The user-supplied callback data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-new"></a><h3>g_mime_parser_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * g_mime_parser_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new parser object.
</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 parser object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-new-with-stream"></a><h3>g_mime_parser_new_with_stream ()</h3>
<pre class="programlisting"><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * g_mime_parser_new_with_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
<p>
Creates a new parser object preset to parse <em class="parameter"><code>stream</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>raw message or part stream</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new parser object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-init-with-stream"></a><h3>g_mime_parser_init_with_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_init_with_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
<p>
Initializes <em class="parameter"><code>parser</code></em> to use <em class="parameter"><code>stream</code></em>.
</p>
<p>
WARNING: Initializing a parser with a stream is comparable to
selling your soul (<em class="parameter"><code>stream</code></em>) to the devil (<em class="parameter"><code>parser</code></em>). You are
basically giving the parser complete control of the stream, this
means that you had better not touch the stream so long as the
parser is still using it. This means no reading, writing, seeking,
or resetting of the stream. Anything that will/could change the
current stream's offset is PROHIBITED.
</p>
<p>
It is also recommended that you not use <a class="link" href="GMimeStream.html#g-mime-stream-tell" title="g_mime_stream_tell ()"><code class="function">g_mime_stream_tell()</code></a>
because it will not necessarily give you the current <em class="parameter"><code>parser</code></em> offset
since <em class="parameter"><code>parser</code></em> handles its own internal read-ahead buffer. Instead,
it is recommended that you use <a class="link" href="GMimeParser.html#g-mime-parser-tell" title="g_mime_parser_tell ()"><code class="function">g_mime_parser_tell()</code></a> if you have a
reason to need the current offset of the <em class="parameter"><code>parser</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>raw message or part stream</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-persist-stream"></a><h3>g_mime_parser_get_persist_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_persist_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets whether or not the underlying stream is persistent.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the <em class="parameter"><code>parser</code></em> will leave the content on disk or
<code class="literal">FALSE</code> if it will load the content into memory.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-set-persist-stream"></a><h3>g_mime_parser_set_persist_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_persist_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> persist</code></em>);</pre>
<p>
Sets whether or not the <em class="parameter"><code>parser</code></em>'s underlying stream is persistent.
</p>
<p>
If <em class="parameter"><code>persist</code></em> is <code class="literal">TRUE</code>, the <em class="parameter"><code>parser</code></em> will attempt to construct
messages/parts whose content will remain on disk rather than being
loaded into memory so as to reduce memory usage. This is the default.
</p>
<p>
If <em class="parameter"><code>persist</code></em> is <code class="literal">FALSE</code>, the <em class="parameter"><code>parser</code></em> will always load message content
into memory.
</p>
<p>
Note: This attribute only serves as a hint to the <em class="parameter"><code>parser</code></em>. If the
underlying stream does not support seeking, then this attribute
will be ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>persist</code></em> :</span></p></td>
<td>persist attribute</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-scan-from"></a><h3>g_mime_parser_get_scan_from ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_scan_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets whether or not <em class="parameter"><code>parser</code></em> is set to scan mbox-style From-lines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not <em class="parameter"><code>parser</code></em> is set to scan mbox-style
From-lines.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-set-scan-from"></a><h3>g_mime_parser_set_scan_from ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_scan_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>);</pre>
<p>
Sets whether or not <em class="parameter"><code>parser</code></em> should scan mbox-style From-lines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scan_from</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> to scan From-lines or <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-respect-content-length"></a><h3>g_mime_parser_get_respect_content_length ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_respect_content_length
(<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets whether or not <em class="parameter"><code>parser</code></em> is set to use Content-Length for
determining the offset of the end of the message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not <em class="parameter"><code>parser</code></em> is set to use Content-Length for
determining the offset of the end of the message.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-set-respect-content-length"></a><h3>g_mime_parser_set_respect_content_length ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_respect_content_length
(<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> respect_content_length</code></em>);</pre>
<p>
Sets whether or not <em class="parameter"><code>parser</code></em> should respect Content-Length headers
when deciding where to look for the start of the next message. Only
used when the parser is also set to scan for From-lines.
</p>
<p>
Most notably useful when parsing broken Solaris mbox files (See
http://www.jwz.org/doc/content-length.html for details).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>respect_content_length</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the parser should use Content-Length headers or <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-set-header-regex"></a><h3>g_mime_parser_set_header_regex ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_header_regex (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *regex</code></em>,
<em class="parameter"><code><a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()"><span class="type">GMimeParserHeaderRegexFunc</span></a> header_cb</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Sets the regular expression pattern <em class="parameter"><code>regex</code></em> on <em class="parameter"><code>parser</code></em>. Whenever a
header matching the pattern <em class="parameter"><code>regex</code></em> is parsed, <em class="parameter"><code>header_cb</code></em> is called
with <em class="parameter"><code>user_data</code></em> as the user_data argument.
</p>
<p>
If <em class="parameter"><code>regex</code></em> is <code class="literal">NULL</code>, then the previously registered regex callback
is unregistered and no new callback is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>regex</code></em> :</span></p></td>
<td>regular expression</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>header_cb</code></em> :</span></p></td>
<td>callback function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-tell"></a><h3>g_mime_parser_tell ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_tell (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets the current stream offset from the parser's internal stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the current stream offset from the parser's internal stream
or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-eos"></a><h3>g_mime_parser_eos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_eos (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Tests the end-of-stream indicator for <em class="parameter"><code>parser</code></em>'s internal stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on EOS or <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-construct-part"></a><h3>g_mime_parser_construct_part ()</h3>
<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_parser_construct_part (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Constructs a MIME part from <em class="parameter"><code>parser</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a MIME part based on <em class="parameter"><code>parser</code></em> or <code class="literal">NULL</code> on fail.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-construct-message"></a><h3>g_mime_parser_construct_message ()</h3>
<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * g_mime_parser_construct_message (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Constructs a MIME message from <em class="parameter"><code>parser</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a MIME message or <code class="literal">NULL</code> on fail.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-from"></a><h3>g_mime_parser_get_from ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_parser_get_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets the mbox-style From-line of the most recently parsed message
(gotten from <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()"><code class="function">g_mime_parser_construct_message()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mbox-style From-line of the most recently parsed
message or <code class="literal">NULL</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-from-offset"></a><h3>g_mime_parser_get_from_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_from_offset (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets the offset of the most recently parsed mbox-style From-line
(gotten from <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()"><code class="function">g_mime_parser_construct_message()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the offset of the most recently parsed mbox-style From-line
or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-headers-begin"></a><h3>g_mime_parser_get_headers_begin ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_headers_begin (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets the stream offset of the beginning of the headers of the most
recently parsed message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the offset of the beginning of the headers of the most
recently parsed message or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-parser-get-headers-end"></a><h3>g_mime_parser_get_headers_end ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_headers_end (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre>
<p>
Gets the stream offset of the end of the headers of the most
recently parsed message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the offset of the end of the headers of the most recently
parsed message or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
