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
|
<refentry id="gmime-gmime-parser">
<refmeta>
<refentrytitle>gmime-parser</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-parser</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<anchor id="GMimeParser"/>
<synopsis>
<link linkend="GMimeParser-struct">GMimeParser</link>;
<link linkend="void">void</link> (<link linkend="GMimeParserHeaderRegexFunc">*GMimeParserHeaderRegexFunc</link>) (<link linkend="GMimeParser">GMimeParser</link> *parser,
const <link linkend="char">char</link> *header,
const <link linkend="char">char</link> *value,
<link linkend="off-t">off_t</link> offset,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="GMimeParser">GMimeParser</link>* <link linkend="g-mime-parser-new">g_mime_parser_new</link> (void);
<link linkend="GMimeParser">GMimeParser</link>* <link linkend="g-mime-parser-new-with-stream">g_mime_parser_new_with_stream</link> (<link linkend="GMimeStream">GMimeStream</link> *stream);
<link linkend="void">void</link> <link linkend="g-mime-parser-init-with-stream">g_mime_parser_init_with_stream</link> (<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="GMimeStream">GMimeStream</link> *stream);
<link linkend="gboolean">gboolean</link> <link linkend="g-mime-parser-get-persist-stream">g_mime_parser_get_persist_stream</link>
(<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="void">void</link> <link linkend="g-mime-parser-set-persist-stream">g_mime_parser_set_persist_stream</link>
(<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> persist);
<link linkend="gboolean">gboolean</link> <link linkend="g-mime-parser-get-scan-from">g_mime_parser_get_scan_from</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="void">void</link> <link linkend="g-mime-parser-set-scan-from">g_mime_parser_set_scan_from</link> (<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> scan_from);
<link linkend="gboolean">gboolean</link> <link linkend="g-mime-parser-get-respect-content-length">g_mime_parser_get_respect_content_length</link>
(<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="void">void</link> <link linkend="g-mime-parser-set-respect-content-length">g_mime_parser_set_respect_content_length</link>
(<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> respect_content_length);
<link linkend="void">void</link> <link linkend="g-mime-parser-set-header-regex">g_mime_parser_set_header_regex</link> (<link linkend="GMimeParser">GMimeParser</link> *parser,
const <link linkend="char">char</link> *regex,
<link linkend="GMimeParserHeaderRegexFunc">GMimeParserHeaderRegexFunc</link> header_cb,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="off-t">off_t</link> <link linkend="g-mime-parser-tell">g_mime_parser_tell</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="gboolean">gboolean</link> <link linkend="g-mime-parser-eos">g_mime_parser_eos</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="GMimeObject">GMimeObject</link>* <link linkend="g-mime-parser-construct-part">g_mime_parser_construct_part</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="GMimeMessage">GMimeMessage</link>* <link linkend="g-mime-parser-construct-message">g_mime_parser_construct_message</link>
(<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="char">char</link>* <link linkend="g-mime-parser-get-from">g_mime_parser_get_from</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
<link linkend="off-t">off_t</link> <link linkend="g-mime-parser-get-from-offset">g_mime_parser_get_from_offset</link> (<link linkend="GMimeParser">GMimeParser</link> *parser);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GMimeParser
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeParser-struct"/>GMimeParser</title>
<indexterm><primary>GMimeParser</primary></indexterm><programlisting>typedef struct _GMimeParser GMimeParser;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GMimeParserHeaderRegexFunc"/>GMimeParserHeaderRegexFunc ()</title>
<indexterm><primary>GMimeParserHeaderRegexFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GMimeParserHeaderRegexFunc) (<link linkend="GMimeParser">GMimeParser</link> *parser,
const <link linkend="char">char</link> *header,
const <link linkend="char">char</link> *value,
<link linkend="off-t">off_t</link> offset,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-new"/>g_mime_parser_new ()</title>
<indexterm><primary>g_mime_parser_new</primary></indexterm><programlisting><link linkend="GMimeParser">GMimeParser</link>* g_mime_parser_new (void);</programlisting>
<para>
Creates a new parser object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new parser object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-new-with-stream"/>g_mime_parser_new_with_stream ()</title>
<indexterm><primary>g_mime_parser_new_with_stream</primary></indexterm><programlisting><link linkend="GMimeParser">GMimeParser</link>* g_mime_parser_new_with_stream (<link linkend="GMimeStream">GMimeStream</link> *stream);</programlisting>
<para>
Creates a new parser object preset to parse <parameter>stream</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>stream</parameter> :</term>
<listitem><simpara> raw message or part stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new parser object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-init-with-stream"/>g_mime_parser_init_with_stream ()</title>
<indexterm><primary>g_mime_parser_init_with_stream</primary></indexterm><programlisting><link linkend="void">void</link> g_mime_parser_init_with_stream (<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="GMimeStream">GMimeStream</link> *stream);</programlisting>
<para>
Initializes <parameter>parser</parameter> to use <parameter>stream</parameter>.
</para>
<para>
WARNING: Initializing a parser with a stream is comparable to
selling your soul (<parameter>stream</parameter>) to the devil (<parameter>parser</parameter>). 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.
</para>
<para>
It is also recommended that you not use <link linkend="g-mime-stream-tell"><function>g_mime_stream_tell()</function></link>
because it will not necessarily give you the current <parameter>parser</parameter> offset
since <parameter>parser</parameter> handles its own internal read-ahead buffer. Instead,
it is recommended that you use <link linkend="g-mime-parser-tell"><function>g_mime_parser_tell()</function></link> if you have a
reason to need the current offset of the <parameter>parser</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream</parameter> :</term>
<listitem><simpara> raw message or part stream
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-get-persist-stream"/>g_mime_parser_get_persist_stream ()</title>
<indexterm><primary>g_mime_parser_get_persist_stream</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g_mime_parser_get_persist_stream
(<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets whether or not the underlying stream is persistent.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><literal>TRUE</literal> if the <parameter>parser</parameter> will leave the content on disk or
<literal>FALSE</literal> if it will load the content into memory.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-set-persist-stream"/>g_mime_parser_set_persist_stream ()</title>
<indexterm><primary>g_mime_parser_set_persist_stream</primary></indexterm><programlisting><link linkend="void">void</link> g_mime_parser_set_persist_stream
(<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> persist);</programlisting>
<para>
Sets whether or not the <parameter>parser</parameter>'s underlying stream is persistent.
</para>
<para>
If <parameter>persist</parameter> is <literal>TRUE</literal>, the <parameter>parser</parameter> 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.
</para>
<para>
If <parameter>persist</parameter> is <literal>FALSE</literal>, the <parameter>parser</parameter> will always load message content
into memory.
</para>
<para>
Note: This attribute only serves as a hint to the <parameter>parser</parameter>. If the
underlying stream does not support seeking, then this attribute
will be ignored.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>persist</parameter> :</term>
<listitem><simpara> persist attribute
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-get-scan-from"/>g_mime_parser_get_scan_from ()</title>
<indexterm><primary>g_mime_parser_get_scan_from</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g_mime_parser_get_scan_from (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets whether or not <parameter>parser</parameter> is set to scan mbox-style From-lines.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>whether or not <parameter>parser</parameter> is set to scan mbox-style
From-lines.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-set-scan-from"/>g_mime_parser_set_scan_from ()</title>
<indexterm><primary>g_mime_parser_set_scan_from</primary></indexterm><programlisting><link linkend="void">void</link> g_mime_parser_set_scan_from (<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> scan_from);</programlisting>
<para>
Sets whether or not <parameter>parser</parameter> should scan mbox-style From-lines.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>scan_from</parameter> :</term>
<listitem><simpara> <literal>TRUE</literal> to scan From-lines or <literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-get-respect-content-length"/>g_mime_parser_get_respect_content_length ()</title>
<indexterm><primary>g_mime_parser_get_respect_content_length</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g_mime_parser_get_respect_content_length
(<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets whether or not <parameter>parser</parameter> is set to use Content-Length for
determining the offset of the end of the message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>whether or not <parameter>parser</parameter> is set to use Content-Length for
determining the offset of the end of the message.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-set-respect-content-length"/>g_mime_parser_set_respect_content_length ()</title>
<indexterm><primary>g_mime_parser_set_respect_content_length</primary></indexterm><programlisting><link linkend="void">void</link> g_mime_parser_set_respect_content_length
(<link linkend="GMimeParser">GMimeParser</link> *parser,
<link linkend="gboolean">gboolean</link> respect_content_length);</programlisting>
<para>
Sets whether or not <parameter>parser</parameter> 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.
</para>
<para>
Most notably useful when parsing broken Solaris mbox files (See
http://www.jwz.org/doc/content-length.html for details).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>respect_content_length</parameter> :</term>
<listitem><simpara> <literal>TRUE</literal> if the parser should use Content-Length headers or <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-set-header-regex"/>g_mime_parser_set_header_regex ()</title>
<indexterm><primary>g_mime_parser_set_header_regex</primary></indexterm><programlisting><link linkend="void">void</link> g_mime_parser_set_header_regex (<link linkend="GMimeParser">GMimeParser</link> *parser,
const <link linkend="char">char</link> *regex,
<link linkend="GMimeParserHeaderRegexFunc">GMimeParserHeaderRegexFunc</link> header_cb,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Sets the regular expression pattern <parameter>regex</parameter> on <parameter>parser</parameter>. Whenever a
header matching the pattern <parameter>regex</parameter> is parsed, <parameter>header_cb</parameter> is called
with <parameter>user_data</parameter> as the user_data argument.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>regex</parameter> :</term>
<listitem><simpara> regular expression
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header_cb</parameter> :</term>
<listitem><simpara> callback function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-tell"/>g_mime_parser_tell ()</title>
<indexterm><primary>g_mime_parser_tell</primary></indexterm><programlisting><link linkend="off-t">off_t</link> g_mime_parser_tell (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets the current stream offset from the parser's internal stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the current stream offset from the parser's internal stream
or -1 on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-eos"/>g_mime_parser_eos ()</title>
<indexterm><primary>g_mime_parser_eos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g_mime_parser_eos (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Tests the end-of-stream indicator for <parameter>parser</parameter>'s internal stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><literal>TRUE</literal> on EOS or <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-construct-part"/>g_mime_parser_construct_part ()</title>
<indexterm><primary>g_mime_parser_construct_part</primary></indexterm><programlisting><link linkend="GMimeObject">GMimeObject</link>* g_mime_parser_construct_part (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Constructs a MIME part from <parameter>parser</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a MIME part based on <parameter>parser</parameter> or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-construct-message"/>g_mime_parser_construct_message ()</title>
<indexterm><primary>g_mime_parser_construct_message</primary></indexterm><programlisting><link linkend="GMimeMessage">GMimeMessage</link>* g_mime_parser_construct_message
(<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Constructs a MIME message from <parameter>parser</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a MIME message or <literal>NULL</literal> on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-get-from"/>g_mime_parser_get_from ()</title>
<indexterm><primary>g_mime_parser_get_from</primary></indexterm><programlisting><link linkend="char">char</link>* g_mime_parser_get_from (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets the mbox-style From-line of the most recently parsed message
(gotten from <link linkend="g-mime-parser-construct-message"><function>g_mime_parser_construct_message()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the mbox-style From-line of the most recently parsed
message or <literal>NULL</literal> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-parser-get-from-offset"/>g_mime_parser_get_from_offset ()</title>
<indexterm><primary>g_mime_parser_get_from_offset</primary></indexterm><programlisting><link linkend="off-t">off_t</link> g_mime_parser_get_from_offset (<link linkend="GMimeParser">GMimeParser</link> *parser);</programlisting>
<para>
Gets the offset of the most recently parsed mbox-style From-line
(gotten from <link linkend="g-mime-parser-construct-message"><function>g_mime_parser_construct_message()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> MIME parser object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the offset of the most recently parsed mbox-style From-line
or -1 on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
