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 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615
|
<refentry id="camel-CamelFolderSummary">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelFolderSummary.top_of_page">CamelFolderSummary</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>CamelFolderSummary</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-CamelFolderSummary.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="CamelFolderSummary">CamelFolderSummary</link>;
<link linkend="CamelMessageInfo">CamelMessageInfo</link>;
<link linkend="CamelMessageInfoBase">CamelMessageInfoBase</link>;
<link linkend="CamelFolderMetaSummary">CamelFolderMetaSummary</link>;
struct <link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link>;
enum <link linkend="CamelMessageFlags">CamelMessageFlags</link>;
#define <link linkend="CAMEL-MESSAGE-SYSTEM-MASK:CAPS">CAMEL_MESSAGE_SYSTEM_MASK</link>
<link linkend="CamelFlag">CamelFlag</link>;
<link linkend="CamelTag">CamelTag</link>;
<link linkend="CamelSummaryMessageID">CamelSummaryMessageID</link>;
<link linkend="CamelSummaryReferences">CamelSummaryReferences</link>;
enum <link linkend="CamelFolderSummaryFlags">CamelFolderSummaryFlags</link>;
<link linkend="CamelFolderSummary">CamelFolderSummary</link>* <link linkend="camel-folder-summary-new">camel_folder_summary_new</link> (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder);
<link linkend="void">void</link> <link linkend="camel-folder-summary-set-filename">camel_folder_summary_set_filename</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *filename);
<link linkend="void">void</link> <link linkend="camel-folder-summary-set-index">camel_folder_summary_set_index</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelIndex">CamelIndex</link> *index);
<link linkend="void">void</link> <link linkend="camel-folder-summary-set-build-content">camel_folder_summary_set_build_content</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="gboolean">gboolean</link> state);
<link linkend="guint32">guint32</link> <link linkend="camel-folder-summary-next-uid">camel_folder_summary_next_uid</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="char">char</link>* <link linkend="camel-folder-summary-next-uid-string">camel_folder_summary_next_uid_string</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-summary-set-uid">camel_folder_summary_set_uid</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="guint32">guint32</link> uid);
<link linkend="int">int</link> <link linkend="camel-folder-summary-load">camel_folder_summary_load</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="int">int</link> <link linkend="camel-folder-summary-save">camel_folder_summary_save</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="int">int</link> <link linkend="camel-folder-summary-header-load">camel_folder_summary_header_load</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-summary-touch">camel_folder_summary_touch</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-summary-add">camel_folder_summary_add</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-add-from-header">camel_folder_summary_add_from_header</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *headers);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-add-from-parser">camel_folder_summary_add_from_parser</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeParser">CamelMimeParser</link> *parser);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-add-from-message">camel_folder_summary_add_from_message</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-info-new-from-header">camel_folder_summary_info_new_from_header</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *headers);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-info-new-from-parser">camel_folder_summary_info_new_from_parser</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeParser">CamelMimeParser</link> *parser);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-info-new-from-message">camel_folder_summary_info_new_from_message</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);
<link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link>* <link linkend="camel-folder-summary-content-info-new">camel_folder_summary_content_info_new</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-summary-content-info-free">camel_folder_summary_content_info_free</link>
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link> *ci);
<link linkend="void">void</link> <link linkend="camel-folder-summary-remove">camel_folder_summary_remove</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);
<link linkend="void">void</link> <link linkend="camel-folder-summary-remove-uid">camel_folder_summary_remove_uid</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *uid);
<link linkend="void">void</link> <link linkend="camel-folder-summary-remove-index">camel_folder_summary_remove_index</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> index);
<link linkend="void">void</link> <link linkend="camel-folder-summary-remove-range">camel_folder_summary_remove_range</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> start,
<link linkend="int">int</link> end);
<link linkend="void">void</link> <link linkend="camel-folder-summary-clear">camel_folder_summary_clear</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="int">int</link> <link linkend="camel-folder-summary-count">camel_folder_summary_count</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-index">camel_folder_summary_index</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> index);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-folder-summary-uid">camel_folder_summary_uid</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *uid);
<link linkend="GPtrArray">GPtrArray</link>* <link linkend="camel-folder-summary-array">camel_folder_summary_array</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-folder-summary-array-free">camel_folder_summary_array_free</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="GPtrArray">GPtrArray</link> *array);
<link linkend="int">int</link> <link linkend="camel-folder-summary-encode-token">camel_folder_summary_encode_token</link> (<link linkend="FILE:CAPS">FILE</link> *out,
const <link linkend="char">char</link> *str);
<link linkend="int">int</link> <link linkend="camel-folder-summary-decode-token">camel_folder_summary_decode_token</link> (<link linkend="FILE:CAPS">FILE</link> *in,
<link linkend="char">char</link> **str);
<link linkend="gboolean">gboolean</link> <link linkend="camel-flag-get">camel_flag_get</link> (<link linkend="CamelFlag">CamelFlag</link> **list,
const <link linkend="char">char</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="camel-flag-set">camel_flag_set</link> (<link linkend="CamelFlag">CamelFlag</link> **list,
const <link linkend="char">char</link> *name,
<link linkend="gboolean">gboolean</link> state);
<link linkend="gboolean">gboolean</link> <link linkend="camel-flag-list-copy">camel_flag_list_copy</link> (<link linkend="CamelFlag">CamelFlag</link> **to,
<link linkend="CamelFlag">CamelFlag</link> **from);
<link linkend="int">int</link> <link linkend="camel-flag-list-size">camel_flag_list_size</link> (<link linkend="CamelFlag">CamelFlag</link> **list);
<link linkend="void">void</link> <link linkend="camel-flag-list-free">camel_flag_list_free</link> (<link linkend="CamelFlag">CamelFlag</link> **list);
<link linkend="guint32">guint32</link> <link linkend="camel-system-flag">camel_system_flag</link> (const <link linkend="char">char</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="camel-system-flag-get">camel_system_flag_get</link> (<link linkend="guint32">guint32</link> flags,
const <link linkend="char">char</link> *name);
const <link linkend="char">char</link>* <link linkend="camel-tag-get">camel_tag_get</link> (<link linkend="CamelTag">CamelTag</link> **list,
const <link linkend="char">char</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="camel-tag-set">camel_tag_set</link> (<link linkend="CamelTag">CamelTag</link> **list,
const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *value);
<link linkend="gboolean">gboolean</link> <link linkend="camel-tag-list-copy">camel_tag_list_copy</link> (<link linkend="CamelTag">CamelTag</link> **to,
<link linkend="CamelTag">CamelTag</link> **from);
<link linkend="int">int</link> <link linkend="camel-tag-list-size">camel_tag_list_size</link> (<link linkend="CamelTag">CamelTag</link> **list);
<link linkend="void">void</link> <link linkend="camel-tag-list-free">camel_tag_list_free</link> (<link linkend="CamelTag">CamelTag</link> **list);
<link linkend="void">void</link>* <link linkend="camel-message-info-new">camel_message_info_new</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);
<link linkend="void">void</link> <link linkend="camel-message-info-ref">camel_message_info_ref</link> (<link linkend="void">void</link> *info);
<link linkend="CamelMessageInfo">CamelMessageInfo</link>* <link linkend="camel-message-info-new-from-header">camel_message_info_new_from_header</link> (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *header);
<link linkend="void">void</link> <link linkend="camel-message-info-free">camel_message_info_free</link> (<link linkend="void">void</link> *info);
<link linkend="void">void</link>* <link linkend="camel-message-info-clone">camel_message_info_clone</link> (const <link linkend="void">void</link> *info);
const <link linkend="void">void</link>* <link linkend="camel-message-info-ptr">camel_message_info_ptr</link> (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);
<link linkend="guint32">guint32</link> <link linkend="camel-message-info-uint32">camel_message_info_uint32</link> (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);
<link linkend="time-t">time_t</link> <link linkend="camel-message-info-time">camel_message_info_time</link> (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);
#define <link linkend="camel-message-info-uid">camel_message_info_uid</link> (mi)
#define <link linkend="camel-message-info-subject">camel_message_info_subject</link> (mi)
#define <link linkend="camel-message-info-from">camel_message_info_from</link> (mi)
#define <link linkend="camel-message-info-to">camel_message_info_to</link> (mi)
#define <link linkend="camel-message-info-cc">camel_message_info_cc</link> (mi)
#define <link linkend="camel-message-info-mlist">camel_message_info_mlist</link> (mi)
#define <link linkend="camel-message-info-flags">camel_message_info_flags</link> (mi)
#define <link linkend="camel-message-info-size">camel_message_info_size</link> (mi)
#define <link linkend="camel-message-info-date-sent">camel_message_info_date_sent</link> (mi)
#define <link linkend="camel-message-info-date-received">camel_message_info_date_received</link> (mi)
#define <link linkend="camel-message-info-message-id">camel_message_info_message_id</link> (mi)
#define <link linkend="camel-message-info-references">camel_message_info_references</link> (mi)
#define <link linkend="camel-message-info-user-flags">camel_message_info_user_flags</link> (mi)
#define <link linkend="camel-message-info-user-tags">camel_message_info_user_tags</link> (mi)
<link linkend="gboolean">gboolean</link> <link linkend="camel-message-info-user-flag">camel_message_info_user_flag</link> (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id);
const <link linkend="char">char</link>* <link linkend="camel-message-info-user-tag">camel_message_info_user_tag</link> (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id);
<link linkend="gboolean">gboolean</link> <link linkend="camel-message-info-set-flags">camel_message_info_set_flags</link> (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="guint32">guint32</link> mask,
<link linkend="guint32">guint32</link> set);
<link linkend="gboolean">gboolean</link> <link linkend="camel-message-info-set-user-flag">camel_message_info_set_user_flag</link> (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id,
<link linkend="gboolean">gboolean</link> state);
<link linkend="gboolean">gboolean</link> <link linkend="camel-message-info-set-user-tag">camel_message_info_set_user_tag</link> (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *val);
<link linkend="void">void</link> <link linkend="camel-content-info-dump">camel_content_info_dump</link> (<link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link> *ci,
<link linkend="int">int</link> depth);
<link linkend="void">void</link> <link linkend="camel-message-info-dump">camel_message_info_dump</link> (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-CamelFolderSummary.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-CamelFolderSummary.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelFolderSummary" role="struct">
<title>struct CamelFolderSummary</title>
<indexterm zone="CamelFolderSummary"><primary>CamelFolderSummary</primary></indexterm><programlisting>struct CamelFolderSummary {
CamelObject parent;
struct _CamelFolderSummaryPrivate *priv;
/* header info */
guint32 version; /* version of file loaded/loading */
guint32 flags; /* flags */
guint32 nextuid; /* next uid? */
time_t time; /* timestamp for this summary (for implementors to use) */
guint32 saved_count; /* how many were saved/loaded */
guint32 unread_count; /* handy totals */
guint32 deleted_count;
guint32 junk_count;
/* sizes of memory objects */
guint32 message_info_size;
guint32 content_info_size;
/* memory allocators (setup automatically) */
struct _EMemChunk *message_info_chunks;
struct _EMemChunk *content_info_chunks;
char *summary_path;
gboolean build_content; /* do we try and parse/index the content, or not? */
GPtrArray *messages; /* CamelMessageInfo's */
GHashTable *messages_uid; /* CamelMessageInfo's by uid */
struct _CamelFolder *folder; /* parent folder, for events */
struct _CamelFolderMetaSummary *meta_summary; /* Meta summary */
};
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelMessageInfo" role="struct">
<title>CamelMessageInfo</title>
<indexterm zone="CamelMessageInfo"><primary>CamelMessageInfo</primary></indexterm><programlisting>typedef struct {
CamelFolderSummary *summary;
guint32 refcount; /* ??? */
char *uid;
} CamelMessageInfo;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelMessageInfoBase" role="struct">
<title>CamelMessageInfoBase</title>
<indexterm zone="CamelMessageInfoBase"><primary>CamelMessageInfoBase</primary></indexterm><programlisting>typedef struct {
CamelFolderSummary *summary;
guint32 refcount; /* ??? */
char *uid;
const char *subject;
const char *from;
const char *to;
const char *cc;
const char *mlist;
guint32 flags;
guint32 size;
time_t date_sent;
time_t date_received;
CamelSummaryMessageID message_id;
CamelSummaryReferences *references;/* from parent to root */
struct _CamelFlag *user_flags;
struct _CamelTag *user_tags;
/* tree of content description - NULL if it is not available */
CamelMessageContentInfo *content;
struct _camel_header_param *headers;
} CamelMessageInfoBase;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelFolderMetaSummary" role="struct">
<title>CamelFolderMetaSummary</title>
<indexterm zone="CamelFolderMetaSummary"><primary>CamelFolderMetaSummary</primary></indexterm><programlisting>typedef struct {
guint32 major; /* Major version of meta-summary */
guint32 minor; /* Minor version of meta-summary */
guint32 uid_len; /* Length of UID (for implementors to use) */
gboolean msg_expunged; /* Whether any message is expunged or not */
char *path; /* Path to meta-summary-file */
} CamelFolderMetaSummary;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelMessageContentInfo" role="struct">
<title>struct CamelMessageContentInfo</title>
<indexterm zone="CamelMessageContentInfo"><primary>CamelMessageContentInfo</primary></indexterm><programlisting>struct CamelMessageContentInfo {
struct _CamelMessageContentInfo *next;
struct _CamelMessageContentInfo *childs;
struct _CamelMessageContentInfo *parent;
CamelContentType *type;
char *id;
char *description;
char *encoding; /* this should be an enum?? */
guint32 size;
};
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelMessageFlags" role="enum">
<title>enum CamelMessageFlags</title>
<indexterm zone="CamelMessageFlags"><primary>CamelMessageFlags</primary></indexterm><programlisting>typedef enum _CamelMessageFlags {
CAMEL_MESSAGE_ANSWERED = 1<<0,
CAMEL_MESSAGE_DELETED = 1<<1,
CAMEL_MESSAGE_DRAFT = 1<<2,
CAMEL_MESSAGE_FLAGGED = 1<<3,
CAMEL_MESSAGE_SEEN = 1<<4,
/* these aren't really system flag bits, but are convenience flags */
CAMEL_MESSAGE_ATTACHMENTS = 1<<5,
CAMEL_MESSAGE_ANSWERED_ALL = 1<<6,
CAMEL_MESSAGE_JUNK = 1<<7,
CAMEL_MESSAGE_SECURE = 1<<8,
CAMEL_MESSAGE_USER_NOT_DELETABLE = 1<<9,
CAMEL_MESSAGE_HIDDEN = 1<<10,
CAMEL_MESSAGE_NOTJUNK = 1<<11,
/* following flags are for the folder, and are not really permanent flags */
CAMEL_MESSAGE_FOLDER_FLAGGED = 1<<16, /* for use by the folder implementation */
/* flags after 1<<16 are used by camel providers,
if adding non permanent flags, add them to the end */
CAMEL_MESSAGE_JUNK_LEARN = 1<<30, /* used when setting CAMEL_MESSAGE_JUNK flag
to say that we request junk plugin
to learn that message as junk/non junk */
CAMEL_MESSAGE_USER = 1<<31 /* supports user flags */
} CamelMessageFlags;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CAMEL-MESSAGE-SYSTEM-MASK:CAPS" role="macro">
<title>CAMEL_MESSAGE_SYSTEM_MASK</title>
<indexterm zone="CAMEL-MESSAGE-SYSTEM-MASK:CAPS"><primary>CAMEL_MESSAGE_SYSTEM_MASK</primary></indexterm><programlisting>#define CAMEL_MESSAGE_SYSTEM_MASK (0xffff << 16)
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelFlag" role="struct">
<title>CamelFlag</title>
<indexterm zone="CamelFlag"><primary>CamelFlag</primary></indexterm><programlisting>typedef struct {
struct _CamelFlag *next;
char name[1]; /* name allocated as part of the structure */
} CamelFlag;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelTag" role="struct">
<title>CamelTag</title>
<indexterm zone="CamelTag"><primary>CamelTag</primary></indexterm><programlisting>typedef struct {
struct _CamelTag *next;
char *value;
char name[1]; /* name allocated as part of the structure */
} CamelTag;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelSummaryMessageID" role="struct">
<title>CamelSummaryMessageID</title>
<indexterm zone="CamelSummaryMessageID"><primary>CamelSummaryMessageID</primary></indexterm><programlisting>typedef struct {
union {
guint64 id;
unsigned char hash[8];
struct {
guint32 hi;
guint32 lo;
} part;
} id;
} CamelSummaryMessageID;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelSummaryReferences" role="struct">
<title>CamelSummaryReferences</title>
<indexterm zone="CamelSummaryReferences"><primary>CamelSummaryReferences</primary></indexterm><programlisting>typedef struct {
int size;
CamelSummaryMessageID references[1];
} CamelSummaryReferences;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelFolderSummaryFlags" role="enum">
<title>enum CamelFolderSummaryFlags</title>
<indexterm zone="CamelFolderSummaryFlags"><primary>CamelFolderSummaryFlags</primary></indexterm><programlisting>typedef enum _CamelFolderSummaryFlags {
CAMEL_SUMMARY_DIRTY = 1<<0
} CamelFolderSummaryFlags;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-folder-summary-new" role="function">
<title>camel_folder_summary_new ()</title>
<indexterm zone="camel-folder-summary-new"><primary>camel_folder_summary_new</primary></indexterm><programlisting><link linkend="CamelFolderSummary">CamelFolderSummary</link>* camel_folder_summary_new (<link linkend="struct--CamelFolder">struct _CamelFolder</link> *folder);</programlisting>
<para>
Create a new <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>folder</parameter> :</term>
<listitem><simpara> parent <link linkend="CamelFolder"><type>CamelFolder</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-set-filename" role="function">
<title>camel_folder_summary_set_filename ()</title>
<indexterm zone="camel-folder-summary-set-filename"><primary>camel_folder_summary_set_filename</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_set_filename (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *filename);</programlisting>
<para>
Set the filename where the summary will be loaded to/saved from.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> a filename
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-set-index" role="function">
<title>camel_folder_summary_set_index ()</title>
<indexterm zone="camel-folder-summary-set-index"><primary>camel_folder_summary_set_index</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_set_index (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelIndex">CamelIndex</link> *index);</programlisting>
<para>
Set the index used to index body content. If the index is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, or
not set (the default), no indexing of body content will take place.
</para>
<para>
Unlike earlier behaviour, build_content need not be set to perform indexing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter> :</term>
<listitem><simpara> a <link linkend="CamelIndex"><type>CamelIndex</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-set-build-content" role="function">
<title>camel_folder_summary_set_build_content ()</title>
<indexterm zone="camel-folder-summary-set-build-content"><primary>camel_folder_summary_set_build_content</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_set_build_content
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="gboolean">gboolean</link> state);</programlisting>
<para>
Set a flag to tell the summary to build the content info summary
(<link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>.content). The default is not to build content
info summaries.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> to build or not to build the content
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-next-uid" role="function">
<title>camel_folder_summary_next_uid ()</title>
<indexterm zone="camel-folder-summary-next-uid"><primary>camel_folder_summary_next_uid</primary></indexterm><programlisting><link linkend="guint32">guint32</link> camel_folder_summary_next_uid (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Generate a new unique uid value as an integer. This
may be used to create a unique sequence of numbers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the next unique uid value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-next-uid-string" role="function">
<title>camel_folder_summary_next_uid_string ()</title>
<indexterm zone="camel-folder-summary-next-uid-string"><primary>camel_folder_summary_next_uid_string</primary></indexterm><programlisting><link linkend="char">char</link>* camel_folder_summary_next_uid_string
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Retrieve the next uid, but as a formatted string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the next uid as an unsigned integer string.
This string must be freed by the caller.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-set-uid" role="function">
<title>camel_folder_summary_set_uid ()</title>
<indexterm zone="camel-folder-summary-set-uid"><primary>camel_folder_summary_set_uid</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_set_uid (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="guint32">guint32</link> uid);</programlisting>
<para>
Set the next minimum uid available. This can be used to
ensure new uid's do not clash with existing uid's.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter> :</term>
<listitem><simpara> The next minimum uid to assign. To avoid clashing
uid's, set this to the uid of a given messages + 1.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-load" role="function">
<title>camel_folder_summary_load ()</title>
<indexterm zone="camel-folder-summary-load"><primary>camel_folder_summary_load</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_load (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Load the summary from disk.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%0 on success or <link linkend="1:CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-save" role="function">
<title>camel_folder_summary_save ()</title>
<indexterm zone="camel-folder-summary-save"><primary>camel_folder_summary_save</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_save (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Writes the summary to disk. The summary is only written if changes
have occured.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%0 on success or <link linkend="1:CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-header-load" role="function">
<title>camel_folder_summary_header_load ()</title>
<indexterm zone="camel-folder-summary-header-load"><primary>camel_folder_summary_header_load</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_header_load (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Only load the header information from the summary,
keep the rest on disk. This should only be done on
a fresh summary object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%0 on success or <link linkend="1:CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-touch" role="function">
<title>camel_folder_summary_touch ()</title>
<indexterm zone="camel-folder-summary-touch"><primary>camel_folder_summary_touch</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_touch (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Mark the summary as changed, so that a save will force it to be
written back to disk.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-add" role="function">
<title>camel_folder_summary_add ()</title>
<indexterm zone="camel-folder-summary-add"><primary>camel_folder_summary_add</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_add (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);</programlisting>
<para>
Adds a new <parameter>info</parameter> record to the summary. If <parameter>info->uid</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>,
then a new uid is automatically re-assigned by calling
<link linkend="camel-folder-summary-next-uid-string"><type>camel_folder_summary_next_uid_string</type></link>.
</para>
<para>
The <parameter>info</parameter> record should have been generated by calling one of the
info_new_*() functions, as it will be free'd based on the summary
class. And MUST NOT be allocated directly using malloc.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-add-from-header" role="function">
<title>camel_folder_summary_add_from_header ()</title>
<indexterm zone="camel-folder-summary-add-from-header"><primary>camel_folder_summary_add_from_header</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_add_from_header
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *headers);</programlisting>
<para>
Build a new info record based on a set of headers, and add it to
the summary.
</para>
<para>
Note that this function should not be used if build_content_info
has been specified for this summary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>headers</parameter> :</term>
<listitem><simpara> rfc822 headers
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly added record
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-add-from-parser" role="function">
<title>camel_folder_summary_add_from_parser ()</title>
<indexterm zone="camel-folder-summary-add-from-parser"><primary>camel_folder_summary_add_from_parser</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_add_from_parser
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeParser">CamelMimeParser</link> *parser);</programlisting>
<para>
Build a new info record based on the current position of a <link linkend="CamelMimeParser"><type>CamelMimeParser</type></link>.
</para>
<para>
The parser should be positioned before the start of the message to summarise.
This function may be used if build_contnet_info or an index has been
specified for the summary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMimeParser"><type>CamelMimeParser</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly added record
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-add-from-message" role="function">
<title>camel_folder_summary_add_from_message ()</title>
<indexterm zone="camel-folder-summary-add-from-message"><primary>camel_folder_summary_add_from_message</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_add_from_message
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
<para>
Add a summary item from an existing message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly added record
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-info-new-from-header" role="function">
<title>camel_folder_summary_info_new_from_header ()</title>
<indexterm zone="camel-folder-summary-info-new-from-header"><primary>camel_folder_summary_info_new_from_header</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_info_new_from_header
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *headers);</programlisting>
<para>
Create a new info record from a header.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>headers</parameter> :</term>
<listitem><simpara> rfc822 headers
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly allocated record which must be freed with
<link linkend="camel-message-info-free"><type>camel_message_info_free</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-info-new-from-parser" role="function">
<title>camel_folder_summary_info_new_from_parser ()</title>
<indexterm zone="camel-folder-summary-info-new-from-parser"><primary>camel_folder_summary_info_new_from_parser</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_info_new_from_parser
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeParser">CamelMimeParser</link> *parser);</programlisting>
<para>
Create a new info record from a parser. If the parser cannot
determine a uid, then none will be assigned.
</para>
<para>
If indexing is enabled, and the parser cannot determine a new uid, then
one is automatically assigned.
</para>
<para>
If indexing is enabled, then the content will be indexed based
on this new uid. In this case, the message info MUST be
added using :<link linkend="add"><function>add()</function></link>.
</para>
<para>
Once complete, the parser will be positioned at the end of
the message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parser</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMimeParser"><type>CamelMimeParser</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly allocated record which must be freed with
<link linkend="camel-message-info-free"><type>camel_message_info_free</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-info-new-from-message" role="function">
<title>camel_folder_summary_info_new_from_message ()</title>
<indexterm zone="camel-folder-summary-info-new-from-message"><primary>camel_folder_summary_info_new_from_message</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_info_new_from_message
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMimeMessage">CamelMimeMessage</link> *message);</programlisting>
<para>
Create a summary item from a message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFodlerSummary"><type>CamelFodlerSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMimeMessage"><type>CamelMimeMessage</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the newly allocated record which must be freed using
<link linkend="camel-message-info-free"><type>camel_message_info_free</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-content-info-new" role="function">
<title>camel_folder_summary_content_info_new ()</title>
<indexterm zone="camel-folder-summary-content-info-new"><primary>camel_folder_summary_content_info_new</primary></indexterm><programlisting><link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link>* camel_folder_summary_content_info_new
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Allocate a new <link linkend="CamelMessageContentInfo"><type>CamelMessageContentInfo</type></link>, suitable for adding
to this summary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a newly allocated <link linkend="CamelMessageContentInfo"><type>CamelMessageContentInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-content-info-free" role="function">
<title>camel_folder_summary_content_info_free ()</title>
<indexterm zone="camel-folder-summary-content-info-free"><primary>camel_folder_summary_content_info_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_content_info_free
(<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link> *ci);</programlisting>
<para>
Free the content info <parameter>ci</parameter>, and all associated memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ci</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageContentInfo"><type>CamelMessageContentInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-remove" role="function">
<title>camel_folder_summary_remove ()</title>
<indexterm zone="camel-folder-summary-remove"><primary>camel_folder_summary_remove</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_remove (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="CamelMessageInfo">CamelMessageInfo</link> *info);</programlisting>
<para>
Remove a specific <parameter>info</parameter> record from the summary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-remove-uid" role="function">
<title>camel_folder_summary_remove_uid ()</title>
<indexterm zone="camel-folder-summary-remove-uid"><primary>camel_folder_summary_remove_uid</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_remove_uid (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *uid);</programlisting>
<para>
Remove a specific info record from the summary, by <parameter>uid</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter> :</term>
<listitem><simpara> a uid
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-remove-index" role="function">
<title>camel_folder_summary_remove_index ()</title>
<indexterm zone="camel-folder-summary-remove-index"><primary>camel_folder_summary_remove_index</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_remove_index (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> index);</programlisting>
<para>
Remove a specific info record from the summary, by index.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter> :</term>
<listitem><simpara> record index
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-remove-range" role="function">
<title>camel_folder_summary_remove_range ()</title>
<indexterm zone="camel-folder-summary-remove-range"><primary>camel_folder_summary_remove_range</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_remove_range (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> start,
<link linkend="int">int</link> end);</programlisting>
<para>
Removes an indexed range of info records.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter> :</term>
<listitem><simpara> initial index
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter> :</term>
<listitem><simpara> last index to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-clear" role="function">
<title>camel_folder_summary_clear ()</title>
<indexterm zone="camel-folder-summary-clear"><primary>camel_folder_summary_clear</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_clear (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Empty the summary contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-count" role="function">
<title>camel_folder_summary_count ()</title>
<indexterm zone="camel-folder-summary-count"><primary>camel_folder_summary_count</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_count (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Get the number of summary items stored in this summary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the number of items in the summary
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-index" role="function">
<title>camel_folder_summary_index ()</title>
<indexterm zone="camel-folder-summary-index"><primary>camel_folder_summary_index</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_index (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="int">int</link> index);</programlisting>
<para>
Retrieve a summary item by index number.
</para>
<para>
A referenced to the summary item is returned, which may be
ref'd or free'd as appropriate.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index</parameter> :</term>
<listitem><simpara> item index
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the summary item, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>index</parameter> is out of range
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-uid" role="function">
<title>camel_folder_summary_uid ()</title>
<indexterm zone="camel-folder-summary-uid"><primary>camel_folder_summary_uid</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_folder_summary_uid (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
const <link linkend="char">char</link> *uid);</programlisting>
<para>
Retrieve a summary item by uid.
</para>
<para>
A referenced to the summary item is returned, which may be
ref'd or free'd as appropriate.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter> :</term>
<listitem><simpara> a uid
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the summary item, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the uid <parameter>uid</parameter> is not available
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-array" role="function">
<title>camel_folder_summary_array ()</title>
<indexterm zone="camel-folder-summary-array"><primary>camel_folder_summary_array</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>* camel_folder_summary_array (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Obtain a copy of the summary array. This is done atomically,
so cannot contain empty entries.
</para>
<para>
It must be freed using <link linkend="camel-folder-summary-array-free"><type>camel_folder_summary_array_free</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a <link linkend="GPtrArray"><type>GPtrArray</type></link> of <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link> items
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-array-free" role="function">
<title>camel_folder_summary_array_free ()</title>
<indexterm zone="camel-folder-summary-array-free"><primary>camel_folder_summary_array_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_folder_summary_array_free (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="GPtrArray">GPtrArray</link> *array);</programlisting>
<para>
Free the folder summary array.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> array of <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link> items as returned from <link linkend="camel-folder-summary-array"><type>camel_folder_summary_array</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-encode-token" role="function">
<title>camel_folder_summary_encode_token ()</title>
<indexterm zone="camel-folder-summary-encode-token"><primary>camel_folder_summary_encode_token</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_encode_token (<link linkend="FILE:CAPS">FILE</link> *out,
const <link linkend="char">char</link> *str);</programlisting>
<para>
Encode a string value, but use tokenisation and compression
to reduce the size taken for common mailer words. This
can still be used to encode normal strings as well.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> output FILE pointer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> string token to encode
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%0 on success or <link linkend="1:CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-folder-summary-decode-token" role="function">
<title>camel_folder_summary_decode_token ()</title>
<indexterm zone="camel-folder-summary-decode-token"><primary>camel_folder_summary_decode_token</primary></indexterm><programlisting><link linkend="int">int</link> camel_folder_summary_decode_token (<link linkend="FILE:CAPS">FILE</link> *in,
<link linkend="char">char</link> **str);</programlisting>
<para>
Decode a token value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> input FILE pointer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> string pointer to hold the decoded result
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%0 on success or <link linkend="1:CAPS"><literal>-1</literal></link> on fail
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-flag-get" role="function">
<title>camel_flag_get ()</title>
<indexterm zone="camel-flag-get"><primary>camel_flag_get</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_flag_get (<link linkend="CamelFlag">CamelFlag</link> **list,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Find the state of the flag <parameter>name</parameter> in <parameter>list</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelFlag"><type>CamelFlag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the flag to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the state of the flag (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-flag-set" role="function">
<title>camel_flag_set ()</title>
<indexterm zone="camel-flag-set"><primary>camel_flag_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_flag_set (<link linkend="CamelFlag">CamelFlag</link> **list,
const <link linkend="char">char</link> *name,
<link linkend="gboolean">gboolean</link> state);</programlisting>
<para>
Set the state of a flag <parameter>name</parameter> in the list <parameter>list</parameter> to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelFlag"><type>CamelFlag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the flag to set or change
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the value of the flag has been changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-flag-list-copy" role="function">
<title>camel_flag_list_copy ()</title>
<indexterm zone="camel-flag-list-copy"><primary>camel_flag_list_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_flag_list_copy (<link linkend="CamelFlag">CamelFlag</link> **to,
<link linkend="CamelFlag">CamelFlag</link> **from);</programlisting>
<para>
Copy a flag list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>to</parameter> :</term>
<listitem><simpara> the address of the <link linkend="CamelFlag"><type>CamelFlag</type></link> list to copy to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>from</parameter> :</term>
<listitem><simpara> the address of the <link linkend="CamelFlag"><type>CamelFlag</type></link> list to copy from
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if <parameter>to</parameter> is changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-flag-list-size" role="function">
<title>camel_flag_list_size ()</title>
<indexterm zone="camel-flag-list-size"><primary>camel_flag_list_size</primary></indexterm><programlisting><link linkend="int">int</link> camel_flag_list_size (<link linkend="CamelFlag">CamelFlag</link> **list);</programlisting>
<para>
Get the length of the flag list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelFlag"><type>CamelFlag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the number of flags in the list
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-flag-list-free" role="function">
<title>camel_flag_list_free ()</title>
<indexterm zone="camel-flag-list-free"><primary>camel_flag_list_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_flag_list_free (<link linkend="CamelFlag">CamelFlag</link> **list);</programlisting>
<para>
Free the memory associated with the flag list <parameter>list</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelFlag"><type>CamelFlag</type></link> list
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-system-flag" role="function">
<title>camel_system_flag ()</title>
<indexterm zone="camel-system-flag"><primary>camel_system_flag</primary></indexterm><programlisting><link linkend="guint32">guint32</link> camel_system_flag (const <link linkend="char">char</link> *name);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of a system flag
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the integer value of the system flag string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-system-flag-get" role="function">
<title>camel_system_flag_get ()</title>
<indexterm zone="camel-system-flag-get"><primary>camel_system_flag_get</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_system_flag_get (<link linkend="guint32">guint32</link> flags,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Find the state of the flag <parameter>name</parameter> in <parameter>flags</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> bitwise system flags
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the flag to check for
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the named flag is set or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tag-get" role="function">
<title>camel_tag_get ()</title>
<indexterm zone="camel-tag-get"><primary>camel_tag_get</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_tag_get (<link linkend="CamelTag">CamelTag</link> **list,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Find the flag <parameter>name</parameter> in <parameter>list</parameter> and get the value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelTag"><type>CamelTag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the tag to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the value of the flag or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if unset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tag-set" role="function">
<title>camel_tag_set ()</title>
<indexterm zone="camel-tag-set"><primary>camel_tag_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_tag_set (<link linkend="CamelTag">CamelTag</link> **list,
const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *value);</programlisting>
<para>
Set the tag <parameter>name</parameter> in the tag list <parameter>list</parameter> to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelTag"><type>CamelTag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the tag to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value to set on the tag
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the value on the tag changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tag-list-copy" role="function">
<title>camel_tag_list_copy ()</title>
<indexterm zone="camel-tag-list-copy"><primary>camel_tag_list_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_tag_list_copy (<link linkend="CamelTag">CamelTag</link> **to,
<link linkend="CamelTag">CamelTag</link> **from);</programlisting>
<para>
Copy a tag list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>to</parameter> :</term>
<listitem><simpara> the address of the <link linkend="CamelTag"><type>CamelTag</type></link> list to copy to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>from</parameter> :</term>
<listitem><simpara> the address of the <link linkend="CamelTag"><type>CamelTag</type></link> list to copy from
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if <parameter>to</parameter> is changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tag-list-size" role="function">
<title>camel_tag_list_size ()</title>
<indexterm zone="camel-tag-list-size"><primary>camel_tag_list_size</primary></indexterm><programlisting><link linkend="int">int</link> camel_tag_list_size (<link linkend="CamelTag">CamelTag</link> **list);</programlisting>
<para>
Get the number of tags present in the tag list <parameter>list</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelTag"><type>CamelTag</type></link> list
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the number of tags
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tag-list-free" role="function">
<title>camel_tag_list_free ()</title>
<indexterm zone="camel-tag-list-free"><primary>camel_tag_list_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_tag_list_free (<link linkend="CamelTag">CamelTag</link> **list);</programlisting>
<para>
Free the tag list <parameter>list</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> the address of a <link linkend="CamelTag"><type>CamelTag</type></link> list
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-new" role="function">
<title>camel_message_info_new ()</title>
<indexterm zone="camel-message-info-new"><primary>camel_message_info_new</primary></indexterm><programlisting><link linkend="void">void</link>* camel_message_info_new (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary);</programlisting>
<para>
Create a new <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-ref" role="function">
<title>camel_message_info_ref ()</title>
<indexterm zone="camel-message-info-ref"><primary>camel_message_info_ref</primary></indexterm><programlisting><link linkend="void">void</link> camel_message_info_ref (<link linkend="void">void</link> *info);</programlisting>
<para>
Reference an info.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-new-from-header" role="function">
<title>camel_message_info_new_from_header ()</title>
<indexterm zone="camel-message-info-new-from-header"><primary>camel_message_info_new_from_header</primary></indexterm><programlisting><link linkend="CamelMessageInfo">CamelMessageInfo</link>* camel_message_info_new_from_header (<link linkend="CamelFolderSummary">CamelFolderSummary</link> *summary,
<link linkend="struct--camel-header-raw">struct _camel_header_raw</link> *header);</programlisting>
<para>
Create a new <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link> pre-populated with info from
<parameter>header</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>summary</parameter> :</term>
<listitem><simpara> a <link linkend="CamelFolderSummary"><type>CamelFolderSummary</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> raw header
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-free" role="function">
<title>camel_message_info_free ()</title>
<indexterm zone="camel-message-info-free"><primary>camel_message_info_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_message_info_free (<link linkend="void">void</link> *info);</programlisting>
<para>
Unref's and potentially frees a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link> and its contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-clone" role="function">
<title>camel_message_info_clone ()</title>
<indexterm zone="camel-message-info-clone"><primary>camel_message_info_clone</primary></indexterm><programlisting><link linkend="void">void</link>* camel_message_info_clone (const <link linkend="void">void</link> *info);</programlisting>
<para>
Duplicate a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the duplicated <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-ptr" role="function">
<title>camel_message_info_ptr ()</title>
<indexterm zone="camel-message-info-ptr"><primary>camel_message_info_ptr</primary></indexterm><programlisting>const <link linkend="void">void</link>* camel_message_info_ptr (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);</programlisting>
<para>
Generic accessor method for getting pointer data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> info to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the pointer data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-uint32" role="function">
<title>camel_message_info_uint32 ()</title>
<indexterm zone="camel-message-info-uint32"><primary>camel_message_info_uint32</primary></indexterm><programlisting><link linkend="guint32">guint32</link> camel_message_info_uint32 (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);</programlisting>
<para>
Generic accessor method for getting 32bit int data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> info to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the int data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-time" role="function">
<title>camel_message_info_time ()</title>
<indexterm zone="camel-message-info-time"><primary>camel_message_info_time</primary></indexterm><programlisting><link linkend="time-t">time_t</link> camel_message_info_time (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="int">int</link> id);</programlisting>
<para>
Generic accessor method for getting time_t data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> info to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the time_t data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-uid" role="macro">
<title>camel_message_info_uid()</title>
<indexterm zone="camel-message-info-uid"><primary>camel_message_info_uid</primary></indexterm><programlisting>#define camel_message_info_uid(mi) ((const char *)((const CamelMessageInfo *)mi)->uid)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-subject" role="macro">
<title>camel_message_info_subject()</title>
<indexterm zone="camel-message-info-subject"><primary>camel_message_info_subject</primary></indexterm><programlisting>#define camel_message_info_subject(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SUBJECT))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-from" role="macro">
<title>camel_message_info_from()</title>
<indexterm zone="camel-message-info-from"><primary>camel_message_info_from</primary></indexterm><programlisting>#define camel_message_info_from(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FROM))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-to" role="macro">
<title>camel_message_info_to()</title>
<indexterm zone="camel-message-info-to"><primary>camel_message_info_to</primary></indexterm><programlisting>#define camel_message_info_to(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_TO))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-cc" role="macro">
<title>camel_message_info_cc()</title>
<indexterm zone="camel-message-info-cc"><primary>camel_message_info_cc</primary></indexterm><programlisting>#define camel_message_info_cc(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_CC))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-mlist" role="macro">
<title>camel_message_info_mlist()</title>
<indexterm zone="camel-message-info-mlist"><primary>camel_message_info_mlist</primary></indexterm><programlisting>#define camel_message_info_mlist(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MLIST))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-flags" role="macro">
<title>camel_message_info_flags()</title>
<indexterm zone="camel-message-info-flags"><primary>camel_message_info_flags</primary></indexterm><programlisting>#define camel_message_info_flags(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FLAGS)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-size" role="macro">
<title>camel_message_info_size()</title>
<indexterm zone="camel-message-info-size"><primary>camel_message_info_size</primary></indexterm><programlisting>#define camel_message_info_size(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SIZE)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-date-sent" role="macro">
<title>camel_message_info_date_sent()</title>
<indexterm zone="camel-message-info-date-sent"><primary>camel_message_info_date_sent</primary></indexterm><programlisting>#define camel_message_info_date_sent(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_SENT)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-date-received" role="macro">
<title>camel_message_info_date_received()</title>
<indexterm zone="camel-message-info-date-received"><primary>camel_message_info_date_received</primary></indexterm><programlisting>#define camel_message_info_date_received(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_RECEIVED)
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-message-id" role="macro">
<title>camel_message_info_message_id()</title>
<indexterm zone="camel-message-info-message-id"><primary>camel_message_info_message_id</primary></indexterm><programlisting>#define camel_message_info_message_id(mi) ((const CamelSummaryMessageID *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MESSAGE_ID))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-references" role="macro">
<title>camel_message_info_references()</title>
<indexterm zone="camel-message-info-references"><primary>camel_message_info_references</primary></indexterm><programlisting>#define camel_message_info_references(mi) ((const CamelSummaryReferences *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_REFERENCES))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-user-flags" role="macro">
<title>camel_message_info_user_flags()</title>
<indexterm zone="camel-message-info-user-flags"><primary>camel_message_info_user_flags</primary></indexterm><programlisting>#define camel_message_info_user_flags(mi) ((const CamelFlag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_FLAGS))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-user-tags" role="macro">
<title>camel_message_info_user_tags()</title>
<indexterm zone="camel-message-info-user-tags"><primary>camel_message_info_user_tags</primary></indexterm><programlisting>#define camel_message_info_user_tags(mi) ((const CamelTag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_TAGS))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-user-flag" role="function">
<title>camel_message_info_user_flag ()</title>
<indexterm zone="camel-message-info-user-flag"><primary>camel_message_info_user_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_message_info_user_flag (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id);</programlisting>
<para>
Get the state of a user flag named <parameter>id</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> user flag to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the state of the user flag
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-user-tag" role="function">
<title>camel_message_info_user_tag ()</title>
<indexterm zone="camel-message-info-user-tag"><primary>camel_message_info_user_tag</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_message_info_user_tag (const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id);</programlisting>
<para>
Get the value of a user tag named <parameter>id</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> user tag to get
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the value of the user tag
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-set-flags" role="function">
<title>camel_message_info_set_flags ()</title>
<indexterm zone="camel-message-info-set-flags"><primary>camel_message_info_set_flags</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_message_info_set_flags (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
<link linkend="guint32">guint32</link> mask,
<link linkend="guint32">guint32</link> set);</programlisting>
<para>
Change the state of the system flags on the <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>set</parameter> :</term>
<listitem><simpara> state the flags should be changed to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if any of the flags changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-set-user-flag" role="function">
<title>camel_message_info_set_user_flag ()</title>
<indexterm zone="camel-message-info-set-user-flag"><primary>camel_message_info_set_user_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_message_info_set_user_flag (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id,
<link linkend="gboolean">gboolean</link> state);</programlisting>
<para>
Set the state of a user flag on a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> name of the user flag to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> state to set the flag to
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the state changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-set-user-tag" role="function">
<title>camel_message_info_set_user_tag ()</title>
<indexterm zone="camel-message-info-set-user-tag"><primary>camel_message_info_set_user_tag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_message_info_set_user_tag (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi,
const <link linkend="char">char</link> *id,
const <link linkend="char">char</link> *val);</programlisting>
<para>
Set the value of a user tag on a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara> a <link linkend="CamelMessageInfo"><type>CamelMessageInfo</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> name of the user tag to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter> :</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the value changed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-content-info-dump" role="function">
<title>camel_content_info_dump ()</title>
<indexterm zone="camel-content-info-dump"><primary>camel_content_info_dump</primary></indexterm><programlisting><link linkend="void">void</link> camel_content_info_dump (<link linkend="CamelMessageContentInfo">CamelMessageContentInfo</link> *ci,
<link linkend="int">int</link> depth);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ci</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-message-info-dump" role="function">
<title>camel_message_info_dump ()</title>
<indexterm zone="camel-message-info-dump"><primary>camel_message_info_dump</primary></indexterm><programlisting><link linkend="void">void</link> camel_message_info_dump (<link linkend="CamelMessageInfo">CamelMessageInfo</link> *mi);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mi</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|