/usr/share/gtk-doc/html/camel/CamelMimeParser.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 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 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelMimeParser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="MIME.html" title="MIME Objects">
<link rel="prev" href="CamelMimeMessage.html" title="CamelMimeMessage">
<link rel="next" href="Storage.html" title="Metadata Storage">
<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="CamelMimeMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MIME.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="Storage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelMimeParser.synopsis" class="shortcut">Top</a>
|
<a href="#CamelMimeParser.description" class="shortcut">Description</a>
|
<a href="#CamelMimeParser.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelMimeParser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelMimeParser.top_of_page"></a>CamelMimeParser</span></h2>
<p>CamelMimeParser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelMimeParser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelMimeParser.html#CamelMimeParser-struct" title="struct CamelMimeParser">CamelMimeParser</a>;
enum <a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t">camel_mime_parser_state_t</a>;
<a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="returnvalue">CamelMimeParser</span></a> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-new" title="camel_mime_parser_new ()">camel_mime_parser_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-errno" title="camel_mime_parser_errno ()">camel_mime_parser_errno</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-init-with-fd" title="camel_mime_parser_init_with_fd ()">camel_mime_parser_init_with_fd</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-init-with-stream" title="camel_mime_parser_init_with_stream ()">camel_mime_parser_init_with_stream</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-stream" title="camel_mime_parser_stream ()">camel_mime_parser_stream</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-fd" title="camel_mime_parser_fd ()">camel_mime_parser_fd</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-scan-from" title="camel_mime_parser_scan_from ()">camel_mime_parser_scan_from</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-scan-pre-from" title="camel_mime_parser_scan_pre_from ()">camel_mime_parser_scan_pre_from</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_pre_from</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-set-header-regex" title="camel_mime_parser_set_header_regex ()">camel_mime_parser_set_header_regex</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *matchstr</code></em>);
<a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="returnvalue">camel_mime_parser_state_t</span></a> <a class="link" href="CamelMimeParser.html#camel-mime-parser-step" title="camel_mime_parser_step ()">camel_mime_parser_step</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **databuffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *datalength</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-unstep" title="camel_mime_parser_unstep ()">camel_mime_parser_unstep</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-drop-step" title="camel_mime_parser_drop_step ()">camel_mime_parser_drop_step</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="returnvalue">camel_mime_parser_state_t</span></a> <a class="link" href="CamelMimeParser.html#camel-mime-parser-state" title="camel_mime_parser_state ()">camel_mime_parser_state</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-push-state" title="camel_mime_parser_push_state ()">camel_mime_parser_push_state</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *mp</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="type">camel_mime_parser_state_t</span></a> newstate</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *boundary</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-read" title="camel_mime_parser_read ()">camel_mime_parser_read</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **databuffer</code></em>,
<em class="parameter"><code><span class="type">gint</span> len</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="camel-camel-mime-utils.html#CamelContentType" title="CamelContentType"><span class="returnvalue">CamelContentType</span></a> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-content-type" title="camel_mime_parser_content_type ()">camel_mime_parser_content_type</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-header" title="camel_mime_parser_header ()">camel_mime_parser_header</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *offset</code></em>);
struct <a class="link" href="camel-camel-mime-utils.html#camel-header-raw" title="struct camel_header_raw"><span class="returnvalue">_camel_header_raw</span></a> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-headers-raw" title="camel_mime_parser_headers_raw ()">camel_mime_parser_headers_raw</a>
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-preface" title="camel_mime_parser_preface ()">camel_mime_parser_preface</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-postface" title="camel_mime_parser_postface ()">camel_mime_parser_postface</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelMimeParser.html#camel-mime-parser-from-line" title="camel_mime_parser_from_line ()">camel_mime_parser_from_line</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-filter-add" title="camel_mime_parser_filter_add ()">camel_mime_parser_filter_add</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> *mf</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-filter-remove" title="camel_mime_parser_filter_remove ()">camel_mime_parser_filter_remove</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><span class="type">gint</span> id</code></em>);
<span class="returnvalue">goffset</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-tell" title="camel_mime_parser_tell ()">camel_mime_parser_tell</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">goffset</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-seek" title="camel_mime_parser_seek ()">camel_mime_parser_seek</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">goffset</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> whence</code></em>);
<span class="returnvalue">goffset</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-tell-start-headers" title="camel_mime_parser_tell_start_headers ()">camel_mime_parser_tell_start_headers</a>
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">goffset</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-tell-start-from" title="camel_mime_parser_tell_start_from ()">camel_mime_parser_tell_start_from</a> (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
<span class="returnvalue">goffset</span> <a class="link" href="CamelMimeParser.html#camel-mime-parser-tell-start-boundary" title="camel_mime_parser_tell_start_boundary ()">camel_mime_parser_tell_start_boundary</a>
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeParser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelMimeParser
</pre>
</div>
<div class="refsect1">
<a name="CamelMimeParser.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelMimeParser.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelMimeParser-struct"></a><h3>struct CamelMimeParser</h3>
<pre class="programlisting">struct CamelMimeParser;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-state-t"></a><h3>enum camel_mime_parser_state_t</h3>
<pre class="programlisting">typedef enum {
CAMEL_MIME_PARSER_STATE_INITIAL,
CAMEL_MIME_PARSER_STATE_PRE_FROM, /* data before a 'From' line */
CAMEL_MIME_PARSER_STATE_FROM, /* got 'From' line */
CAMEL_MIME_PARSER_STATE_HEADER, /* toplevel header */
CAMEL_MIME_PARSER_STATE_BODY, /* scanning body of message */
CAMEL_MIME_PARSER_STATE_MULTIPART, /* got multipart header */
CAMEL_MIME_PARSER_STATE_MESSAGE, /* rfc822 message */
CAMEL_MIME_PARSER_STATE_PART, /* part of a multipart */
CAMEL_MIME_PARSER_STATE_END = 8, /* bit mask for 'end' flags */
CAMEL_MIME_PARSER_STATE_EOF = 8, /* end of file */
CAMEL_MIME_PARSER_STATE_PRE_FROM_END, /* pre from end */
CAMEL_MIME_PARSER_STATE_FROM_END, /* end of whole from bracket */
CAMEL_MIME_PARSER_STATE_HEADER_END, /* dummy value */
CAMEL_MIME_PARSER_STATE_BODY_END, /* end of message */
CAMEL_MIME_PARSER_STATE_MULTIPART_END, /* end of multipart */
CAMEL_MIME_PARSER_STATE_MESSAGE_END /* end of message */
} camel_mime_parser_state_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-new"></a><h3>camel_mime_parser_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="returnvalue">CamelMimeParser</span></a> * camel_mime_parser_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new CamelMimeParser 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 CamelMimeParser widget.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-errno"></a><h3>camel_mime_parser_errno ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_errno (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-init-with-fd"></a><h3>camel_mime_parser_init_with_fd ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_init_with_fd (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>);</pre>
<p>
Initialise the scanner with an fd. The scanner's offsets
will be relative to the current file position of the file
descriptor. As a result, seekable descritors should
be seeked using the parser seek functions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
<td>A valid file descriptor.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns -1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-init-with-stream"></a><h3>camel_mime_parser_init_with_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_init_with_stream (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Initialise the scanner with a source stream. The scanner's
offsets will be relative to the current file position of
the stream. As a result, seekable streams should only
be seeked using the parser seek function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-stream"></a><h3>camel_mime_parser_stream ()</h3>
<pre class="programlisting"><a class="link" href="CamelStream.html" title="CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_mime_parser_stream (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Get the stream, if any, the parser has been initialised
with. May be used to setup sub-streams, but should not
be read from directly (without saving and restoring
the seek position in between).
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The stream from <code class="function">_init_with_stream()</code>, or NULL
if the parser is reading from a file descriptor or is
uninitialised.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-fd"></a><h3>camel_mime_parser_fd ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_fd (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Return the file descriptor, if any, the parser has been
initialised with.
</p>
<p>
Should not be read from unless the parser it to terminate,
or the seek offset can be reset before the next parse
step.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The file descriptor or -1 if the parser
is reading from a stream or has not been initialised.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-scan-from"></a><h3>camel_mime_parser_scan_from ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_scan_from (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>);</pre>
<p>
Tell the scanner if it should scan "^From " lines or not.
</p>
<p>
If the scanner is scanning from lines, two additional
states CAMEL_MIME_PARSER_STATE_FROM and CAMEL_MIME_PARSER_STATE_FROM_END will be returned
to the caller during parsing.
</p>
<p>
This may also be preceeded by an optional
CAMEL_MIME_PARSER_STATE_PRE_FROM state which contains the scanned data
found before the From line is encountered. See also
<code class="function">scan_pre_from()</code>.
</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>MIME parser object</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> if the scanner should scan From lines.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-scan-pre-from"></a><h3>camel_mime_parser_scan_pre_from ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_scan_pre_from (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> scan_pre_from</code></em>);</pre>
<p>
Tell the scanner whether we want to know abou the pre-from
data during a scan. If we do, then we may get an additional
state CAMEL_MIME_PARSER_STATE_PRE_FROM which returns the specified data.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scan_pre_from</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> if we want to get pre-from data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-set-header-regex"></a><h3>camel_mime_parser_set_header_regex ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_set_header_regex (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *matchstr</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-step"></a><h3>camel_mime_parser_step ()</h3>
<pre class="programlisting"><a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="returnvalue">camel_mime_parser_state_t</span></a> camel_mime_parser_step (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **databuffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *datalength</code></em>);</pre>
<p>
Parse the next part of the MIME message. If <code class="function">_unstep()</code>
has been called, then continue to return the same state
for that many calls.
</p>
<p>
If the step is CAMEL_MIME_PARSER_STATE_BODY then the databuffer and datalength
pointers will be setup to point to the internal data buffer
of the scanner and may be processed as required. Any
filters will have already been applied to this data.
</p>
<p>
Refer to the state diagram elsewhere for a full listing of
the states an application is gauranteed to get from the
scanner.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>databuffer</code></em> :</span></p></td>
<td>Pointer to accept a pointer to the data
associated with this step (if any). May be <code class="literal">NULL</code>,
in which case datalength is also ingored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>datalength</code></em> :</span></p></td>
<td>Pointer to accept a pointer to the data
length associated with this step (if any).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current new state of the parser
is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-unstep"></a><h3>camel_mime_parser_unstep ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_unstep (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Cause the last step operation to repeat itself. If this is
called repeated times, then the same step will be repeated
that many times.
</p>
<p>
Note that it is not possible to scan back using this function,
only to have a way of peeking the next state.
</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>MIME parser object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-drop-step"></a><h3>camel_mime_parser_drop_step ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_drop_step (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Drop the last step call. This should only be used
in conjunction with seeking of the stream as the
stream may be in an undefined state relative to the
state of the parser.
</p>
<p>
Use this call with care.
</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>MIME parser object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-state"></a><h3>camel_mime_parser_state ()</h3>
<pre class="programlisting"><a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="returnvalue">camel_mime_parser_state_t</span></a> camel_mime_parser_state (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Get the current parser state.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current parser state.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-push-state"></a><h3>camel_mime_parser_push_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_push_state (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *mp</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeParser.html#camel-mime-parser-state-t" title="enum camel_mime_parser_state_t"><span class="type">camel_mime_parser_state_t</span></a> newstate</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *boundary</code></em>);</pre>
<p>
Pre-load a new parser state. Used to post-parse multipart content
without headers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mp</code></em> :</span></p></td>
<td>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>newstate</code></em> :</span></p></td>
<td>New state</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>boundary</code></em> :</span></p></td>
<td>Boundary marker for state.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-read"></a><h3>camel_mime_parser_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_read (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **databuffer</code></em>,
<em class="parameter"><code><span class="type">gint</span> len</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Read at most <em class="parameter"><code>len</code></em> bytes from the internal mime parser buffer.
</p>
<p>
Returns the address of the internal buffer in <em class="parameter"><code>databuffer</code></em>,
and the length of useful data.
</p>
<p>
<em class="parameter"><code>len</code></em> may be specified as INT_MAX, in which case you will
get the full remainder of the buffer at each call.
</p>
<p>
Note that no parsing of the data read through this function
occurs, so no state changes occur, but the seek position
is updated appropriately.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of bytes available, or -1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-content-type"></a><h3>camel_mime_parser_content_type ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-mime-utils.html#CamelContentType" title="CamelContentType"><span class="returnvalue">CamelContentType</span></a> * camel_mime_parser_content_type (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Get the content type defined in the current part.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A content_type structure, or NULL if there
is no content-type defined for this part of state of the
parser.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-header"></a><h3>camel_mime_parser_header ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_mime_parser_header (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *offset</code></em>);</pre>
<p>
Lookup a header by name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Name of header.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>Pointer that can receive the offset of the header in
the stream from the start of parsing.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The header value, or NULL if the header is not
defined.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-headers-raw"></a><h3>camel_mime_parser_headers_raw ()</h3>
<pre class="programlisting">struct <a class="link" href="camel-camel-mime-utils.html#camel-header-raw" title="struct camel_header_raw"><span class="returnvalue">_camel_header_raw</span></a> * camel_mime_parser_headers_raw
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);</pre>
<p>
Get the list of the raw headers which are defined for the
current state of the parser. These headers are valid
until the next call to <code class="function">parser_step()</code>, or <code class="function">parser_drop_step()</code>.
</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>The raw headers, or NULL if there are no headers
defined for the current part or state. These are READ ONLY.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-preface"></a><h3>camel_mime_parser_preface ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_mime_parser_preface (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);</pre>
<p>
Retrieve the preface text for the current multipart.
Can only be used when the state is CAMEL_MIME_PARSER_STATE_MULTIPART_END.
</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>The preface text, or NULL if there wasn't any.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-postface"></a><h3>camel_mime_parser_postface ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_mime_parser_postface (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);</pre>
<p>
Retrieve the postface text for the current multipart.
Only returns valid data when the current state if
CAMEL_MIME_PARSER_STATE_MULTIPART_END.
</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>The postface text, or NULL if there wasn't any.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-from-line"></a><h3>camel_mime_parser_from_line ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_mime_parser_from_line (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>);</pre>
<p>
Get the last scanned "From " line, from a recently scanned from.
This should only be called in the CAMEL_MIME_PARSER_STATE_FROM state. The
from line will include the closing \n found (if there was one).
</p>
<p>
The return value will remain valid while in the CAMEL_MIME_PARSER_STATE_FROM
state, or any deeper state.
</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>The From line, or NULL if called out of context.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-filter-add"></a><h3>camel_mime_parser_filter_add ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_mime_parser_filter_add (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter"><span class="type">CamelMimeFilter</span></a> *mf</code></em>);</pre>
<p>
Add a filter that will be applied to any body content before it is passed
to the caller. Filters may be pipelined to perform multi-pass operations
on the content, and are applied in the order they were added.
</p>
<p>
Note that filters are only applied to the body content of messages, and once
a filter has been set, all content returned by a <code class="function">filter_step()</code> with a state
of CAMEL_MIME_PARSER_STATE_BODY will have passed through the filter.
</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>An id that may be passed to <code class="function">filter_remove()</code> to remove
the filter, or -1 if the operation failed.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-filter-remove"></a><h3>camel_mime_parser_filter_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_mime_parser_filter_remove (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *m</code></em>,
<em class="parameter"><code><span class="type">gint</span> id</code></em>);</pre>
<p>
Remove a processing filter from the pipeline. There is no
restriction on the order the filters can be removed.
</p>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-tell"></a><h3>camel_mime_parser_tell ()</h3>
<pre class="programlisting"><span class="returnvalue">goffset</span> camel_mime_parser_tell (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Return the current scanning offset. The meaning of this
value will depend on the current state of the parser.
</p>
<p>
An incomplete listing of the states:
</p>
<p>
CAMEL_MIME_PARSER_STATE_INITIAL, The start of the current message.
CAMEL_MIME_PARSER_STATE_HEADER, CAMEL_MIME_PARSER_STATE_MESSAGE, CAMEL_MIME_PARSER_STATE_MULTIPART, the character
position immediately after the end of the header.
CAMEL_MIME_PARSER_STATE_BODY, Position within the message of the start
of the current data block.
CAMEL_MIME_PARSER_STATE_*_END, The position of the character starting
the next section of the scan (the last position + 1 of
the respective current state).
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>See above.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-seek"></a><h3>camel_mime_parser_seek ()</h3>
<pre class="programlisting"><span class="returnvalue">goffset</span> camel_mime_parser_seek (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>,
<em class="parameter"><code><span class="type">goffset</span> offset</code></em>,
<em class="parameter"><code><span class="type">gint</span> whence</code></em>);</pre>
<p>
Reset the source position to a known value.
</p>
<p>
Note that if the source stream/descriptor was not
positioned at 0 to begin with, and an absolute seek
is specified (whence != SEEK_CUR), then the seek
position may not match the desired seek position.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>Number of bytes to offset the seek by.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>whence</code></em> :</span></p></td>
<td>SEEK_SET, SEEK_CUR, SEEK_END</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The new seek offset, or -1 on
an error (for example, trying to seek on a non-seekable
stream or file descriptor).</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-tell-start-headers"></a><h3>camel_mime_parser_tell_start_headers ()</h3>
<pre class="programlisting"><span class="returnvalue">goffset</span> camel_mime_parser_tell_start_headers
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
Find out the position within the file of where the
headers started, this is cached by the parser
at the time.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The header start position, or -1 if
no headers were scanned in the current state.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-tell-start-from"></a><h3>camel_mime_parser_tell_start_from ()</h3>
<pre class="programlisting"><span class="returnvalue">goffset</span> camel_mime_parser_tell_start_from (<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
If the parser is scanning From lines, then this returns
the position of the start of the From line.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The start of the from line, or -1 if there
was no From line, or From lines are not being scanned.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mime-parser-tell-start-boundary"></a><h3>camel_mime_parser_tell_start_boundary ()</h3>
<pre class="programlisting"><span class="returnvalue">goffset</span> camel_mime_parser_tell_start_boundary
(<em class="parameter"><code><a class="link" href="CamelMimeParser.html" title="CamelMimeParser"><span class="type">CamelMimeParser</span></a> *parser</code></em>);</pre>
<p>
When parsing a multipart, this returns the start of the last
boundary.
</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>MIME parser object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The start of the boundary, or -1 if there
was no boundary encountered yet.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|