/usr/include/libetpan/mailimap_types.h is in libetpan-dev 1.6-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 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 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 | /*
* libEtPan! -- a mail stuff library
*
* Copyright (C) 2001, 2005 - DINH Viet Hoa
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the libEtPan! project nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* $Id: mailimap_types.h,v 1.34 2011/01/06 00:09:52 hoa Exp $
*/
/*
IMAP4rev1 grammar
address = "(" addr-name SP addr-adl SP addr-mailbox SP
addr-host ")"
addr-adl = nstring
; Holds route from [RFC-822] route-addr if
; non-NIL
addr-host = nstring
; NIL indicates [RFC-822] group syntax.
; Otherwise, holds [RFC-822] domain name
addr-mailbox = nstring
; NIL indicates end of [RFC-822] group; if
; non-NIL and addr-host is NIL, holds
; [RFC-822] group name.
; Otherwise, holds [RFC-822] local-part
; after removing [RFC-822] quoting
addr-name = nstring
; If non-NIL, holds phrase from [RFC-822]
; mailbox after removing [RFC-822] quoting
append = "APPEND" SP mailbox [SP flag-list] [SP date-time] SP
literal
astring = 1*ASTRING-CHAR / string
ASTRING-CHAR = ATOM-CHAR / resp-specials
atom = 1*ATOM-CHAR
ATOM-CHAR = <any CHAR except atom-specials>
atom-specials = "(" / ")" / "{" / SP / CTL / list-wildcards /
quoted-specials / resp-specials
authenticate = "AUTHENTICATE" SP auth-type *(CRLF base64)
auth-type = atom
; Defined by [SASL]
base64 = *(4base64-char) [base64-terminal]
base64-char = ALPHA / DIGIT / "+" / "/"
; Case-sensitive
base64-terminal = (2base64-char "==") / (3base64-char "=")
body = "(" (body-type-1part / body-type-mpart) ")"
body-extension = nstring / number /
"(" body-extension *(SP body-extension) ")"
; Future expansion. Client implementations
; MUST accept body-extension fields. Server
; implementations MUST NOT generate
; body-extension fields except as defined by
; future standard or standards-track
; revisions of this specification.
body-ext-1part = body-fld-md5 [SP body-fld-dsp [SP body-fld-lang
*(SP body-extension)]]
; MUST NOT be returned on non-extensible
; "BODY" fetch
body-ext-mpart = body-fld-param [SP body-fld-dsp [SP body-fld-lang
*(SP body-extension)]]
; MUST NOT be returned on non-extensible
; "BODY" fetch
body-fields = body-fld-param SP body-fld-id SP body-fld-desc SP
body-fld-enc SP body-fld-octets
body-fld-desc = nstring
body-fld-dsp = "(" string SP body-fld-param ")" / nil
body-fld-enc = (DQUOTE ("7BIT" / "8BIT" / "BINARY" / "BASE64"/
"QUOTED-PRINTABLE") DQUOTE) / string
body-fld-id = nstring
body-fld-lang = nstring / "(" string *(SP string) ")"
body-fld-lines = number
body-fld-md5 = nstring
body-fld-octets = number
body-fld-param = "(" string SP string *(SP string SP string) ")" / nil
body-type-1part = (body-type-basic / body-type-msg / body-type-text)
[SP body-ext-1part]
body-type-basic = media-basic SP body-fields
; MESSAGE subtype MUST NOT be "RFC822"
body-type-mpart = 1*body SP media-subtype
[SP body-ext-mpart]
body-type-msg = media-message SP body-fields SP envelope
SP body SP body-fld-lines
body-type-text = media-text SP body-fields SP body-fld-lines
capability = ("AUTH=" auth-type) / atom
; New capabilities MUST begin with "X" or be
; registered with IANA as standard or
; standards-track
capability-data = "CAPABILITY" *(SP capability) SP "IMAP4rev1"
*(SP capability)
; IMAP4rev1 servers which offer RFC 1730
; compatibility MUST list "IMAP4" as the first
; capability.
CHAR8 = %x01-ff
; any OCTET except NUL, %x00
command = tag SP (command-any / command-auth / command-nonauth /
command-select) CRLF
; Modal based on state
command-any = "CAPABILITY" / "LOGOUT" / "NOOP" / x-command
; Valid in all states
command-auth = append / create / delete / examine / list / lsub /
rename / select / status / subscribe / unsubscribe
; Valid only in Authenticated or Selected state
command-nonauth = login / authenticate
; Valid only when in Not Authenticated state
command-select = "CHECK" / "CLOSE" / "EXPUNGE" / copy / fetch / store /
uid / search
; Valid only when in Selected state
continue-req = "+" SP (resp-text / base64) CRLF
copy = "COPY" SP set SP mailbox
create = "CREATE" SP mailbox
; Use of INBOX gives a NO error
date = date-text / DQUOTE date-text DQUOTE
date-day = 1*2DIGIT
; Day of month
date-day-fixed = (SP DIGIT) / 2DIGIT
; Fixed-format version of date-day
date-month = "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" /
"Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec"
date-text = date-day "-" date-month "-" date-year
date-year = 4DIGIT
date-time = DQUOTE date-day-fixed "-" date-month "-" date-year
SP time SP zone DQUOTE
delete = "DELETE" SP mailbox
; Use of INBOX gives a NO error
digit-nz = %x31-39
; 1-9
envelope = "(" env-date SP env-subject SP env-from SP env-sender SP
env-reply-to SP env-to SP env-cc SP env-bcc SP
env-in-reply-to SP env-message-id ")"
env-bcc = "(" 1*address ")" / nil
env-cc = "(" 1*address ")" / nil
env-date = nstring
env-from = "(" 1*address ")" / nil
env-in-reply-to = nstring
env-message-id = nstring
env-reply-to = "(" 1*address ")" / nil
env-sender = "(" 1*address ")" / nil
env-subject = nstring
env-to = "(" 1*address ")" / nil
examine = "EXAMINE" SP mailbox
fetch = "FETCH" SP set SP ("ALL" / "FULL" / "FAST" / fetch-att /
"(" fetch-att *(SP fetch-att) ")")
fetch-att = "ENVELOPE" / "FLAGS" / "INTERNALDATE" /
"RFC822" [".HEADER" / ".SIZE" / ".TEXT"] /
"BODY" ["STRUCTURE"] / "UID" /
"BODY" [".PEEK"] section ["<" number "." nz-number ">"]
flag = "\Answered" / "\Flagged" / "\Deleted" /
"\Seen" / "\Draft" / flag-keyword / flag-extension
; Does not include "\Recent"
flag-extension = "\" atom
; Future expansion. Client implementations
; MUST accept flag-extension flags. Server
; implementations MUST NOT generate
; flag-extension flags except as defined by
; future standard or standards-track
; revisions of this specification.
flag-fetch = flag / "\Recent"
flag-keyword = atom
flag-list = "(" [flag *(SP flag)] ")"
flag-perm = flag / "\*"
greeting = "*" SP (resp-cond-auth / resp-cond-bye) CRLF
header-fld-name = astring
header-list = "(" header-fld-name *(SP header-fld-name) ")"
list = "LIST" SP mailbox SP list-mailbox
list-mailbox = 1*list-char / string
list-char = ATOM-CHAR / list-wildcards / resp-specials
list-wildcards = "%" / "*"
literal = "{" number "}" CRLF *CHAR8
; Number represents the number of CHAR8s
login = "LOGIN" SP userid SP password
lsub = "LSUB" SP mailbox SP list-mailbox
mailbox = "INBOX" / astring
; INBOX is case-insensitive. All case variants of
; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX
; not as an astring. An astring which consists of
; the case-insensitive sequence "I" "N" "B" "O" "X"
; is considered to be INBOX and not an astring.
; Refer to section 5.1 for further
; semantic details of mailbox names.
mailbox-data = "FLAGS" SP flag-list / "LIST" SP mailbox-list /
"LSUB" SP mailbox-list / "SEARCH" *(SP nz-number) /
"STATUS" SP mailbox SP "("
[status-att SP number *(SP status-att SP number)] ")" /
number SP "EXISTS" / number SP "RECENT"
mailbox-list = "(" [mbx-list-flags] ")" SP
(DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
mbx-list-flags = *(mbx-list-oflag SP) mbx-list-sflag
*(SP mbx-list-oflag) /
mbx-list-oflag *(SP mbx-list-oflag)
mbx-list-oflag = "\Noinferiors" / flag-extension
; Other flags; multiple possible per LIST response
mbx-list-sflag = "\Noselect" / "\Marked" / "\Unmarked"
; Selectability flags; only one per LIST response
media-basic = ((DQUOTE ("APPLICATION" / "AUDIO" / "IMAGE" / "MESSAGE" /
"VIDEO") DQUOTE) / string) SP media-subtype
; Defined in [MIME-IMT]
media-message = DQUOTE "MESSAGE" DQUOTE SP DQUOTE "RFC822" DQUOTE
; Defined in [MIME-IMT]
media-subtype = string
; Defined in [MIME-IMT]
media-text = DQUOTE "TEXT" DQUOTE SP media-subtype
; Defined in [MIME-IMT]
message-data = nz-number SP ("EXPUNGE" / ("FETCH" SP msg-att))
msg-att = "(" (msg-att-dynamic / msg-att-static)
*(SP (msg-att-dynamic / msg-att-static)) ")"
msg-att-dynamic = "FLAGS" SP "(" [flag-fetch *(SP flag-fetch)] ")"
; MAY change for a message
msg-att-static = "ENVELOPE" SP envelope / "INTERNALDATE" SP date-time /
"RFC822" [".HEADER" / ".TEXT"] SP nstring /
"RFC822.SIZE" SP number / "BODY" ["STRUCTURE"] SP body /
"BODY" section ["<" number ">"] SP nstring /
"UID" SP uniqueid
; MUST NOT change for a message
nil = "NIL"
nstring = string / nil
number = 1*DIGIT
; Unsigned 32-bit integer
; (0 <= n < 4,294,967,296)
nz-number = digit-nz *DIGIT
; Non-zero unsigned 32-bit integer
; (0 < n < 4,294,967,296)
password = astring
quoted = DQUOTE *QUOTED-CHAR DQUOTE
QUOTED-CHAR = <any TEXT-CHAR except quoted-specials> /
"\" quoted-specials
quoted-specials = DQUOTE / "\"
rename = "RENAME" SP mailbox SP mailbox
; Use of INBOX as a destination gives a NO error
response = *(continue-req / response-data) response-done
response-data = "*" SP (resp-cond-state / resp-cond-bye /
mailbox-data / message-data / capability-data) CRLF
response-done = response-tagged / response-fatal
response-fatal = "*" SP resp-cond-bye CRLF
; Server closes connection immediately
response-tagged = tag SP resp-cond-state CRLF
resp-cond-auth = ("OK" / "PREAUTH") SP resp-text
; Authentication condition
resp-cond-bye = "BYE" SP resp-text
resp-cond-state = ("OK" / "NO" / "BAD") SP resp-text
; Status condition
resp-specials = "]"
resp-text = ["[" resp-text-code "]" SP] text
resp-text-code = "ALERT" /
"BADCHARSET" [SP "(" astring *(SP astring) ")" ] /
capability-data / "PARSE" /
"PERMANENTFLAGS" SP "(" [flag-perm *(SP flag-perm)] ")" /
"READ-ONLY" / "READ-WRITE" / "TRYCREATE" /
"UIDNEXT" SP nz-number / "UIDVALIDITY" SP nz-number /
"UNSEEN" SP nz-number /
atom [SP 1*<any TEXT-CHAR except "]">]
search = "SEARCH" [SP "CHARSET" SP astring] 1*(SP search-key)
; CHARSET argument to MUST be registered with IANA
search-key = "ALL" / "ANSWERED" / "BCC" SP astring /
"BEFORE" SP date / "BODY" SP astring /
"CC" SP astring / "DELETED" / "FLAGGED" /
"FROM" SP astring / "KEYWORD" SP flag-keyword / "NEW" /
"OLD" / "ON" SP date / "RECENT" / "SEEN" /
"SINCE" SP date / "SUBJECT" SP astring /
"TEXT" SP astring / "TO" SP astring /
"UNANSWERED" / "UNDELETED" / "UNFLAGGED" /
"UNKEYWORD" SP flag-keyword / "UNSEEN" /
; Above this line were in [IMAP2]
"DRAFT" / "HEADER" SP header-fld-name SP astring /
"LARGER" SP number / "NOT" SP search-key /
"OR" SP search-key SP search-key /
"SENTBEFORE" SP date / "SENTON" SP date /
"SENTSINCE" SP date / "SMALLER" SP number /
"UID" SP set / "UNDRAFT" / set /
"(" search-key *(SP search-key) ")"
section = "[" [section-spec] "]"
section-msgtext = "HEADER" / "HEADER.FIELDS" [".NOT"] SP header-list /
"TEXT"
; top-level or MESSAGE/RFC822 part
section-part = nz-number *("." nz-number)
; body part nesting
section-spec = section-msgtext / (section-part ["." section-text])
section-text = section-msgtext / "MIME"
; text other than actual body part (headers, etc.)
select = "SELECT" SP mailbox
sequence-num = nz-number / "*"
; * is the largest number in use. For message
; sequence numbers, it is the number of messages
; in the mailbox. For unique identifiers, it is
; the unique identifier of the last message in
; the mailbox.
set = sequence-num / (sequence-num ":" sequence-num) /
(set "," set)
; Identifies a set of messages. For message
; sequence numbers, these are consecutive
; numbers from 1 to the number of messages in
; the mailbox
; Comma delimits individual numbers, colon
; delimits between two numbers inclusive.
; Example: 2,4:7,9,12:* is 2,4,5,6,7,9,12,13,
; 14,15 for a mailbox with 15 messages.
status = "STATUS" SP mailbox SP "(" status-att *(SP status-att) ")"
status-att = "MESSAGES" / "RECENT" / "UIDNEXT" / "UIDVALIDITY" /
"UNSEEN"
store = "STORE" SP set SP store-att-flags
store-att-flags = (["+" / "-"] "FLAGS" [".SILENT"]) SP
(flag-list / (flag *(SP flag)))
string = quoted / literal
subscribe = "SUBSCRIBE" SP mailbox
tag = 1*<any ASTRING-CHAR except "+">
text = 1*TEXT-CHAR
TEXT-CHAR = <any CHAR except CR and LF>
time = 2DIGIT ":" 2DIGIT ":" 2DIGIT
; Hours minutes seconds
uid = "UID" SP (copy / fetch / search / store)
; Unique identifiers used instead of message
; sequence numbers
uniqueid = nz-number
; Strictly ascending
unsubscribe = "UNSUBSCRIBE" SP mailbox
userid = astring
x-command = "X" atom <experimental command arguments>
zone = ("+" / "-") 4DIGIT
; Signed four-digit value of hhmm representing
; hours and minutes east of Greenwich (that is,
; the amount that the given time differs from
; Universal Time). Subtracting the timezone
; from the given time will give the UT form.
; The Universal Time zone is "+0000".
*/
#ifndef MAILIMAP_TYPES_H
#define MAILIMAP_TYPES_H
#ifdef __cplusplus
extern "C" {
#endif
#include <libetpan/libetpan-config.h>
#include <libetpan/mailstream.h>
#include <libetpan/clist.h>
#include <stdbool.h>
/*
IMPORTANT NOTE:
All allocation functions will take as argument allocated data
and will store these data in the structure they will allocate.
Data should be persistant during all the use of the structure
and will be freed by the free function of the structure
allocation functions will return NULL on failure
*/
/*
mailimap_address represents a mail address
- personal_name is the name to display in an address
'"name"' in '"name" <address@domain>', should be allocated
with a malloc()
- source_route is the source-route information in the
mail address (RFC 822), should be allocated with a malloc()
- mailbox_name is the name of the mailbox 'address' in
'"name" <address@domain>', should be allocated with a malloc()
- host_name is the name of the host 'domain' in
'"name" <address@domain>', should be allocated with a malloc()
if mailbox_name is not NULL and host_name is NULL, this is the name
of a group, the next addresses in the list are elements of the group
until we reach an address with a NULL mailbox_name.
*/
struct mailimap_address {
char * ad_personal_name; /* can be NULL */
char * ad_source_route; /* can be NULL */
char * ad_mailbox_name; /* can be NULL */
char * ad_host_name; /* can be NULL */
};
struct mailimap_address *
mailimap_address_new(char * ad_personal_name, char * ad_source_route,
char * ad_mailbox_name, char * ad_host_name);
void mailimap_address_free(struct mailimap_address * addr);
/* this is the type of MIME body parsed by IMAP server */
enum {
MAILIMAP_BODY_ERROR,
MAILIMAP_BODY_1PART, /* single part */
MAILIMAP_BODY_MPART /* multi-part */
};
/*
mailimap_body represent a MIME body parsed by IMAP server
- type is the type of the MIME part (single part or multipart)
- body_1part is defined if this is a single part
- body_mpart is defined if this is a multipart
*/
struct mailimap_body {
int bd_type;
/* can be MAILIMAP_BODY_1PART or MAILIMAP_BODY_MPART */
union {
struct mailimap_body_type_1part * bd_body_1part; /* can be NULL */
struct mailimap_body_type_mpart * bd_body_mpart; /* can be NULL */
} bd_data;
};
struct mailimap_body *
mailimap_body_new(int bd_type,
struct mailimap_body_type_1part * bd_body_1part,
struct mailimap_body_type_mpart * bd_body_mpart);
void mailimap_body_free(struct mailimap_body * body);
/*
this is the type of MIME body extension
*/
enum {
MAILIMAP_BODY_EXTENSION_ERROR,
MAILIMAP_BODY_EXTENSION_NSTRING, /* string */
MAILIMAP_BODY_EXTENSION_NUMBER, /* number */
MAILIMAP_BODY_EXTENSION_LIST /* list of
(struct mailimap_body_extension *) */
};
/*
mailimap_body_extension is a future extension header field value
- type is the type of the body extension (string, number or
list of extension)
- nstring is a string value if the type is string
- number is a integer value if the type is number
- list is a list of body extension if the type is a list
*/
struct mailimap_body_extension {
int ext_type;
/*
can be MAILIMAP_BODY_EXTENSION_NSTRING, MAILIMAP_BODY_EXTENSION_NUMBER
or MAILIMAP_BODY_EXTENSION_LIST
*/
union {
char * ext_nstring; /* can be NULL */
uint32_t ext_number;
clist * ext_body_extension_list;
/* list of (struct mailimap_body_extension *) */
/* can be NULL */
} ext_data;
};
struct mailimap_body_extension *
mailimap_body_extension_new(int ext_type, char * ext_nstring,
uint32_t ext_number,
clist * ext_body_extension_list);
void mailimap_body_extension_free(struct mailimap_body_extension * be);
/*
mailimap_body_ext_1part is the extended result part of a single part
bodystructure.
- body_md5 is the value of the Content-MD5 header field, should be
allocated with malloc()
- body_disposition is the value of the Content-Disposition header field
- body_language is the value of the Content-Language header field
- body_extension_list is the list of extension fields value.
*/
struct mailimap_body_ext_1part {
char * bd_md5; /* can be NULL */
struct mailimap_body_fld_dsp * bd_disposition; /* can be NULL */
struct mailimap_body_fld_lang * bd_language; /* can be NULL */
char * bd_loc; /* can be NULL */
clist * bd_extension_list; /* list of (struct mailimap_body_extension *) */
/* can be NULL */
};
struct mailimap_body_ext_1part *
mailimap_body_ext_1part_new(char * bd_md5,
struct mailimap_body_fld_dsp * bd_disposition,
struct mailimap_body_fld_lang * bd_language,
char * bd_loc,
clist * bd_extension_list);
void
mailimap_body_ext_1part_free(struct mailimap_body_ext_1part * body_ext_1part);
/*
mailimap_body_ext_mpart is the extended result part of a multipart
bodystructure.
- body_parameter is the list of parameters of Content-Type header field
- body_disposition is the value of Content-Disposition header field
- body_language is the value of Content-Language header field
- body_extension_list is the list of extension fields value.
*/
struct mailimap_body_ext_mpart {
struct mailimap_body_fld_param * bd_parameter; /* can be NULL */
struct mailimap_body_fld_dsp * bd_disposition; /* can be NULL */
struct mailimap_body_fld_lang * bd_language; /* can be NULL */
char * bd_loc; /* can be NULL */
clist * bd_extension_list; /* list of (struct mailimap_body_extension *) */
/* can be NULL */
};
struct mailimap_body_ext_mpart *
mailimap_body_ext_mpart_new(struct mailimap_body_fld_param * bd_parameter,
struct mailimap_body_fld_dsp * bd_disposition,
struct mailimap_body_fld_lang * bd_language,
char * bd_loc,
clist * bd_extension_list);
void
mailimap_body_ext_mpart_free(struct mailimap_body_ext_mpart * body_ext_mpart);
/*
mailimap_body_fields is the MIME fields of a MIME part.
- body_parameter is the list of parameters of Content-Type header field
- body_id is the value of Content-ID header field, should be allocated
with malloc()
- body_description is the value of Content-Description header field,
should be allocated with malloc()
- body_encoding is the value of Content-Transfer-Encoding header field
- body_disposition is the value of Content-Disposition header field
- body_size is the size of the MIME part
*/
struct mailimap_body_fields {
struct mailimap_body_fld_param * bd_parameter; /* can be NULL */
char * bd_id; /* can be NULL */
char * bd_description; /* can be NULL */
struct mailimap_body_fld_enc * bd_encoding; /* != NULL */
uint32_t bd_size;
};
struct mailimap_body_fields *
mailimap_body_fields_new(struct mailimap_body_fld_param * bd_parameter,
char * bd_id,
char * bd_description,
struct mailimap_body_fld_enc * bd_encoding,
uint32_t bd_size);
void
mailimap_body_fields_free(struct mailimap_body_fields * body_fields);
/*
mailimap_body_fld_dsp is the parsed value of the Content-Disposition field
- disposition_type is the type of Content-Disposition
(usually attachment or inline), should be allocated with malloc()
- attributes is the list of Content-Disposition attributes
*/
struct mailimap_body_fld_dsp {
char * dsp_type; /* != NULL */
struct mailimap_body_fld_param * dsp_attributes; /* can be NULL */
};
struct mailimap_body_fld_dsp *
mailimap_body_fld_dsp_new(char * dsp_type,
struct mailimap_body_fld_param * dsp_attributes);
void mailimap_body_fld_dsp_free(struct mailimap_body_fld_dsp * bfd);
/* these are the different parsed values for Content-Transfer-Encoding */
enum {
MAILIMAP_BODY_FLD_ENC_7BIT, /* 7bit */
MAILIMAP_BODY_FLD_ENC_8BIT, /* 8bit */
MAILIMAP_BODY_FLD_ENC_BINARY, /* binary */
MAILIMAP_BODY_FLD_ENC_BASE64, /* base64 */
MAILIMAP_BODY_FLD_ENC_QUOTED_PRINTABLE, /* quoted-printable */
MAILIMAP_BODY_FLD_ENC_OTHER /* other */
};
/*
mailimap_body_fld_enc is a parsed value for Content-Transfer-Encoding
- type is the kind of Content-Transfer-Encoding, this can be
MAILIMAP_BODY_FLD_ENC_7BIT, MAILIMAP_BODY_FLD_ENC_8BIT,
MAILIMAP_BODY_FLD_ENC_BINARY, MAILIMAP_BODY_FLD_ENC_BASE64,
MAILIMAP_BODY_FLD_ENC_QUOTED_PRINTABLE or MAILIMAP_BODY_FLD_ENC_OTHER
- in case of MAILIMAP_BODY_FLD_ENC_OTHER, this value is defined,
should be allocated with malloc()
*/
struct mailimap_body_fld_enc {
int enc_type;
char * enc_value; /* can be NULL */
};
struct mailimap_body_fld_enc *
mailimap_body_fld_enc_new(int enc_type, char * enc_value);
void mailimap_body_fld_enc_free(struct mailimap_body_fld_enc * bfe);
/* this is the type of Content-Language header field value */
enum {
MAILIMAP_BODY_FLD_LANG_ERROR, /* error parse */
MAILIMAP_BODY_FLD_LANG_SINGLE, /* single value */
MAILIMAP_BODY_FLD_LANG_LIST /* list of values */
};
/*
mailimap_body_fld_lang is the parsed value of the Content-Language field
- type is the type of content, this can be MAILIMAP_BODY_FLD_LANG_SINGLE
if this is a single value or MAILIMAP_BODY_FLD_LANG_LIST if there are
several values
- single is the single value if the type is MAILIMAP_BODY_FLD_LANG_SINGLE,
should be allocated with malloc()
- list is the list of value if the type is MAILIMAP_BODY_FLD_LANG_LIST,
all elements of the list should be allocated with malloc()
*/
struct mailimap_body_fld_lang {
int lg_type;
union {
char * lg_single; /* can be NULL */
clist * lg_list; /* list of string (char *), can be NULL */
} lg_data;
};
struct mailimap_body_fld_lang *
mailimap_body_fld_lang_new(int lg_type, char * lg_single, clist * lg_list);
void
mailimap_body_fld_lang_free(struct mailimap_body_fld_lang * fld_lang);
/*
mailimap_single_body_fld_param is a body field parameter
- name is the name of the parameter, should be allocated with malloc()
- value is the value of the parameter, should be allocated with malloc()
*/
struct mailimap_single_body_fld_param {
char * pa_name; /* != NULL */
char * pa_value; /* != NULL */
};
struct mailimap_single_body_fld_param *
mailimap_single_body_fld_param_new(char * pa_name, char * pa_value);
void
mailimap_single_body_fld_param_free(struct mailimap_single_body_fld_param * p);
/*
mailmap_body_fld_param is a list of parameters
- list is the list of parameters.
*/
struct mailimap_body_fld_param {
clist * pa_list; /* list of (struct mailimap_single_body_fld_param *) */
/* != NULL */
};
struct mailimap_body_fld_param *
mailimap_body_fld_param_new(clist * pa_list);
void
mailimap_body_fld_param_free(struct mailimap_body_fld_param * fld_param);
/*
this is the kind of single part: a text part
(when Content-Type is text/xxx), a message part (when Content-Type is
message/rfc2822) or a basic part (others than multpart/xxx)
*/
enum {
MAILIMAP_BODY_TYPE_1PART_ERROR, /* parse error */
MAILIMAP_BODY_TYPE_1PART_BASIC, /* others then multipart/xxx */
MAILIMAP_BODY_TYPE_1PART_MSG, /* message/rfc2822 */
MAILIMAP_BODY_TYPE_1PART_TEXT /* text/xxx */
};
/*
mailimap_body_type_1part is
- type is the kind of single part, this can be
MAILIMAP_BODY_TYPE_1PART_BASIC, MAILIMAP_BODY_TYPE_1PART_MSG or
MAILIMAP_BODY_TYPE_1PART_TEXT.
- body_type_basic is the basic part when type is
MAILIMAP_BODY_TYPE_1PART_BASIC
- body_type_msg is the message part when type is
MAILIMAP_BODY_TYPE_1PART_MSG
- body_type_text is the text part when type is
MAILIMAP_BODY_TYPE_1PART_TEXT
*/
struct mailimap_body_type_1part {
int bd_type;
union {
struct mailimap_body_type_basic * bd_type_basic; /* can be NULL */
struct mailimap_body_type_msg * bd_type_msg; /* can be NULL */
struct mailimap_body_type_text * bd_type_text; /* can be NULL */
} bd_data;
struct mailimap_body_ext_1part * bd_ext_1part; /* can be NULL */
};
struct mailimap_body_type_1part *
mailimap_body_type_1part_new(int bd_type,
struct mailimap_body_type_basic * bd_type_basic,
struct mailimap_body_type_msg * bd_type_msg,
struct mailimap_body_type_text * bd_type_text,
struct mailimap_body_ext_1part * bd_ext_1part);
void
mailimap_body_type_1part_free(struct mailimap_body_type_1part * bt1p);
/*
mailimap_body_type_basic is a basic field (with Content-Type other
than multipart/xxx, message/rfc2822 and text/xxx
- media_basic will be the MIME type of the part
- body_fields will be the parsed fields of the MIME part
*/
struct mailimap_body_type_basic {
struct mailimap_media_basic * bd_media_basic; /* != NULL */
struct mailimap_body_fields * bd_fields; /* != NULL */
};
struct mailimap_body_type_basic *
mailimap_body_type_basic_new(struct mailimap_media_basic * bd_media_basic,
struct mailimap_body_fields * bd_fields);
void mailimap_body_type_basic_free(struct mailimap_body_type_basic *
body_type_basic);
/*
mailimap_body_type_mpart is a MIME multipart.
- body_list is the list of sub-parts.
- media_subtype is the subtype of the multipart (for example
in multipart/alternative, this is "alternative")
- body_ext_mpart is the extended fields of the MIME multipart
*/
struct mailimap_body_type_mpart {
clist * bd_list; /* list of (struct mailimap_body *) */
/* != NULL */
char * bd_media_subtype; /* != NULL */
struct mailimap_body_ext_mpart * bd_ext_mpart; /* can be NULL */
};
struct mailimap_body_type_mpart *
mailimap_body_type_mpart_new(clist * bd_list, char * bd_media_subtype,
struct mailimap_body_ext_mpart * bd_ext_mpart);
void mailimap_body_type_mpart_free(struct mailimap_body_type_mpart *
body_type_mpart);
/*
mailimap_body_type_msg is a MIME message part
- body_fields is the MIME fields of the MIME message part
- envelope is the list of parsed RFC 822 fields of the MIME message
- body is the sub-part of the message
- body_lines is the number of lines of the message part
*/
struct mailimap_body_type_msg {
struct mailimap_body_fields * bd_fields; /* != NULL */
struct mailimap_envelope * bd_envelope; /* != NULL */
struct mailimap_body * bd_body; /* != NULL */
uint32_t bd_lines;
};
struct mailimap_body_type_msg *
mailimap_body_type_msg_new(struct mailimap_body_fields * bd_fields,
struct mailimap_envelope * bd_envelope,
struct mailimap_body * bd_body,
uint32_t bd_lines);
void
mailimap_body_type_msg_free(struct mailimap_body_type_msg * body_type_msg);
/*
mailimap_body_type_text is a single MIME part where Content-Type is text/xxx
- media-text is the subtype of the text part (for example, in "text/plain",
this is "plain", should be allocated with malloc()
- body_fields is the MIME fields of the MIME message part
- body_lines is the number of lines of the message part
*/
struct mailimap_body_type_text {
char * bd_media_text; /* != NULL */
struct mailimap_body_fields * bd_fields; /* != NULL */
uint32_t bd_lines;
};
struct mailimap_body_type_text *
mailimap_body_type_text_new(char * bd_media_text,
struct mailimap_body_fields * bd_fields,
uint32_t bd_lines);
void
mailimap_body_type_text_free(struct mailimap_body_type_text * body_type_text);
/* this is the type of capability field */
enum {
MAILIMAP_CAPABILITY_AUTH_TYPE, /* when the capability is an
authentication type */
MAILIMAP_CAPABILITY_NAME /* other type of capability */
};
/*
mailimap_capability is a capability of the IMAP server
- type is the type of capability, this is either a authentication type
(MAILIMAP_CAPABILITY_AUTH_TYPE) or an other type of capability
(MAILIMAP_CAPABILITY_NAME)
- auth_type is a type of authentication "name" in "AUTH=name",
auth_type can be for example "PLAIN", when this is an authentication type,
should be allocated with malloc()
- name is a type of capability when this is not an authentication type,
should be allocated with malloc()
*/
struct mailimap_capability {
int cap_type;
union {
char * cap_auth_type; /* can be NULL */
char * cap_name; /* can be NULL */
} cap_data;
};
struct mailimap_capability *
mailimap_capability_new(int cap_type, char * cap_auth_type, char * cap_name);
void mailimap_capability_free(struct mailimap_capability * c);
/*
mailimap_capability_data is a list of capability
- list is the list of capability
*/
struct mailimap_capability_data {
clist * cap_list; /* list of (struct mailimap_capability *), != NULL */
};
struct mailimap_capability_data *
mailimap_capability_data_new(clist * cap_list);
LIBETPAN_EXPORT
void
mailimap_capability_data_free(struct mailimap_capability_data * cap_data);
/* this is the type of continue request data */
enum {
MAILIMAP_CONTINUE_REQ_ERROR, /* on parse error */
MAILIMAP_CONTINUE_REQ_TEXT, /* when data is a text response */
MAILIMAP_CONTINUE_REQ_BASE64 /* when data is a base64 response */
};
/*
mailimap_continue_req is a continue request (a response prefixed by "+")
- type is the type of continue request response
MAILIMAP_CONTINUE_REQ_TEXT (when information data is text),
MAILIMAP_CONTINUE_REQ_BASE64 (when information data is base64)
- text is the information of type text in case of text data
- base64 is base64 encoded data in the other case, should be allocated
with malloc()
*/
struct mailimap_continue_req {
int cr_type;
union {
struct mailimap_resp_text * cr_text; /* can be NULL */
char * cr_base64; /* can be NULL */
} cr_data;
};
struct mailimap_continue_req *
mailimap_continue_req_new(int cr_type, struct mailimap_resp_text * cr_text,
char * cr_base64);
void mailimap_continue_req_free(struct mailimap_continue_req * cont_req);
/*
mailimap_date_time is a date
- day is the day of month (1 to 31)
- month (1 to 12)
- year (4 digits)
- hour (0 to 23)
- min (0 to 59)
- sec (0 to 59)
- zone (this is the decimal value that we can read, for example:
for "-0200", the value is -200)
*/
struct mailimap_date_time {
int dt_day;
int dt_month;
int dt_year;
int dt_hour;
int dt_min;
int dt_sec;
int dt_zone;
};
struct mailimap_date_time *
mailimap_date_time_new(int dt_day, int dt_month, int dt_year, int dt_hour,
int dt_min, int dt_sec, int dt_zone);
void mailimap_date_time_free(struct mailimap_date_time * date_time);
/*
mailimap_envelope is the list of fields that can be parsed by
the IMAP server.
- date is the (non-parsed) content of the "Date" header field,
should be allocated with malloc()
- subject is the subject of the message, should be allocated with
malloc()
- sender is the the parsed content of the "Sender" field
- reply-to is the parsed content of the "Reply-To" field
- to is the parsed content of the "To" field
- cc is the parsed content of the "Cc" field
- bcc is the parsed content of the "Bcc" field
- in_reply_to is the content of the "In-Reply-To" field,
should be allocated with malloc()
- message_id is the content of the "Message-ID" field,
should be allocated with malloc()
*/
struct mailimap_envelope {
char * env_date; /* can be NULL */
char * env_subject; /* can be NULL */
struct mailimap_env_from * env_from; /* can be NULL */
struct mailimap_env_sender * env_sender; /* can be NULL */
struct mailimap_env_reply_to * env_reply_to; /* can be NULL */
struct mailimap_env_to * env_to; /* can be NULL */
struct mailimap_env_cc * env_cc; /* can be NULL */
struct mailimap_env_bcc * env_bcc; /* can be NULL */
char * env_in_reply_to; /* can be NULL */
char * env_message_id; /* can be NULL */
};
struct mailimap_envelope *
mailimap_envelope_new(char * env_date, char * env_subject,
struct mailimap_env_from * env_from,
struct mailimap_env_sender * env_sender,
struct mailimap_env_reply_to * env_reply_to,
struct mailimap_env_to * env_to,
struct mailimap_env_cc* env_cc,
struct mailimap_env_bcc * env_bcc,
char * env_in_reply_to, char * env_message_id);
void mailimap_envelope_free(struct mailimap_envelope * env);
/*
mailimap_env_bcc is the parsed "Bcc" field
- list is the list of addresses
*/
struct mailimap_env_bcc {
clist * bcc_list; /* list of (struct mailimap_address *), can be NULL */
};
struct mailimap_env_bcc * mailimap_env_bcc_new(clist * bcc_list);
void mailimap_env_bcc_free(struct mailimap_env_bcc * env_bcc);
/*
mailimap_env_cc is the parsed "Cc" field
- list is the list of addresses
*/
struct mailimap_env_cc {
clist * cc_list; /* list of (struct mailimap_address *), can be NULL */
};
struct mailimap_env_cc * mailimap_env_cc_new(clist * cc_list);
void mailimap_env_cc_free(struct mailimap_env_cc * env_cc);
/*
mailimap_env_from is the parsed "From" field
- list is the list of addresses
*/
struct mailimap_env_from {
clist * frm_list; /* list of (struct mailimap_address *) */
/* can be NULL */
};
struct mailimap_env_from * mailimap_env_from_new(clist * frm_list);
void mailimap_env_from_free(struct mailimap_env_from * env_from);
/*
mailimap_env_reply_to is the parsed "Reply-To" field
- list is the list of addresses
*/
struct mailimap_env_reply_to {
clist * rt_list; /* list of (struct mailimap_address *), can be NULL */
};
struct mailimap_env_reply_to * mailimap_env_reply_to_new(clist * rt_list);
void
mailimap_env_reply_to_free(struct mailimap_env_reply_to * env_reply_to);
/*
mailimap_env_sender is the parsed "Sender" field
- list is the list of addresses
*/
struct mailimap_env_sender {
clist * snd_list; /* list of (struct mailimap_address *), can be NULL */
};
struct mailimap_env_sender * mailimap_env_sender_new(clist * snd_list);
void mailimap_env_sender_free(struct mailimap_env_sender * env_sender);
/*
mailimap_env_to is the parsed "To" field
- list is the list of addresses
*/
struct mailimap_env_to {
clist * to_list; /* list of (struct mailimap_address *), can be NULL */
};
struct mailimap_env_to * mailimap_env_to_new(clist * to_list);
void mailimap_env_to_free(struct mailimap_env_to * env_to);
/* this is the type of flag */
enum {
MAILIMAP_FLAG_ANSWERED, /* \Answered flag */
MAILIMAP_FLAG_FLAGGED, /* \Flagged flag */
MAILIMAP_FLAG_DELETED, /* \Deleted flag */
MAILIMAP_FLAG_SEEN, /* \Seen flag */
MAILIMAP_FLAG_DRAFT, /* \Draft flag */
MAILIMAP_FLAG_KEYWORD, /* keyword flag */
MAILIMAP_FLAG_EXTENSION /* \extension flag */
};
/*
mailimap_flag is a message flag (that we can associate with a message)
- type is the type of the flag, MAILIMAP_FLAG_XXX
- keyword is the flag when the flag is of keyword type,
should be allocated with malloc()
- extension is the flag when the flag is of extension type, should be
allocated with malloc()
*/
struct mailimap_flag {
int fl_type;
union {
char * fl_keyword; /* can be NULL */
char * fl_extension; /* can be NULL */
} fl_data;
};
LIBETPAN_EXPORT
struct mailimap_flag * mailimap_flag_new(int fl_type,
char * fl_keyword, char * fl_extension);
LIBETPAN_EXPORT
void mailimap_flag_free(struct mailimap_flag * f);
/* this is the type of flag */
enum {
MAILIMAP_FLAG_FETCH_ERROR, /* on parse error */
MAILIMAP_FLAG_FETCH_RECENT, /* \Recent flag */
MAILIMAP_FLAG_FETCH_OTHER /* other type of flag */
};
/*
mailimap_flag_fetch is a message flag (when we fetch it)
- type is the type of flag fetch
- flag is the flag when this is not a \Recent flag
*/
struct mailimap_flag_fetch {
int fl_type;
struct mailimap_flag * fl_flag; /* can be NULL */
};
struct mailimap_flag_fetch *
mailimap_flag_fetch_new(int fl_type, struct mailimap_flag * fl_flag);
void mailimap_flag_fetch_free(struct mailimap_flag_fetch * flag_fetch);
/* this is the type of flag */
enum {
MAILIMAP_FLAG_PERM_ERROR, /* on parse error */
MAILIMAP_FLAG_PERM_FLAG, /* to specify that usual flags can be changed */
MAILIMAP_FLAG_PERM_ALL /* to specify that new flags can be created */
};
/*
mailimap_flag_perm is a flag returned in case of PERMANENTFLAGS response
- type is the type of returned PERMANENTFLAGS, it can be
MAILIMAP_FLAG_PERM_FLAG (the given flag can be changed permanently) or
MAILIMAP_FLAG_PERM_ALL (new flags can be created)
- flag is the given flag when type is MAILIMAP_FLAG_PERM_FLAG
*/
struct mailimap_flag_perm {
int fl_type;
struct mailimap_flag * fl_flag; /* can be NULL */
};
struct mailimap_flag_perm *
mailimap_flag_perm_new(int fl_type, struct mailimap_flag * fl_flag);
void mailimap_flag_perm_free(struct mailimap_flag_perm * flag_perm);
/*
mailimap_flag_list is a list of flags
- list is a list of flags
*/
struct mailimap_flag_list {
clist * fl_list; /* list of (struct mailimap_flag *), != NULL */
};
LIBETPAN_EXPORT
struct mailimap_flag_list *
mailimap_flag_list_new(clist * fl_list);
LIBETPAN_EXPORT
void mailimap_flag_list_free(struct mailimap_flag_list * flag_list);
/* this is the type of greeting response */
enum {
MAILIMAP_GREETING_RESP_COND_ERROR, /* on parse error */
MAILIMAP_GREETING_RESP_COND_AUTH, /* when connection is accepted */
MAILIMAP_GREETING_RESP_COND_BYE /* when connection is refused */
};
/*
mailimap_greeting is the response returned on connection
- type is the type of response on connection, either
MAILIMAP_GREETING_RESP_COND_AUTH if connection is accepted or
MAIMIMAP_GREETING_RESP_COND_BYE if connection is refused
*/
struct mailimap_greeting {
int gr_type;
union {
struct mailimap_resp_cond_auth * gr_auth; /* can be NULL */
struct mailimap_resp_cond_bye * gr_bye; /* can be NULL */
} gr_data;
};
struct mailimap_greeting *
mailimap_greeting_new(int gr_type,
struct mailimap_resp_cond_auth * gr_auth,
struct mailimap_resp_cond_bye * gr_bye);
void mailimap_greeting_free(struct mailimap_greeting * greeting);
/*
mailimap_header_list is a list of headers that can be specified when
we want to fetch fields
- list is a list of header names, each header name should be allocated
with malloc()
*/
struct mailimap_header_list {
clist * hdr_list; /* list of astring (char *), != NULL */
};
struct mailimap_header_list *
mailimap_header_list_new(clist * hdr_list);
void
mailimap_header_list_free(struct mailimap_header_list * header_list);
/* this is the type of mailbox STATUS that can be returned */
enum {
MAILIMAP_STATUS_ATT_MESSAGES, /* when requesting the number of
messages */
MAILIMAP_STATUS_ATT_RECENT, /* when requesting the number of
recent messages */
MAILIMAP_STATUS_ATT_UIDNEXT, /* when requesting the next unique
identifier */
MAILIMAP_STATUS_ATT_UIDVALIDITY, /* when requesting the validity of
message unique identifiers*/
MAILIMAP_STATUS_ATT_UNSEEN, /* when requesting the number of
unseen messages */
MAILIMAP_STATUS_ATT_HIGHESTMODSEQ, /* when requesting the highest
mod-sequence value of all messages in
the mailbox */
MAILIMAP_STATUS_ATT_EXTENSION
};
/*
mailimap_status_info is a returned information when a STATUS of
a mailbox is requested
- att is the type of mailbox STATUS, the value can be
MAILIMAP_STATUS_ATT_MESSAGES, MAILIMAP_STATUS_ATT_RECENT,
MAILIMAP_STATUS_ATT_UIDNEXT, MAILIMAP_STATUS_ATT_UIDVALIDITY,
MAILIMAP_STATUS_ATT_UNSEEN or MAILIMAP_STATUS_ATT_EXTENSION
- value is the value of the given information
- st_ext_data is the data of the extension.
*/
struct mailimap_status_info {
int st_att;
uint32_t st_value;
struct mailimap_extension_data * st_ext_data; /* can be NULL */
};
struct mailimap_status_info *
mailimap_status_info_new(int st_att, uint32_t st_value,
struct mailimap_extension_data * st_ext_data);
void mailimap_status_info_free(struct mailimap_status_info * info);
/*
mailimap_mailbox_data_status is the list of information returned
when a STATUS of a mailbox is requested
- mailbox is the name of the mailbox, should be allocated with malloc()
- status_info_list is the list of information returned
*/
struct mailimap_mailbox_data_status {
char * st_mailbox;
clist * st_info_list; /* list of (struct mailimap_status_info *) */
/* can be NULL */
};
struct mailimap_mailbox_data_status *
mailimap_mailbox_data_status_new(char * st_mailbox,
clist * st_info_list);
void
mailimap_mailbox_data_status_free(struct mailimap_mailbox_data_status * info);
/* this is the type of mailbox information that is returned */
enum {
MAILIMAP_MAILBOX_DATA_ERROR, /* on parse error */
MAILIMAP_MAILBOX_DATA_FLAGS, /* flag that are applicable to the mailbox */
MAILIMAP_MAILBOX_DATA_LIST, /* this is a mailbox in the list of mailboxes
returned on LIST command*/
MAILIMAP_MAILBOX_DATA_LSUB, /* this is a mailbox in the list of
subscribed mailboxes returned on LSUB
command */
MAILIMAP_MAILBOX_DATA_SEARCH, /* this is a list of messages numbers or
unique identifiers returned
on a SEARCH command*/
MAILIMAP_MAILBOX_DATA_STATUS, /* this is the list of information returned
on a STATUS command */
MAILIMAP_MAILBOX_DATA_EXISTS, /* this is the number of messages in the
mailbox */
MAILIMAP_MAILBOX_DATA_RECENT, /* this is the number of recent messages
in the mailbox */
MAILIMAP_MAILBOX_DATA_EXTENSION_DATA /* this mailbox-data stores data
returned by an extension */
};
/*
mailimap_mailbox_data is an information related to a mailbox
- type is the type of mailbox_data that is filled, the value of this field
can be MAILIMAP_MAILBOX_DATA_FLAGS, MAILIMAP_MAILBOX_DATA_LIST,
MAILIMAP_MAILBOX_DATA_LSUB, MAILIMAP_MAILBOX_DATA_SEARCH,
MAILIMAP_MAILBOX_DATA_STATUS, MAILIMAP_MAILBOX_DATA_EXISTS
or MAILIMAP_MAILBOX_DATA_RECENT.
- flags is the flags that are applicable to the mailbox when
type is MAILIMAP_MAILBOX_DATA_FLAGS
- list is a mailbox in the list of mailboxes returned on LIST command
when type is MAILIMAP_MAILBOX_DATA_LIST
- lsub is a mailbox in the list of subscribed mailboxes returned on
LSUB command when type is MAILIMAP_MAILBOX_DATA_LSUB
- search is a list of messages numbers or unique identifiers returned
on SEARCH command when type MAILIMAP_MAILBOX_DATA_SEARCH, each element
should be allocated with malloc()
- status is a list of information returned on STATUS command when
type is MAILIMAP_MAILBOX_DATA_STATUS
- exists is the number of messages in the mailbox when type
is MAILIMAP_MAILBOX_DATA_EXISTS
- recent is the number of recent messages in the mailbox when type
is MAILIMAP_MAILBOX_DATA_RECENT
*/
struct mailimap_mailbox_data {
int mbd_type;
union {
struct mailimap_flag_list * mbd_flags; /* can be NULL */
struct mailimap_mailbox_list * mbd_list; /* can be NULL */
struct mailimap_mailbox_list * mbd_lsub; /* can be NULL */
clist * mbd_search; /* list of nz-number (uint32_t *), can be NULL */
struct mailimap_mailbox_data_status * mbd_status; /* can be NULL */
uint32_t mbd_exists;
uint32_t mbd_recent;
struct mailimap_extension_data * mbd_extension; /* can be NULL */
} mbd_data;
};
struct mailimap_mailbox_data *
mailimap_mailbox_data_new(int mbd_type, struct mailimap_flag_list * mbd_flags,
struct mailimap_mailbox_list * mbd_list,
struct mailimap_mailbox_list * mbd_lsub,
clist * mbd_search,
struct mailimap_mailbox_data_status * mbd_status,
uint32_t mbd_exists,
uint32_t mbd_recent,
struct mailimap_extension_data * mbd_extension);
void
mailimap_mailbox_data_free(struct mailimap_mailbox_data * mb_data);
/* this is the type of mailbox flags */
enum {
MAILIMAP_MBX_LIST_FLAGS_SFLAG, /* mailbox single flag - a flag in
{\NoSelect, \Marked, \Unmarked} */
MAILIMAP_MBX_LIST_FLAGS_NO_SFLAG /* mailbox other flag - mailbox flag
other than \NoSelect \Marked and
\Unmarked) */
};
/* this is a single flag type */
enum {
MAILIMAP_MBX_LIST_SFLAG_ERROR,
MAILIMAP_MBX_LIST_SFLAG_MARKED,
MAILIMAP_MBX_LIST_SFLAG_NOSELECT,
MAILIMAP_MBX_LIST_SFLAG_UNMARKED
};
/*
mailimap_mbx_list_flags is a mailbox flag
- type is the type of mailbox flag, it can be MAILIMAP_MBX_LIST_FLAGS_SFLAG,
or MAILIMAP_MBX_LIST_FLAGS_NO_SFLAG.
- oflags is a list of "mailbox other flag"
- sflag is a mailbox single flag
*/
struct mailimap_mbx_list_flags {
int mbf_type;
clist * mbf_oflags; /* list of
(struct mailimap_mbx_list_oflag *), != NULL */
int mbf_sflag;
};
struct mailimap_mbx_list_flags *
mailimap_mbx_list_flags_new(int mbf_type,
clist * mbf_oflags, int mbf_sflag);
void
mailimap_mbx_list_flags_free(struct mailimap_mbx_list_flags * mbx_list_flags);
/* this is the type of the mailbox other flag */
enum {
MAILIMAP_MBX_LIST_OFLAG_ERROR, /* on parse error */
MAILIMAP_MBX_LIST_OFLAG_NOINFERIORS, /* \NoInferior flag */
MAILIMAP_MBX_LIST_OFLAG_FLAG_EXT /* other flag */
};
/*
mailimap_mbx_list_oflag is a mailbox other flag
- type can be MAILIMAP_MBX_LIST_OFLAG_NOINFERIORS when this is
a \NoInferior flag or MAILIMAP_MBX_LIST_OFLAG_FLAG_EXT
- flag_ext is set when MAILIMAP_MBX_LIST_OFLAG_FLAG_EXT and is
an extension flag, should be allocated with malloc()
*/
struct mailimap_mbx_list_oflag {
int of_type;
char * of_flag_ext; /* can be NULL */
};
struct mailimap_mbx_list_oflag *
mailimap_mbx_list_oflag_new(int of_type, char * of_flag_ext);
void
mailimap_mbx_list_oflag_free(struct mailimap_mbx_list_oflag * oflag);
/*
mailimap_mailbox_list is a list of mailbox flags
- mb_flag is a list of mailbox flags
- delimiter is the delimiter of the mailbox path
- mb is the name of the mailbox, should be allocated with malloc()
*/
struct mailimap_mailbox_list {
struct mailimap_mbx_list_flags * mb_flag; /* can be NULL */
char mb_delimiter;
char * mb_name; /* != NULL */
};
struct mailimap_mailbox_list *
mailimap_mailbox_list_new(struct mailimap_mbx_list_flags * mbx_flags,
char mb_delimiter, char * mb_name);
void
mailimap_mailbox_list_free(struct mailimap_mailbox_list * mb_list);
/* this is the MIME type */
enum {
MAILIMAP_MEDIA_BASIC_APPLICATION, /* application/xxx */
MAILIMAP_MEDIA_BASIC_AUDIO, /* audio/xxx */
MAILIMAP_MEDIA_BASIC_IMAGE, /* image/xxx */
MAILIMAP_MEDIA_BASIC_MESSAGE, /* message/xxx */
MAILIMAP_MEDIA_BASIC_VIDEO, /* video/xxx */
MAILIMAP_MEDIA_BASIC_OTHER /* for all other cases */
};
/*
mailimap_media_basic is the MIME type
- type can be MAILIMAP_MEDIA_BASIC_APPLICATION, MAILIMAP_MEDIA_BASIC_AUDIO,
MAILIMAP_MEDIA_BASIC_IMAGE, MAILIMAP_MEDIA_BASIC_MESSAGE,
MAILIMAP_MEDIA_BASIC_VIDEO or MAILIMAP_MEDIA_BASIC_OTHER
- basic_type is defined when type is MAILIMAP_MEDIA_BASIC_OTHER, should
be allocated with malloc()
- subtype is the subtype of the MIME type, for example, this is
"data" in "application/data", should be allocated with malloc()
*/
struct mailimap_media_basic {
int med_type;
char * med_basic_type; /* can be NULL */
char * med_subtype; /* != NULL */
};
struct mailimap_media_basic *
mailimap_media_basic_new(int med_type,
char * med_basic_type, char * med_subtype);
void
mailimap_media_basic_free(struct mailimap_media_basic * media_basic);
/* this is the type of message data */
enum {
MAILIMAP_MESSAGE_DATA_ERROR,
MAILIMAP_MESSAGE_DATA_EXPUNGE,
MAILIMAP_MESSAGE_DATA_FETCH
};
/*
mailimap_message_data is an information related to a message
- number is the number or the unique identifier of the message
- type is the type of information, this value can be
MAILIMAP_MESSAGE_DATA_EXPUNGE or MAILIMAP_MESSAGE_DATA_FETCH
- msg_att is the message data
*/
struct mailimap_message_data {
uint32_t mdt_number;
int mdt_type;
struct mailimap_msg_att * mdt_msg_att; /* can be NULL */
/* if type = EXPUNGE, can be NULL */
};
struct mailimap_message_data *
mailimap_message_data_new(uint32_t mdt_number, int mdt_type,
struct mailimap_msg_att * mdt_msg_att);
void
mailimap_message_data_free(struct mailimap_message_data * msg_data);
/* this the type of the message attributes */
enum {
MAILIMAP_MSG_ATT_ITEM_ERROR, /* on parse error */
MAILIMAP_MSG_ATT_ITEM_DYNAMIC, /* dynamic message attributes (flags) */
MAILIMAP_MSG_ATT_ITEM_STATIC, /* static messages attributes
(message content) */
MAILIMAP_MSG_ATT_ITEM_EXTENSION /* extension data */
};
/*
mailimap_msg_att_item is a message attribute
- type is the type of message attribute, the value can be
MAILIMAP_MSG_ATT_ITEM_DYNAMIC, MAILIMAP_MSG_ATT_ITEM_STATIC or MAILIMAP_MSG_ATT_ITEM_EXTENSION
- att_dyn is a dynamic message attribute when type is
MAILIMAP_MSG_ATT_ITEM_DYNAMIC
- att_static is a static message attribute when type is
MAILIMAP_MSG_ATT_ITEM_STATIC
- att_extension_data is an extension data.
*/
struct mailimap_msg_att_item {
int att_type;
union {
struct mailimap_msg_att_dynamic * att_dyn; /* can be NULL */
struct mailimap_msg_att_static * att_static; /* can be NULL */
struct mailimap_extension_data * att_extension_data; /* can be NULL */
} att_data;
};
struct mailimap_msg_att_item *
mailimap_msg_att_item_new(int att_type,
struct mailimap_msg_att_dynamic * att_dyn,
struct mailimap_msg_att_static * att_static,
struct mailimap_extension_data * att_extension_data);
void
mailimap_msg_att_item_free(struct mailimap_msg_att_item * item);
/*
mailimap_msg_att is a list of attributes
- list is a list of message attributes
- number is the message number or unique identifier, this field
has been added for implementation purpose
*/
struct mailimap_msg_att {
clist * att_list; /* list of (struct mailimap_msg_att_item *) */
/* != NULL */
uint32_t att_number; /* extra field to store the message number,
used for mailimap */
};
struct mailimap_msg_att * mailimap_msg_att_new(clist * att_list);
void mailimap_msg_att_free(struct mailimap_msg_att * msg_att);
/*
mailimap_msg_att_dynamic is a dynamic message attribute
- list is a list of flags (that have been fetched)
*/
struct mailimap_msg_att_dynamic {
clist * att_list; /* list of (struct mailimap_flag_fetch *) */
/* can be NULL */
};
struct mailimap_msg_att_dynamic *
mailimap_msg_att_dynamic_new(clist * att_list);
void
mailimap_msg_att_dynamic_free(struct mailimap_msg_att_dynamic * msg_att_dyn);
/*
mailimap_msg_att_body_section is a MIME part content
- section is the location of the MIME part in the message
- origin_octet is the offset of the requested part of the MIME part
- body_part is the content or partial content of the MIME part,
should be allocated through a MMAPString
- length is the size of the content
*/
struct mailimap_msg_att_body_section {
struct mailimap_section * sec_section; /* != NULL */
uint32_t sec_origin_octet;
char * sec_body_part; /* can be NULL */
size_t sec_length;
};
struct mailimap_msg_att_body_section *
mailimap_msg_att_body_section_new(struct mailimap_section * section,
uint32_t sec_origin_octet,
char * sec_body_part,
size_t sec_length);
void
mailimap_msg_att_body_section_free(struct mailimap_msg_att_body_section *
msg_att_body_section);
/*
this is the type of static message attribute
*/
enum {
MAILIMAP_MSG_ATT_ERROR, /* on parse error */
MAILIMAP_MSG_ATT_ENVELOPE, /* this is the fields that can be
parsed by the server */
MAILIMAP_MSG_ATT_INTERNALDATE, /* this is the message date kept
by the server */
MAILIMAP_MSG_ATT_RFC822, /* this is the message content
(header and body) */
MAILIMAP_MSG_ATT_RFC822_HEADER, /* this is the message header */
MAILIMAP_MSG_ATT_RFC822_TEXT, /* this is the message text part */
MAILIMAP_MSG_ATT_RFC822_SIZE, /* this is the size of the message content */
MAILIMAP_MSG_ATT_BODY, /* this is the MIME description of
the message */
MAILIMAP_MSG_ATT_BODYSTRUCTURE, /* this is the MIME description of the
message with additional information */
MAILIMAP_MSG_ATT_BODY_SECTION, /* this is a MIME part content */
MAILIMAP_MSG_ATT_UID /* this is the message unique identifier */
};
/*
mailimap_msg_att_static is a given part of the message
- type is the type of the static message attribute, the value can be
MAILIMAP_MSG_ATT_ENVELOPE, MAILIMAP_MSG_ATT_INTERNALDATE,
MAILIMAP_MSG_ATT_RFC822, MAILIMAP_MSG_ATT_RFC822_HEADER,
MAILIMAP_MSG_ATT_RFC822_TEXT, MAILIMAP_MSG_ATT_RFC822_SIZE,
MAILIMAP_MSG_ATT_BODY, MAILIMAP_MSG_ATT_BODYSTRUCTURE,
MAILIMAP_MSG_ATT_BODY_SECTION, MAILIMAP_MSG_ATT_UID
- env is the headers parsed by the server if type is
MAILIMAP_MSG_ATT_ENVELOPE
- internal_date is the date of message kept by the server if type is
MAILIMAP_MSG_ATT_INTERNALDATE
- rfc822 is the message content if type is MAILIMAP_MSG_ATT_RFC822,
should be allocated through a MMAPString
- rfc822_header is the message header if type is
MAILIMAP_MSG_ATT_RFC822_HEADER, should be allocated through a MMAPString
- rfc822_text is the message text part if type is
MAILIMAP_MSG_ATT_RFC822_TEXT, should be allocated through a MMAPString
- rfc822_size is the message size if type is MAILIMAP_MSG_ATT_SIZE
- body is the MIME description of the message
- bodystructure is the MIME description of the message with additional
information
- body_section is a MIME part content
- uid is a unique message identifier
*/
struct mailimap_msg_att_static {
int att_type;
union {
struct mailimap_envelope * att_env; /* can be NULL */
struct mailimap_date_time * att_internal_date; /* can be NULL */
struct {
char * att_content; /* can be NULL */
size_t att_length;
} att_rfc822;
struct {
char * att_content; /* can be NULL */
size_t att_length;
} att_rfc822_header;
struct {
char * att_content; /* can be NULL */
size_t att_length;
} att_rfc822_text;
uint32_t att_rfc822_size;
struct mailimap_body * att_bodystructure; /* can be NULL */
struct mailimap_body * att_body; /* can be NULL */
struct mailimap_msg_att_body_section * att_body_section; /* can be NULL */
uint32_t att_uid;
} att_data;
};
struct mailimap_msg_att_static *
mailimap_msg_att_static_new(int att_type, struct mailimap_envelope * att_env,
struct mailimap_date_time * att_internal_date,
char * att_rfc822,
char * att_rfc822_header,
char * att_rfc822_text,
size_t att_length,
uint32_t att_rfc822_size,
struct mailimap_body * att_bodystructure,
struct mailimap_body * att_body,
struct mailimap_msg_att_body_section * att_body_section,
uint32_t att_uid);
void
mailimap_msg_att_static_free(struct mailimap_msg_att_static * item);
/* this is the type of a response element */
enum {
MAILIMAP_RESP_ERROR, /* on parse error */
MAILIMAP_RESP_CONT_REQ, /* continuation request */
MAILIMAP_RESP_RESP_DATA /* response data */
};
/*
mailimap_cont_req_or_resp_data is a response element
- type is the type of response, the value can be MAILIMAP_RESP_CONT_REQ
or MAILIMAP_RESP_RESP_DATA
- cont_req is a continuation request
- resp_data is a reponse data
*/
struct mailimap_cont_req_or_resp_data {
int rsp_type;
union {
struct mailimap_continue_req * rsp_cont_req; /* can be NULL */
struct mailimap_response_data * rsp_resp_data; /* can be NULL */
} rsp_data;
};
struct mailimap_cont_req_or_resp_data *
mailimap_cont_req_or_resp_data_new(int rsp_type,
struct mailimap_continue_req * rsp_cont_req,
struct mailimap_response_data * rsp_resp_data);
void
mailimap_cont_req_or_resp_data_free(struct mailimap_cont_req_or_resp_data *
cont_req_or_resp_data);
/*
mailimap_response is a list of response elements
- cont_req_or_resp_data_list is a list of response elements
- resp_done is an ending response element
*/
struct mailimap_response {
clist * rsp_cont_req_or_resp_data_list;
/* list of (struct mailiap_cont_req_or_resp_data *) */
/* can be NULL */
struct mailimap_response_done * rsp_resp_done; /* != NULL */
};
struct mailimap_response *
mailimap_response_new(clist * rsp_cont_req_or_resp_data_list,
struct mailimap_response_done * rsp_resp_done);
void
mailimap_response_free(struct mailimap_response * resp);
/* this is the type of an untagged response */
enum {
MAILIMAP_RESP_DATA_TYPE_ERROR, /* on parse error */
MAILIMAP_RESP_DATA_TYPE_COND_STATE, /* condition state response */
MAILIMAP_RESP_DATA_TYPE_COND_BYE, /* BYE response (server is about
to close the connection) */
MAILIMAP_RESP_DATA_TYPE_MAILBOX_DATA, /* response related to a mailbox */
MAILIMAP_RESP_DATA_TYPE_MESSAGE_DATA, /* response related to a message */
MAILIMAP_RESP_DATA_TYPE_CAPABILITY_DATA, /* capability information */
MAILIMAP_RESP_DATA_TYPE_EXTENSION_DATA /* data parsed by extension */
};
/*
mailimap_reponse_data is an untagged response
- type is the type of the untagged response, it can be
MAILIMAP_RESP_DATA_COND_STATE, MAILIMAP_RESP_DATA_COND_BYE,
MAILIMAP_RESP_DATA_MAILBOX_DATA, MAILIMAP_RESP_DATA_MESSAGE_DATA
or MAILIMAP_RESP_DATA_CAPABILITY_DATA
- cond_state is a condition state response
- bye is a BYE response (server is about to close the connection)
- mailbox_data is a response related to a mailbox
- message_data is a response related to a message
- capability is information about capabilities
*/
struct mailimap_response_data {
int rsp_type;
union {
struct mailimap_resp_cond_state * rsp_cond_state; /* can be NULL */
struct mailimap_resp_cond_bye * rsp_bye; /* can be NULL */
struct mailimap_mailbox_data * rsp_mailbox_data; /* can be NULL */
struct mailimap_message_data * rsp_message_data; /* can be NULL */
struct mailimap_capability_data * rsp_capability_data; /* can be NULL */
struct mailimap_extension_data * rsp_extension_data; /* can be NULL */
} rsp_data;
};
struct mailimap_response_data *
mailimap_response_data_new(int rsp_type,
struct mailimap_resp_cond_state * rsp_cond_state,
struct mailimap_resp_cond_bye * rsp_bye,
struct mailimap_mailbox_data * rsp_mailbox_data,
struct mailimap_message_data * rsp_message_data,
struct mailimap_capability_data * rsp_capability_data,
struct mailimap_extension_data * rsp_extension_data);
void
mailimap_response_data_free(struct mailimap_response_data * resp_data);
/* this is the type of an ending response */
enum {
MAILIMAP_RESP_DONE_TYPE_ERROR, /* on parse error */
MAILIMAP_RESP_DONE_TYPE_TAGGED, /* tagged response */
MAILIMAP_RESP_DONE_TYPE_FATAL /* fatal error response */
};
/*
mailimap_response_done is an ending response
- type is the type of the ending response
- tagged is a tagged response
- fatal is a fatal error response
*/
struct mailimap_response_done {
int rsp_type;
union {
struct mailimap_response_tagged * rsp_tagged; /* can be NULL */
struct mailimap_response_fatal * rsp_fatal; /* can be NULL */
} rsp_data;
};
struct mailimap_response_done *
mailimap_response_done_new(int rsp_type,
struct mailimap_response_tagged * rsp_tagged,
struct mailimap_response_fatal * rsp_fatal);
void mailimap_response_done_free(struct mailimap_response_done *
resp_done);
/*
mailimap_response_fatal is a fatal error response
- bye is a BYE response text
*/
struct mailimap_response_fatal {
struct mailimap_resp_cond_bye * rsp_bye; /* != NULL */
};
struct mailimap_response_fatal *
mailimap_response_fatal_new(struct mailimap_resp_cond_bye * rsp_bye);
void mailimap_response_fatal_free(struct mailimap_response_fatal * resp_fatal);
/*
mailimap_response_tagged is a tagged response
- tag is the sent tag, should be allocated with malloc()
- cond_state is a condition state response
*/
struct mailimap_response_tagged {
char * rsp_tag; /* != NULL */
struct mailimap_resp_cond_state * rsp_cond_state; /* != NULL */
};
struct mailimap_response_tagged *
mailimap_response_tagged_new(char * rsp_tag,
struct mailimap_resp_cond_state * rsp_cond_state);
void
mailimap_response_tagged_free(struct mailimap_response_tagged * tagged);
/* this is the type of an authentication condition response */
enum {
MAILIMAP_RESP_COND_AUTH_ERROR, /* on parse error */
MAILIMAP_RESP_COND_AUTH_OK, /* authentication is needed */
MAILIMAP_RESP_COND_AUTH_PREAUTH /* authentication is not needed */
};
/*
mailimap_resp_cond_auth is an authentication condition response
- type is the type of the authentication condition response,
the value can be MAILIMAP_RESP_COND_AUTH_OK or
MAILIMAP_RESP_COND_AUTH_PREAUTH
- text is a text response
*/
struct mailimap_resp_cond_auth {
int rsp_type;
struct mailimap_resp_text * rsp_text; /* != NULL */
};
struct mailimap_resp_cond_auth *
mailimap_resp_cond_auth_new(int rsp_type,
struct mailimap_resp_text * rsp_text);
void
mailimap_resp_cond_auth_free(struct mailimap_resp_cond_auth * cond_auth);
/*
mailimap_resp_cond_bye is a BYE response
- text is a text response
*/
struct mailimap_resp_cond_bye {
struct mailimap_resp_text * rsp_text; /* != NULL */
};
struct mailimap_resp_cond_bye *
mailimap_resp_cond_bye_new(struct mailimap_resp_text * rsp_text);
void
mailimap_resp_cond_bye_free(struct mailimap_resp_cond_bye * cond_bye);
/* this is the type of a condition state response */
enum {
MAILIMAP_RESP_COND_STATE_OK,
MAILIMAP_RESP_COND_STATE_NO,
MAILIMAP_RESP_COND_STATE_BAD
};
/*
mailimap_resp_cond_state is a condition state reponse
- type is the type of the condition state response
- text is a text response
*/
struct mailimap_resp_cond_state {
int rsp_type;
struct mailimap_resp_text * rsp_text; /* can be NULL */
};
struct mailimap_resp_cond_state *
mailimap_resp_cond_state_new(int rsp_type,
struct mailimap_resp_text * rsp_text);
void
mailimap_resp_cond_state_free(struct mailimap_resp_cond_state * cond_state);
/*
mailimap_resp_text is a text response
- resp_code is a response code
- text is a human readable text, should be allocated with malloc()
*/
struct mailimap_resp_text {
struct mailimap_resp_text_code * rsp_code; /* can be NULL */
char * rsp_text; /* can be NULL */
};
struct mailimap_resp_text *
mailimap_resp_text_new(struct mailimap_resp_text_code * resp_code,
char * rsp_text);
void mailimap_resp_text_free(struct mailimap_resp_text * resp_text);
/* this is the type of the response code */
enum {
MAILIMAP_RESP_TEXT_CODE_ALERT, /* ALERT response */
MAILIMAP_RESP_TEXT_CODE_BADCHARSET, /* BADCHARSET response */
MAILIMAP_RESP_TEXT_CODE_CAPABILITY_DATA, /* CAPABILITY response */
MAILIMAP_RESP_TEXT_CODE_PARSE, /* PARSE response */
MAILIMAP_RESP_TEXT_CODE_PERMANENTFLAGS, /* PERMANENTFLAGS response */
MAILIMAP_RESP_TEXT_CODE_READ_ONLY, /* READONLY response */
MAILIMAP_RESP_TEXT_CODE_READ_WRITE, /* READWRITE response */
MAILIMAP_RESP_TEXT_CODE_TRY_CREATE, /* TRYCREATE response */
MAILIMAP_RESP_TEXT_CODE_UIDNEXT, /* UIDNEXT response */
MAILIMAP_RESP_TEXT_CODE_UIDVALIDITY, /* UIDVALIDITY response */
MAILIMAP_RESP_TEXT_CODE_UNSEEN, /* UNSEEN response */
MAILIMAP_RESP_TEXT_CODE_OTHER, /* other type of response */
MAILIMAP_RESP_TEXT_CODE_EXTENSION /* extension response */
};
/*
mailimap_resp_text_code is a response code
- type is the type of the response code, the value can be
MAILIMAP_RESP_TEXT_CODE_ALERT, MAILIMAP_RESP_TEXT_CODE_BADCHARSET,
MAILIMAP_RESP_TEXT_CODE_CAPABILITY_DATA, MAILIMAP_RESP_TEXT_CODE_PARSE,
MAILIMAP_RESP_TEXT_CODE_PERMANENTFLAGS, MAILIMAP_RESP_TEXT_CODE_READ_ONLY,
MAILIMAP_RESP_TEXT_CODE_READ_WRITE, MAILIMAP_RESP_TEXT_CODE_TRY_CREATE,
MAILIMAP_RESP_TEXT_CODE_UIDNEXT, MAILIMAP_RESP_TEXT_CODE_UIDVALIDITY,
MAILIMAP_RESP_TEXT_CODE_UNSEEN or MAILIMAP_RESP_TEXT_CODE_OTHER
- badcharset is a list of charsets if type
is MAILIMAP_RESP_TEXT_CODE_BADCHARSET, each element should be
allocated with malloc()
- cap_data is a list of capabilities
- perm_flags is a list of flags, this is the flags that can be changed
permanently on the messages of the mailbox.
- uidnext is the next unique identifier of a message
- uidvalidity is the unique identifier validity value
- first_unseen is the number of the first message without the \Seen flag
- atom is a keyword for an extension response code, should be allocated
with malloc()
- atom_value is the data related with the extension response code,
should be allocated with malloc()
*/
struct mailimap_resp_text_code {
int rc_type;
union {
clist * rc_badcharset; /* list of astring (char *) */
/* can be NULL */
struct mailimap_capability_data * rc_cap_data; /* != NULL */
clist * rc_perm_flags; /* list of (struct mailimap_flag_perm *) */
/* can be NULL */
uint32_t rc_uidnext;
uint32_t rc_uidvalidity;
uint32_t rc_first_unseen;
struct {
char * atom_name; /* can be NULL */
char * atom_value; /* can be NULL */
} rc_atom;
struct mailimap_extension_data * rc_ext_data; /* can be NULL */
} rc_data;
};
struct mailimap_resp_text_code *
mailimap_resp_text_code_new(int rc_type, clist * rc_badcharset,
struct mailimap_capability_data * rc_cap_data,
clist * rc_perm_flags,
uint32_t rc_uidnext, uint32_t rc_uidvalidity,
uint32_t rc_first_unseen, char * rc_atom, char * rc_atom_value,
struct mailimap_extension_data * rc_ext_data);
void
mailimap_resp_text_code_free(struct mailimap_resp_text_code * resp_text_code);
/*
mailimap_section is a MIME part section identifier
section_spec is the MIME section identifier
*/
struct mailimap_section {
struct mailimap_section_spec * sec_spec; /* can be NULL */
};
struct mailimap_section *
mailimap_section_new(struct mailimap_section_spec * sec_spec);
void mailimap_section_free(struct mailimap_section * section);
/* this is the type of the message/rfc822 part description */
enum {
MAILIMAP_SECTION_MSGTEXT_HEADER, /* header fields part of the
message */
MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS, /* given header fields of the
message */
MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS_NOT, /* header fields of the
message except the given */
MAILIMAP_SECTION_MSGTEXT_TEXT /* text part */
};
/*
mailimap_section_msgtext is a message/rfc822 part description
- type is the type of the content part and the value can be
MAILIMAP_SECTION_MSGTEXT_HEADER, MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS,
MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS_NOT
or MAILIMAP_SECTION_MSGTEXT_TEXT
- header_list is the list of headers when type is
MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS or
MAILIMAP_SECTION_MSGTEXT_HEADER_FIELDS_NOT
*/
struct mailimap_section_msgtext {
int sec_type;
struct mailimap_header_list * sec_header_list; /* can be NULL */
};
struct mailimap_section_msgtext *
mailimap_section_msgtext_new(int sec_type,
struct mailimap_header_list * sec_header_list);
void
mailimap_section_msgtext_free(struct mailimap_section_msgtext * msgtext);
/*
mailimap_section_part is the MIME part location in a message
- section_id is a list of number index of the sub-part in the mail structure,
each element should be allocated with malloc()
*/
struct mailimap_section_part {
clist * sec_id; /* list of nz-number (uint32_t *) */
/* != NULL */
};
struct mailimap_section_part *
mailimap_section_part_new(clist * sec_id);
void
mailimap_section_part_free(struct mailimap_section_part * section_part);
/* this is the type of section specification */
enum {
MAILIMAP_SECTION_SPEC_SECTION_MSGTEXT, /* if requesting data of the root
MIME message/rfc822 part */
MAILIMAP_SECTION_SPEC_SECTION_PART /* location of the MIME part
in the message */
};
/*
mailimap_section_spec is a section specification
- type is the type of the section specification, the value can be
MAILIMAP_SECTION_SPEC_SECTION_MSGTEXT or
MAILIMAP_SECTION_SPEC_SECTION_PART
- section_msgtext is a message/rfc822 part description if type is
MAILIMAP_SECTION_SPEC_SECTION_MSGTEXT
- section_part is a body part location in the message if type is
MAILIMAP_SECTION_SPEC_SECTION_PART
- section_text is a body part location for a given MIME part,
this can be NULL if the body of the part is requested (and not
the MIME header).
*/
struct mailimap_section_spec {
int sec_type;
union {
struct mailimap_section_msgtext * sec_msgtext; /* can be NULL */
struct mailimap_section_part * sec_part; /* can be NULL */
} sec_data;
struct mailimap_section_text * sec_text; /* can be NULL */
};
struct mailimap_section_spec *
mailimap_section_spec_new(int sec_type,
struct mailimap_section_msgtext * sec_msgtext,
struct mailimap_section_part * sec_part,
struct mailimap_section_text * sec_text);
void
mailimap_section_spec_free(struct mailimap_section_spec * section_spec);
/* this is the type of body part location for a given MIME part */
enum {
MAILIMAP_SECTION_TEXT_ERROR, /* on parse error **/
MAILIMAP_SECTION_TEXT_SECTION_MSGTEXT, /* if the MIME type is
message/rfc822, headers or text
can be requested */
MAILIMAP_SECTION_TEXT_MIME /* for all MIME types,
MIME headers can be requested */
};
/*
mailimap_section_text is the body part location for a given MIME part
- type can be MAILIMAP_SECTION_TEXT_SECTION_MSGTEXT or
MAILIMAP_SECTION_TEXT_MIME
- section_msgtext is the part of the MIME part when MIME type is
message/rfc822 than can be requested, when type is
MAILIMAP_TEXT_SECTION_MSGTEXT
*/
struct mailimap_section_text {
int sec_type;
struct mailimap_section_msgtext * sec_msgtext; /* can be NULL */
};
struct mailimap_section_text *
mailimap_section_text_new(int sec_type,
struct mailimap_section_msgtext * sec_msgtext);
void
mailimap_section_text_free(struct mailimap_section_text * section_text);
/* ************************************************************************* */
/* the following part concerns only the IMAP command that are sent */
/*
mailimap_set_item is a message set
- first is the first message of the set
- last is the last message of the set
this can be message numbers of message unique identifiers
*/
struct mailimap_set_item {
uint32_t set_first;
uint32_t set_last;
};
LIBETPAN_EXPORT
struct mailimap_set_item *
mailimap_set_item_new(uint32_t set_first, uint32_t set_last);
LIBETPAN_EXPORT
void mailimap_set_item_free(struct mailimap_set_item * set_item);
/*
set is a list of message sets
- list is a list of message sets
*/
struct mailimap_set {
clist * set_list; /* list of (struct mailimap_set_item *) */
};
LIBETPAN_EXPORT
struct mailimap_set * mailimap_set_new(clist * list);
LIBETPAN_EXPORT
void mailimap_set_free(struct mailimap_set * set);
/*
mailimap_date is a date
- day is the day in the month (1 to 31)
- month (1 to 12)
- year (4 digits)
*/
struct mailimap_date {
int dt_day;
int dt_month;
int dt_year;
};
struct mailimap_date *
mailimap_date_new(int dt_day, int dt_month, int dt_year);
void mailimap_date_free(struct mailimap_date * date);
/* this is the type of fetch attribute for a given message */
enum {
MAILIMAP_FETCH_ATT_ENVELOPE, /* to fetch the headers parsed by
the IMAP server */
MAILIMAP_FETCH_ATT_FLAGS, /* to fetch the flags */
MAILIMAP_FETCH_ATT_INTERNALDATE, /* to fetch the date of the message
kept by the server */
MAILIMAP_FETCH_ATT_RFC822, /* to fetch the entire message */
MAILIMAP_FETCH_ATT_RFC822_HEADER, /* to fetch the headers */
MAILIMAP_FETCH_ATT_RFC822_SIZE, /* to fetch the size */
MAILIMAP_FETCH_ATT_RFC822_TEXT, /* to fetch the text part */
MAILIMAP_FETCH_ATT_BODY, /* to fetch the MIME structure */
MAILIMAP_FETCH_ATT_BODYSTRUCTURE, /* to fetch the MIME structure with
additional information */
MAILIMAP_FETCH_ATT_UID, /* to fetch the unique identifier */
MAILIMAP_FETCH_ATT_BODY_SECTION, /* to fetch a given part */
MAILIMAP_FETCH_ATT_BODY_PEEK_SECTION, /* to fetch a given part without
marking the message as read */
MAILIMAP_FETCH_ATT_EXTENSION
};
/*
mailimap_fetch_att is the description of the fetch attribute
- type is the type of fetch attribute, the value can be
MAILIMAP_FETCH_ATT_ENVELOPE, MAILIMAP_FETCH_ATT_FLAGS,
MAILIMAP_FETCH_ATT_INTERNALDATE, MAILIMAP_FETCH_ATT_RFC822,
MAILIMAP_FETCH_ATT_RFC822_HEADER, MAILIMAP_FETCH_ATT_RFC822_SIZE,
MAILIMAP_FETCH_ATT_RFC822_TEXT, MAILIMAP_FETCH_ATT_BODY,
MAILIMAP_FETCH_ATT_BODYSTRUCTURE, MAILIMAP_FETCH_ATT_UID,
MAILIMAP_FETCH_ATT_BODY_SECTION, MAILIMAP_FETCH_ATT_BODY_PEEK_SECTION,
MAILIMAP_FETCH_ATT_EXTENSION
- section is the location of the part to fetch if type is
MAILIMAP_FETCH_ATT_BODY_SECTION or MAILIMAP_FETCH_ATT_BODY_PEEK_SECTION
- offset is the first byte to fetch in the given part
- size is the maximum size of the part to fetch
- att_extension: keyword to send when MAILIMAP_FETCH_ATT_EXTENSION is used
*/
struct mailimap_fetch_att {
int att_type;
struct mailimap_section * att_section;
uint32_t att_offset;
uint32_t att_size;
char * att_extension; /* can be NULL */
};
LIBETPAN_EXPORT
struct mailimap_fetch_att *
mailimap_fetch_att_new(int att_type, struct mailimap_section * att_section,
uint32_t att_offset, uint32_t att_size, char * att_extension);
LIBETPAN_EXPORT
void mailimap_fetch_att_free(struct mailimap_fetch_att * fetch_att);
/* this is the type of a FETCH operation */
enum {
MAILIMAP_FETCH_TYPE_ALL, /* equivalent to (FLAGS INTERNALDATE
RFC822.SIZE ENVELOPE) */
MAILIMAP_FETCH_TYPE_FULL, /* equivalent to (FLAGS INTERNALDATE
RFC822.SIZE ENVELOPE BODY) */
MAILIMAP_FETCH_TYPE_FAST, /* equivalent to (FLAGS INTERNALDATE
RFC822.SIZE) */
MAILIMAP_FETCH_TYPE_FETCH_ATT, /* when there is only of fetch
attribute */
MAILIMAP_FETCH_TYPE_FETCH_ATT_LIST /* when there is a list of fetch
attributes */
};
/*
mailimap_fetch_type is the description of the FETCH operation
- type can be MAILIMAP_FETCH_TYPE_ALL, MAILIMAP_FETCH_TYPE_FULL,
MAILIMAP_FETCH_TYPE_FAST, MAILIMAP_FETCH_TYPE_FETCH_ATT or
MAILIMAP_FETCH_TYPE_FETCH_ATT_LIST
- fetch_att is a fetch attribute if type is MAILIMAP_FETCH_TYPE_FETCH_ATT
- fetch_att_list is a list of fetch attributes if type is
MAILIMAP_FETCH_TYPE_FETCH_ATT_LIST
*/
struct mailimap_fetch_type {
int ft_type;
union {
struct mailimap_fetch_att * ft_fetch_att;
clist * ft_fetch_att_list; /* list of (struct mailimap_fetch_att *) */
} ft_data;
};
LIBETPAN_EXPORT
struct mailimap_fetch_type *
mailimap_fetch_type_new(int ft_type,
struct mailimap_fetch_att * ft_fetch_att,
clist * ft_fetch_att_list);
LIBETPAN_EXPORT
void mailimap_fetch_type_free(struct mailimap_fetch_type * fetch_type);
/*
mailimap_store_att_flags is the description of the STORE operation
(change flags of a message)
- sign can be 0 (set flag), +1 (add flag) or -1 (remove flag)
- silent has a value of 1 if the flags are changed with no server
response
- flag_list is the list of flags to change
*/
struct mailimap_store_att_flags {
int fl_sign;
int fl_silent;
struct mailimap_flag_list * fl_flag_list;
};
LIBETPAN_EXPORT
struct mailimap_store_att_flags *
mailimap_store_att_flags_new(int fl_sign, int fl_silent,
struct mailimap_flag_list * fl_flag_list);
LIBETPAN_EXPORT
void mailimap_store_att_flags_free(struct mailimap_store_att_flags *
store_att_flags);
/* this is the condition of the SEARCH operation */
enum {
MAILIMAP_SEARCH_KEY_ALL, /* all messages */
MAILIMAP_SEARCH_KEY_ANSWERED, /* messages with the flag \Answered */
MAILIMAP_SEARCH_KEY_BCC, /* messages whose Bcc field contains the
given string */
MAILIMAP_SEARCH_KEY_BEFORE, /* messages whose internal date is earlier
than the specified date */
MAILIMAP_SEARCH_KEY_BODY, /* message that contains the given string
(in header and text parts) */
MAILIMAP_SEARCH_KEY_CC, /* messages whose Cc field contains the
given string */
MAILIMAP_SEARCH_KEY_DELETED, /* messages with the flag \Deleted */
MAILIMAP_SEARCH_KEY_FLAGGED, /* messages with the flag \Flagged */
MAILIMAP_SEARCH_KEY_FROM, /* messages whose From field contains the
given string */
MAILIMAP_SEARCH_KEY_KEYWORD, /* messages with the flag keyword set */
MAILIMAP_SEARCH_KEY_NEW, /* messages with the flag \Recent and not
the \Seen flag */
MAILIMAP_SEARCH_KEY_OLD, /* messages that do not have the
\Recent flag set */
MAILIMAP_SEARCH_KEY_ON, /* messages whose internal date is the
specified date */
MAILIMAP_SEARCH_KEY_RECENT, /* messages with the flag \Recent */
MAILIMAP_SEARCH_KEY_SEEN, /* messages with the flag \Seen */
MAILIMAP_SEARCH_KEY_SINCE, /* messages whose internal date is later
than specified date */
MAILIMAP_SEARCH_KEY_SUBJECT, /* messages whose Subject field contains the
given string */
MAILIMAP_SEARCH_KEY_TEXT, /* messages whose text part contains the
given string */
MAILIMAP_SEARCH_KEY_TO, /* messages whose To field contains the
given string */
MAILIMAP_SEARCH_KEY_UNANSWERED, /* messages with no flag \Answered */
MAILIMAP_SEARCH_KEY_UNDELETED, /* messages with no flag \Deleted */
MAILIMAP_SEARCH_KEY_UNFLAGGED, /* messages with no flag \Flagged */
MAILIMAP_SEARCH_KEY_UNKEYWORD, /* messages with no flag keyword */
MAILIMAP_SEARCH_KEY_UNSEEN, /* messages with no flag \Seen */
MAILIMAP_SEARCH_KEY_DRAFT, /* messages with no flag \Draft */
MAILIMAP_SEARCH_KEY_HEADER, /* messages whose given field
contains the given string */
MAILIMAP_SEARCH_KEY_LARGER, /* messages whose size is larger then
the given size */
MAILIMAP_SEARCH_KEY_NOT, /* not operation of the condition */
MAILIMAP_SEARCH_KEY_OR, /* or operation between two conditions */
MAILIMAP_SEARCH_KEY_SENTBEFORE, /* messages whose date given in Date header
is earlier than the specified date */
MAILIMAP_SEARCH_KEY_SENTON, /* messages whose date given in Date header
is the specified date */
MAILIMAP_SEARCH_KEY_SENTSINCE, /* messages whose date given in Date header
is later than specified date */
MAILIMAP_SEARCH_KEY_SMALLER, /* messages whose size is smaller than
the given size */
MAILIMAP_SEARCH_KEY_UID, /* messages whose unique identifiers are
in the given range */
MAILIMAP_SEARCH_KEY_UNDRAFT, /* messages with no flag \Draft */
MAILIMAP_SEARCH_KEY_SET, /* messages whose number (or unique
identifiers in case of UID SEARCH) are
in the given range */
MAILIMAP_SEARCH_KEY_MULTIPLE, /* the boolean operator between the
conditions is AND */
MAILIMAP_SEARCH_KEY_MODSEQ, /* mod sequence */
MAILIMAP_SEARCH_KEY_XGMTHRID, /* Gmail thread id */
MAILIMAP_SEARCH_KEY_XGMMSGID, /* Gmail Message id */
MAILIMAP_SEARCH_KEY_XGMRAW /* Gmail RAW expression */
};
/*
mailimap_search_key is the condition on the messages to return
- type is the type of the condition
- bcc is the text to search in the Bcc field when type is
MAILIMAP_SEARCH_KEY_BCC, should be allocated with malloc()
- before is a date when type is MAILIMAP_SEARCH_KEY_BEFORE
- body is the text to search in the message when type is
MAILIMAP_SEARCH_KEY_BODY, should be allocated with malloc()
- cc is the text to search in the Cc field when type is
MAILIMAP_SEARCH_KEY_CC, should be allocated with malloc()
- from is the text to search in the From field when type is
MAILIMAP_SEARCH_KEY_FROM, should be allocated with malloc()
- keyword is the keyword flag name when type is MAILIMAP_SEARCH_KEY_KEYWORD,
should be allocated with malloc()
- on is a date when type is MAILIMAP_SEARCH_KEY_ON
- since is a date when type is MAILIMAP_SEARCH_KEY_SINCE
- subject is the text to search in the Subject field when type is
MAILIMAP_SEARCH_KEY_SUBJECT, should be allocated with malloc()
- text is the text to search in the text part of the message when
type is MAILIMAP_SEARCH_KEY_TEXT, should be allocated with malloc()
- to is the text to search in the To field when type is
MAILIMAP_SEARCH_KEY_TO, should be allocated with malloc()
- unkeyword is the keyword flag name when type is
MAILIMAP_SEARCH_KEY_UNKEYWORD, should be allocated with malloc()
- header_name is the header name when type is MAILIMAP_SEARCH_KEY_HEADER,
should be allocated with malloc()
- header_value is the text to search in the given header when type is
MAILIMAP_SEARCH_KEY_HEADER, should be allocated with malloc()
- larger is a size when type is MAILIMAP_SEARCH_KEY_LARGER
- not is a condition when type is MAILIMAP_SEARCH_KEY_NOT
- or1 is a condition when type is MAILIMAP_SEARCH_KEY_OR
- or2 is a condition when type is MAILIMAP_SEARCH_KEY_OR
- sentbefore is a date when type is MAILIMAP_SEARCH_KEY_SENTBEFORE
- senton is a date when type is MAILIMAP_SEARCH_KEY_SENTON
- sentsince is a date when type is MAILIMAP_SEARCH_KEY_SENTSINCE
- smaller is a size when type is MAILIMAP_SEARCH_KEY_SMALLER
- uid is a set of messages when type is MAILIMAP_SEARCH_KEY_UID
- set is a set of messages when type is MAILIMAP_SEARCH_KEY_SET
- xgmthrid is a number of the gmail thread id when type is MAILIMAP_SEARCH_KEY_XGMTHRID
use mailimap_search_key_new_xgmthrid() for this key
- xgmmsgid is a gmail message id expression when type is MAILIMAP_SEARCH_KEY_XGMMSGID
use mailimap_search_key_new_xgmmsgid() for this key
- xgmraw is a raw gmail search expression when type is MAILIMAP_SEARCH_KEY_XGMRAW
use mailimap_search_key_new_xgmraw() for this key
- multiple is a set of message when type is MAILIMAP_SEARCH_KEY_MULTIPLE
*/
enum {
MAILIMAP_SEARCH_KEY_MODSEQ_ENTRY_TYPE_REQ_PRIV,
MAILIMAP_SEARCH_KEY_MODSEQ_ENTRY_TYPE_REQ_SHARED,
MAILIMAP_SEARCH_KEY_MODSEQ_ENTRY_TYPE_REQ_ALL,
};
struct mailimap_search_key {
int sk_type;
union {
char * sk_bcc;
struct mailimap_date * sk_before;
char * sk_body;
char * sk_cc;
char * sk_from;
char * sk_keyword;
struct mailimap_date * sk_on;
struct mailimap_date * sk_since;
char * sk_subject;
char * sk_text;
char * sk_to;
char * sk_unkeyword;
struct {
char * sk_header_name;
char * sk_header_value;
} sk_header;
uint32_t sk_larger;
struct mailimap_search_key * sk_not;
struct {
struct mailimap_search_key * sk_or1;
struct mailimap_search_key * sk_or2;
} sk_or;
struct mailimap_date * sk_sentbefore;
struct mailimap_date * sk_senton;
struct mailimap_date * sk_sentsince;
uint32_t sk_smaller;
struct mailimap_set * sk_uid;
struct mailimap_set * sk_set;
uint64_t sk_xgmthrid;
uint64_t sk_xgmmsgid;
char * sk_xgmraw;
clist * sk_multiple; /* list of (struct mailimap_search_key *) */
struct {
struct mailimap_flag * sk_entry_name;
int sk_entry_type_req;
uint64_t sk_modseq_valzer;
} sk_modseq;
} sk_data;
};
LIBETPAN_EXPORT
struct mailimap_search_key *
mailimap_search_key_new(int sk_type,
char * sk_bcc, struct mailimap_date * sk_before, char * sk_body,
char * sk_cc, char * sk_from, char * sk_keyword,
struct mailimap_date * sk_on, struct mailimap_date * sk_since,
char * sk_subject, char * sk_text, char * sk_to,
char * sk_unkeyword, char * sk_header_name,
char * sk_header_value, uint32_t sk_larger,
struct mailimap_search_key * sk_not,
struct mailimap_search_key * sk_or1,
struct mailimap_search_key * sk_or2,
struct mailimap_date * sk_sentbefore,
struct mailimap_date * sk_senton,
struct mailimap_date * sk_sentsince,
uint32_t sk_smaller, struct mailimap_set * sk_uid,
struct mailimap_set * sk_set, clist * sk_multiple);
/*
this function creates a condition structure to match messages with
the given gmail thread id
*/
LIBETPAN_EXPORT
struct mailimap_search_key *
mailimap_search_key_new_xgmthrid(uint64_t sk_xgmthrid);
LIBETPAN_EXPORT
struct mailimap_search_key *
mailimap_search_key_new_xgmmsgid(uint64_t sk_xgmmsgid);
LIBETPAN_EXPORT
struct mailimap_search_key *
mailimap_search_key_new_xgmraw(char * sk_xgmraw);
LIBETPAN_EXPORT
void mailimap_search_key_free(struct mailimap_search_key * key);
/*
mailimap_status_att_list is a list of mailbox STATUS request type
- list is a list of mailbox STATUS request type
(value of elements in the list can be MAILIMAP_STATUS_ATT_MESSAGES,
MAILIMAP_STATUS_ATT_RECENT, MAILIMAP_STATUS_ATT_UIDNEXT,
MAILIMAP_STATUS_ATT_UIDVALIDITY or MAILIMAP_STATUS_ATT_UNSEEN),
each element should be allocated with malloc()
*/
struct mailimap_status_att_list {
clist * att_list; /* list of (uint32_t *) */
};
struct mailimap_status_att_list *
mailimap_status_att_list_new(clist * att_list);
void mailimap_status_att_list_free(struct mailimap_status_att_list *
status_att_list);
/* internal use functions */
uint32_t * mailimap_number_alloc_new(uint32_t number);
void mailimap_number_alloc_free(uint32_t * pnumber);
void mailimap_addr_host_free(char * addr_host);
void mailimap_addr_mailbox_free(char * addr_mailbox);
void mailimap_addr_adl_free(char * addr_adl);
void mailimap_addr_name_free(char * addr_name);
void mailimap_astring_free(char * astring);
void mailimap_atom_free(char * atom);
void mailimap_auth_type_free(char * auth_type);
void mailimap_base64_free(char * base64);
void mailimap_body_fld_desc_free(char * body_fld_desc);
void mailimap_body_fld_id_free(char * body_fld_id);
void mailimap_body_fld_md5_free(char * body_fld_md5);
void mailimap_body_fld_loc_free(char * body_fld_loc);
void mailimap_env_date_free(char * date);
void mailimap_env_in_reply_to_free(char * in_reply_to);
void mailimap_env_message_id_free(char * message_id);
void mailimap_env_subject_free(char * subject);
void mailimap_flag_extension_free(char * flag_extension);
void mailimap_flag_keyword_free(char * flag_keyword);
void
mailimap_header_fld_name_free(char * header_fld_name);
void mailimap_literal_free(char * literal);
void mailimap_mailbox_free(char * mailbox);
void
mailimap_mailbox_data_search_free(clist * data_search);
void mailimap_media_subtype_free(char * media_subtype);
void mailimap_media_text_free(char * media_text);
void mailimap_msg_att_envelope_free(struct mailimap_envelope * env);
void
mailimap_msg_att_internaldate_free(struct mailimap_date_time * date_time);
void
mailimap_msg_att_rfc822_free(char * str);
void
mailimap_msg_att_rfc822_header_free(char * str);
void
mailimap_msg_att_rfc822_text_free(char * str);
void
mailimap_msg_att_body_free(struct mailimap_body * body);
void
mailimap_msg_att_bodystructure_free(struct mailimap_body * body);
void mailimap_nstring_free(char * str);
void
mailimap_string_free(char * str);
void mailimap_tag_free(char * tag);
void mailimap_text_free(char * text);
/* IMAP connection */
/* this is the state of the IMAP connection */
enum {
MAILIMAP_STATE_DISCONNECTED,
MAILIMAP_STATE_NON_AUTHENTICATED,
MAILIMAP_STATE_AUTHENTICATED,
MAILIMAP_STATE_SELECTED,
MAILIMAP_STATE_LOGOUT
};
/*
mailimap is an IMAP connection
- response is a human readable message returned with a reponse,
must be accessed read-only
- stream is the connection with the IMAP server
- stream_buffer is the buffer where the data to parse are stored
- state is the state of IMAP connection
- tag is the current tag being used in IMAP connection
- response_buffer is the buffer for response messages
- connection_info is the information returned in response
for the last command about the connection
- selection_info is the information returned in response
for the last command about the current selected mailbox
- response_info is the other information returned in response
for the last command
*/
typedef void mailimap_msg_att_handler(struct mailimap_msg_att * msg_att, void * context);
typedef struct mailimap mailimap;
struct mailimap {
char * imap_response;
/* internals */
mailstream * imap_stream;
size_t imap_progr_rate;
progress_function * imap_progr_fun;
MMAPString * imap_stream_buffer;
MMAPString * imap_response_buffer;
int imap_state;
int imap_tag;
struct mailimap_connection_info * imap_connection_info;
struct mailimap_selection_info * imap_selection_info;
struct mailimap_response_info * imap_response_info;
struct {
void * sasl_conn;
const char * sasl_server_fqdn;
const char * sasl_login;
const char * sasl_auth_name;
const char * sasl_password;
const char * sasl_realm;
void * sasl_secret;
} imap_sasl;
time_t imap_idle_timestamp;
time_t imap_idle_maxdelay;
mailprogress_function * imap_body_progress_fun;
mailprogress_function * imap_items_progress_fun;
void * imap_progress_context;
mailimap_msg_att_handler * imap_msg_att_handler;
void * imap_msg_att_handler_context;
time_t imap_timeout;
void (* imap_logger)(mailimap * session, int log_type, const char * str, size_t size, void * context);
void * imap_logger_context;
};
/*
mailimap_connection_info is the information about the connection
- capability is the list of capability of the IMAP server
*/
struct mailimap_connection_info {
struct mailimap_capability_data * imap_capability;
};
struct mailimap_connection_info *
mailimap_connection_info_new(void);
void
mailimap_connection_info_free(struct mailimap_connection_info * conn_info);
/* this is the type of mailbox access */
enum {
MAILIMAP_MAILBOX_READONLY,
MAILIMAP_MAILBOX_READWRITE
};
/*
mailimap_selection_info is information about the current selected mailbox
- perm_flags is a list of flags that can be changed permanently on the
messages of the mailbox
- perm is the access on the mailbox, value can be
MAILIMAP_MAILBOX_READONLY or MAILIMAP_MAILBOX_READWRITE
- uidnext is the next unique identifier
- uidvalidity is the unique identifiers validity
- first_unseen is the number of the first unseen message
- flags is a list of flags that can be used on the messages of
the mailbox
- exists is the number of messages in the mailbox
- recent is the number of recent messages in the mailbox
- unseen is the number of unseen messages in the mailbox
*/
struct mailimap_selection_info {
clist * sel_perm_flags; /* list of (struct flag_perm *) */
int sel_perm;
uint32_t sel_uidnext;
uint32_t sel_uidvalidity;
uint32_t sel_first_unseen;
struct mailimap_flag_list * sel_flags;
uint32_t sel_exists;
uint32_t sel_recent;
uint32_t sel_unseen;
uint8_t sel_has_exists:1;
uint8_t sel_has_recent:1;
};
struct mailimap_selection_info *
mailimap_selection_info_new(void);
void
mailimap_selection_info_free(struct mailimap_selection_info * sel_info);
/*
mailimap_response_info is the other information returned in the
response for a command
- alert is the human readable text returned with ALERT response
- parse is the human readable text returned with PARSE response
- badcharset is a list of charset returned with a BADCHARSET response
- trycreate is set to 1 if a trycreate response was returned
- mailbox_list is a list of mailboxes
- mailbox_lsub is a list of subscribed mailboxes
- search_result is a list of message numbers or unique identifiers
- status is a STATUS response
- expunged is a list of message numbers
- fetch_list is a list of fetch response
*/
struct mailimap_response_info {
char * rsp_alert;
char * rsp_parse;
clist * rsp_badcharset; /* list of (char *) */
int rsp_trycreate;
clist * rsp_mailbox_list; /* list of (struct mailimap_mailbox_list *) */
clist * rsp_mailbox_lsub; /* list of (struct mailimap_mailbox_list *) */
clist * rsp_search_result; /* list of (uint32_t *) */
struct mailimap_mailbox_data_status * rsp_status;
clist * rsp_expunged; /* list of (uint32_t 32 *) */
clist * rsp_fetch_list; /* list of (struct mailimap_msg_att *) */
clist * rsp_extension_list; /* list of (struct mailimap_extension_data *) */
char * rsp_atom;
char * rsp_value;
};
struct mailimap_response_info *
mailimap_response_info_new(void);
void
mailimap_response_info_free(struct mailimap_response_info * resp_info);
/* these are the possible returned error codes */
enum {
MAILIMAP_NO_ERROR = 0,
MAILIMAP_NO_ERROR_AUTHENTICATED = 1,
MAILIMAP_NO_ERROR_NON_AUTHENTICATED = 2,
MAILIMAP_ERROR_BAD_STATE,
MAILIMAP_ERROR_STREAM,
MAILIMAP_ERROR_PARSE,
MAILIMAP_ERROR_CONNECTION_REFUSED,
MAILIMAP_ERROR_MEMORY,
MAILIMAP_ERROR_FATAL,
MAILIMAP_ERROR_PROTOCOL,
MAILIMAP_ERROR_DONT_ACCEPT_CONNECTION,
MAILIMAP_ERROR_APPEND,
MAILIMAP_ERROR_NOOP,
MAILIMAP_ERROR_LOGOUT,
MAILIMAP_ERROR_CAPABILITY,
MAILIMAP_ERROR_CHECK,
MAILIMAP_ERROR_CLOSE,
MAILIMAP_ERROR_EXPUNGE,
MAILIMAP_ERROR_COPY,
MAILIMAP_ERROR_UID_COPY,
MAILIMAP_ERROR_CREATE,
MAILIMAP_ERROR_DELETE,
MAILIMAP_ERROR_EXAMINE,
MAILIMAP_ERROR_FETCH,
MAILIMAP_ERROR_UID_FETCH,
MAILIMAP_ERROR_LIST,
MAILIMAP_ERROR_LOGIN,
MAILIMAP_ERROR_LSUB,
MAILIMAP_ERROR_RENAME,
MAILIMAP_ERROR_SEARCH,
MAILIMAP_ERROR_UID_SEARCH,
MAILIMAP_ERROR_SELECT,
MAILIMAP_ERROR_STATUS,
MAILIMAP_ERROR_STORE,
MAILIMAP_ERROR_UID_STORE,
MAILIMAP_ERROR_SUBSCRIBE,
MAILIMAP_ERROR_UNSUBSCRIBE,
MAILIMAP_ERROR_STARTTLS,
MAILIMAP_ERROR_INVAL,
MAILIMAP_ERROR_EXTENSION,
MAILIMAP_ERROR_SASL,
MAILIMAP_ERROR_SSL,
MAILIMAP_ERROR_NEEDS_MORE_DATA
};
#ifdef __cplusplus
}
#endif
#endif
|