/usr/share/GNUstep/Documentation/Developer/BaseAdditions/Reference/GSMime.html is in gnustep-base-doc 1.24.7-1build2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>The MIME parsing system</title>
</head>
<body>
<font face="serif">
<a href="BaseAdditions.html">Up</a>
<br />
<h1><a name="title$GSMime">The MIME parsing system</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Version:</b> 37740</p>
<p><b>Date:</b> 2014-03-11 09:46:54 +0000 (Tue, 11 Mar 2014)</p>
<p><b>Copyright:</b> (C) 2000 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Mime Parser</a>
</li>
<li>
<a href="#002000000000">Software documentation for the GSMimeCodingContext
class</a>
</li>
<li>
<a href="#003000000000">Software documentation for the GSMimeDocument class</a>
</li>
<li>
<a href="#004000000000">Software documentation for the GSMimeHeader class</a>
</li>
<li>
<a href="#005000000000">Software documentation for the GSMimeParser class</a>
</li>
<li>
<a href="#006000000000">Software documentation for the GSMimeSMTPClient class</a>
</li>
<li>
<a href="#007000000000">Software documentation for the
NSObject(GSMimeSMTPClient) category</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">Mime Parser</a></h1>
<p>
The GNUstep Mime parser. This is collection Objective-C
classes for representing MIME (and HTTP) documents and
managing conversions to and from convenient internal
formats.
</p>
<p>
The idea is to center round two classes -
</p>
<dl>
<dt>document</dt>
<dd>
A container for the actual data (and headers) of a
mime/http document, this is also used to create raw
MIME data for sending.
</dd>
<dt>parser</dt>
<dd>
An object that can be fed data and will parse it into a
document. This object also provides various utility
methods and an API that permits overriding in order
to extend the functionality to cope with new document
types.
</dd>
</dl>
<h1><a name="002000000000">
Software documentation for the GSMimeCodingContext
class
</a></h1>
<h2><a name="class$GSMimeCodingContext">GSMimeCodingContext</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Coding contexts are objects used by the parser to
store the state of decoding incoming data while it is
being incrementally parsed. <br /> The most rudimentary
context... this is used for decoding plain text and
binary data (ie data which is not really decoded at
all) and all other decoding work is done by a subclass.
</div>
<hr width="50%" align="left" />
<a href="#_GSMimeCodingContext_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeCodingContext-atEnd">-atEnd</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeCodingContext-decodeData$length$intoData$">-decodeData:length:intoData:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeCodingContext-setAtEnd$">-setAtEnd:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSMimeCodingContext-atEnd">atEnd </a></h3>
- (BOOL) <b>atEnd</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the current value of the 'atEnd' flag.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeCodingContext-decodeData$length$intoData$">decodeData: length: intoData: </a></h3>
- (BOOL) <b>decodeData:</b> (const void*)sData<b> length:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)length<b> intoData:</b> (NSMutableData*)dData;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Decode <var>length</var> bytes of data from
<var>sData</var> and append the results to
<var>dData</var>. <br /> Return <code>YES</code> on
success, <code>NO</code> if there is an error.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeCodingContext-setAtEnd$">setAtEnd: </a></h3>
- (void) <b>setAtEnd:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the current value of the 'atEnd' <var>flag</var>.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSMimeCodingContext_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSMimeCodingContext Class</h2>
<h3><a name="ivariable$GSMimeCodingContext*atEnd">atEnd</a></h3>
@protected BOOL <b>atEnd</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="003000000000">
Software documentation for the GSMimeDocument class
</a></h1>
<h2><a name="class$GSMimeDocument">GSMimeDocument</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCopying</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This class is intended to provide a wrapper for MIME
messages permitting easy access to the contents of
a message and providing a basis for parsing an unparsing
messages that have arrived via email or as a web
document.
</p>
<p>
</p>
<p>
The class keeps track of all the document headers, and
provides methods for modifying and examining the
headers that apply to a document.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_GSMimeDocument_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+charsetFromEncoding$">+charsetFromEncoding:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+decodeBase64$">+decodeBase64:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+decodeBase64String$">+decodeBase64String:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+documentWithContent$type$name$">+documentWithContent:type:name:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+encodeBase64$">+encodeBase64:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+encodeBase64String$">+encodeBase64String:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument+encodingFromCharset$">+encodingFromCharset:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-addContent$">-addContent:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-addHeader$">-addHeader:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-addHeader$value$parameters$">-addHeader:value:parameters:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-allHeaders">-allHeaders</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-content">-content</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentByID$">-contentByID:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentByLocation$">-contentByLocation:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentByName$">-contentByName:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentFile">-contentFile</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentID">-contentID</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentLocation">-contentLocation</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentName">-contentName</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentSubtype">-contentSubtype</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentType">-contentType</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-contentsByName$">-contentsByName:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-convertToBase64">-convertToBase64</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-convertToBinary">-convertToBinary</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-convertToData">-convertToData</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-convertToText">-convertToText</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-copyWithZone$">-copyWithZone:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-deleteContent$">-deleteContent:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-deleteHeader$">-deleteHeader:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-deleteHeaderNamed$">-deleteHeaderNamed:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-headerNamed$">-headerNamed:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-headersNamed$">-headersNamed:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-makeBoundary">-makeBoundary</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-makeContentID">-makeContentID</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-makeHeader$value$parameters$">-makeHeader:value:parameters:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-makeMessageID">-makeMessageID</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-rawMimeData">-rawMimeData</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-rawMimeData$">-rawMimeData:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-rawMimeData$foldedAt$">-rawMimeData:foldedAt:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setContent$">-setContent:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setContent$type$">-setContent:type:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setContent$type$name$">-setContent:type:name:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setContentType$">-setContentType:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setHeader$">-setHeader:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeDocument-setHeader$value$parameters$">-setHeader:value:parameters:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSMimeDocument+charsetFromEncoding$">charsetFromEncoding: </a></h3>
+ (NSString*) <b>charsetFromEncoding:</b> (NSStringEncoding)enc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the MIME characterset name corresponding to
the specified string encoding. <br /> As a special
case, returns "us-ascii" if <var>enc</var> is zero.
<br /> Returns <code>nil</code> if <var>enc</var>
cannot be mapped to a charset. <br /> NB. The
correspondence between charsets and
encodings is not a direct one to one mapping, so
successive calls to
<a rel="gsdoc" href="#method$GSMimeDocument+encodingFromCharset$">
+encodingFromCharset:
</a>
and
<a rel="gsdoc" href="#method$GSMimeDocument+charsetFromEncoding$">
+charsetFromEncoding:
</a>
may not produce the original input.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+decodeBase64$">decodeBase64: </a></h3>
+ (NSData*) <b>decodeBase64:</b> (NSData*)source;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Decode the <var>source</var> data from base64
encoding and return the result. <br /> The
<var>source</var> data is expected to be ASCII text
and may be multiple lines or a line of any length
(decoding is very tolerant).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+decodeBase64String$">decodeBase64String: </a></h3>
+ (NSString*) <b>decodeBase64String:</b> (NSString*)source;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Converts the base64 encoded data in
<var>source</var> to a decoded ASCII or UTF8 string
using the
<a rel="gsdoc" href="#method$GSMimeDocument+decodeBase64$">
+decodeBase64:
</a>
method. If the encoded data does not represent an
ASCII or UTF8 string, you should use the
<a rel="gsdoc" href="#method$GSMimeDocument+decodeBase64$">
+decodeBase64:
</a>
method directly.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+documentWithContent$type$name$">documentWithContent: type: name: </a></h3>
+ (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*) <b>documentWithContent:</b> (id)newContent<b> type:</b> (NSString*)type<b> name:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to return an autoreleased
document using the specified content,
<var>type</var>, and <var>name</var> value. This
calls the
<a rel="gsdoc" href="#method$GSMimeDocument-setContent$type$name$">
-setContent:type:name:
</a>
method to set up the document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+encodeBase64$">encodeBase64: </a></h3>
+ (NSData*) <b>encodeBase64:</b> (NSData*)source;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Encode the <var>source</var> data to base64 encoding
and return the result. <br /> The resulting data is
ASCII text and contains only the base64 encoded
values with no line breaks or extraneous data. This
is base64 encoded data in it's general format as
mandated in RFC 3548. If the data is to be used as
part of a MIME document body, line breaks must be
introduced at 76 byte intervals (GSMime does
this when automatically encoding data for you). If the
data is to be used in a PEM document line breaks must
be introduced at 74 byte intervals.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+encodeBase64String$">encodeBase64String: </a></h3>
+ (NSString*) <b>encodeBase64String:</b> (NSString*)source;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Converts the ASCII or UTF8 string
<var>source</var> into base64 encoded data using the
<a rel="gsdoc" href="#method$GSMimeDocument+encodeBase64$">
+encodeBase64:
</a>
method. If the original data is not an ASCII or
UTF8 string, you should use the
<a rel="gsdoc" href="#method$GSMimeDocument+encodeBase64$">
+encodeBase64:
</a>
method directly.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument+encodingFromCharset$">encodingFromCharset: </a></h3>
+ (NSStringEncoding) <b>encodingFromCharset:</b> (NSString*)charset;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the string encoding corresponding to the
specified MIME characterset name. <br /> As a
special case, returns NSASCIIStringEncoding if
<var>charset</var> is <code>nil</code>. <br />
Returns 0 if <var>charset</var> cannot be found.
<br /> NB. We treat iso-10646-ucs-2 as utf-16, which
should work for most text, but is not strictly
correct. <br /> The correspondence between
charsets and encodings is not a direct one to one
mapping, so successive calls to
<a rel="gsdoc" href="#method$GSMimeDocument+encodingFromCharset$">
+encodingFromCharset:
</a>
and
<a rel="gsdoc" href="#method$GSMimeDocument+charsetFromEncoding$">
+charsetFromEncoding:
</a>
may not produce the original input.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-addContent$">addContent: </a></h3>
- (void) <b>addContent:</b> (id)newContent;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Adds a part to a multipart document
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-addHeader$">addHeader: </a></h3>
- (void) <b>addHeader:</b> (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*)info;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method may be called to add a header to the
document. The header must be a mutable
dictionary object that contains at least the
fields that are standard for all headers.
</p>
<p>
</p>
<p>
Certain well-known headers are restricted to one
occurrence in an email, and when extra copies
are added they replace originals.
</p>
<p>
</p>
<p>
The mime-version header is special... it is inserted
before any other mime headers rather than being
added at the end.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-addHeader$value$parameters$">addHeader: value: parameters: </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>addHeader:</b> (NSString*)name<b> value:</b> (NSString*)value<b> parameters:</b> (NSDictionary*)parameters;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to create a new header and
add it to the receiver. <br /> Returns the newly
created header. <br /> See
<a rel="gsdoc" href="#method$GSMimeHeader-initWithName$value$parameters$">[GSMimeHeader -initWithName:value:parameters:]</a>
and <a rel="gsdoc" href="#method$GSMimeDocument-addHeader$">-addHeader:</a>
methods.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-allHeaders">allHeaders </a></h3>
- (NSArray*) <b>allHeaders</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method returns an array containing GSMimeHeader
objects representing the headers associated with
the document.
</p>
<p>
</p>
<p>
The order of the headers in the array is the order of
the headers in the document.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-content">content </a></h3>
- (id) <b>content</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This returns the content data of the document in the
same format in which the data was placed in the
document. This may be one of -
<dl>
<dt>text</dt>
<dd>
an NSString object
</dd>
<dt>binary</dt>
<dd>
an NSData object
</dd>
<dt>multipart</dt>
<dd>
an NSArray object containing GSMimeDocument objects
</dd>
</dl>
If you want to be sure that you get a particular type of
data, use the
<a rel="gsdoc" href="#method$GSMimeDocument-convertToData">
-convertToData
</a>
or
<a rel="gsdoc" href="#method$GSMimeDocument-convertToText">
-convertToText
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentByID$">contentByID: </a></h3>
- (id) <b>contentByID:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Search the content of this document to locate a part
whose content ID matches the specified <var>key</var>
. Recursively descend into other documents. <br /> Wraps
the supplied <var>key</var> in angle brackets if they
are not present. <br /> Return <code>nil</code> if no
match is found, the matching GSMimeDocument
otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentByLocation$">contentByLocation: </a></h3>
- (id) <b>contentByLocation:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Search the content of this document to locate a part
whose content ID matches the specified <var>key</var>
. Recursively descend into other documents. <br /> Wraps
the supplied <var>key</var> in angle brackets if they
are not present. <br /> Return <code>nil</code> if no
match is found, the matching GSMimeDocument
otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentByName$">contentByName: </a></h3>
- (id) <b>contentByName:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Search the content of this document to locate a part
whose content-type name or content-disposition name
matches the specified <var>key</var>. Recursively
descend into other documents. <br /> Return
<code>nil</code> if no match is found, the matching
GSMimeDocument otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentFile">contentFile </a></h3>
- (NSString*) <b>contentFile</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content file
name from the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentID">contentID </a></h3>
- (NSString*) <b>contentID</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content ID from
the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentLocation">contentLocation </a></h3>
- (NSString*) <b>contentLocation</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content
location from the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentName">contentName </a></h3>
- (NSString*) <b>contentName</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content name
from the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentSubtype">contentSubtype </a></h3>
- (NSString*) <b>contentSubtype</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content
sub-type from the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentType">contentType </a></h3>
- (NSString*) <b>contentType</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to fetch the content type
from the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-contentsByName$">contentsByName: </a></h3>
- (NSArray*) <b>contentsByName:</b> (NSString*)key;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Search the content of this document to locate all
parts whose content-type name or content-disposition
name matches the specified <var>key</var>. Do
<em>NOT</em> recurse into other documents. <br />
Return <code>nil</code> if no match is found, an
array of matching GSMimeDocument instances otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-convertToBase64">convertToBase64 </a></h3>
- (void) <b>convertToBase64</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Converts any binary parts of the receiver's
content to be base64 encoded rather than 8bit or
binary encoded... a convenience method to make the
results of the
<a rel="gsdoc" href="#method$GSMimeDocument-rawMimeData">
-rawMimeData
</a>
method safe for sending via routes which only
support 7bit data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-convertToBinary">convertToBinary </a></h3>
- (void) <b>convertToBinary</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Converts any base64 encoded parts of the
receiver's content to be binary encoded instead
... a convenience method to shrink down the size of the
message when converted to data using the
<a rel="gsdoc" href="#method$GSMimeDocument-rawMimeData">
-rawMimeData
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-convertToData">convertToData </a></h3>
- (NSData*) <b>convertToData</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the content as an NSData object (unless it is
multipart) <br /> Perform conversion from text
to data using the charset specified in the content-type
header, or infer the charset, and update the header
accordingly. <br /> If the content can not be
represented as a plain NSData object, this
method returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-convertToText">convertToText </a></h3>
- (NSString*) <b>convertToText</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the content as an NSString object (unless it
is multipart) If the content cannot be represented as
text, this returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-copyWithZone$">copyWithZone: </a></h3>
- (id) <b>copyWithZone:</b> (NSZone*)z;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a copy of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-deleteContent$">deleteContent: </a></h3>
- (void) <b>deleteContent:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)aPart;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Deletes all ocurrances of parts identical to
<var>aPart</var> from the receiver. <br />
Recursively deletes from enclosed documents as
necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-deleteHeader$">deleteHeader: </a></h3>
- (void) <b>deleteHeader:</b> (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*)aHeader;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method removes all occurrences of header objects
identical to the one supplied as an argument.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-deleteHeaderNamed$">deleteHeaderNamed: </a></h3>
- (void) <b>deleteHeaderNamed:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method removes all occurrences of headers whose
<var>name</var> matches the supplied string.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-headerNamed$">headerNamed: </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>headerNamed:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method returns the first header whose
<var>name</var> equals the supplied argument.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-headersNamed$">headersNamed: </a></h3>
- (NSArray*) <b>headersNamed:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method returns an array of GSMimeHeader objects
for all headers whose names equal the supplied
argument.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-makeBoundary">makeBoundary </a></h3>
- (NSString*) <b>makeBoundary</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Make a probably unique string suitable for use as
the boundary parameter in the content of a multipart
document.
</p>
<p>
</p>
<p>
This implementation provides base64 encoded data
consisting of an MD5 digest of some pseudo
random stuff, plus an incrementing counter. The
inclusion of the counter guarantees that we
won't produce two identical strings in the same run
of the program.
</p>
<p>
</p>
<p>
The boundary has a suffix of '=_' to ensure it's not
mistaken for quoted-printable data.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-makeContentID">makeContentID </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>makeContentID</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create new content ID header, set it as the content
ID of the document and return it. <br /> This is a
convenience method which simply places angle
brackets around an
[NSProcessInfo -globallyUniqueString]
to form the header value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-makeHeader$value$parameters$">makeHeader: value: parameters: </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>makeHeader:</b> (NSString*)name<b> value:</b> (NSString*)value<b> parameters:</b> (NSDictionary*)parameters;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Deprecated... use
<a rel="gsdoc" href="#method$GSMimeDocument-setHeader$value$parameters$">
-setHeader:value:parameters:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-makeMessageID">makeMessageID </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>makeMessageID</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create new message ID header, set it as the message
ID of the document and return it. <br /> This is a
convenience method which simply places angle
brackets around an
[NSProcessInfo -globallyUniqueString]
to form the header value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-rawMimeData">rawMimeData </a></h3>
- (NSMutableData*) <b>rawMimeData</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return an NSData object representing the MIME
document as raw data ready to be sent via an email
system. <br /> Calls
<a rel="gsdoc" href="#method$GSMimeDocument-rawMimeData$">
-rawMimeData:
</a>
with the isOuter flag set to <code>YES</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-rawMimeData$">rawMimeData: </a></h3>
- (NSMutableData*) <b>rawMimeData:</b> (BOOL)isOuter;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Return an NSData object representing the MIME
document as raw data ready to be sent via an
email system.
</p>
<p>
</p>
<p>
The <var>isOuter</var> flag denotes whether this
document is the outermost part of a MIME
message, or is a part of a multipart message.
</p>
<p>
</p>
<p>
Long lines are folded at the default column.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-rawMimeData$foldedAt$">rawMimeData: foldedAt: </a></h3>
- (NSMutableData*) <b>rawMimeData:</b> (BOOL)isOuter<b> foldedAt:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)fold;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Return an NSData object representing the MIME
document as raw data ready to be sent via an
email system.
</p>
<p>
</p>
<p>
The <var>isOuter</var> flag denotes whether this
document is the outermost part of a MIME
message, or is a part of a multipart message.
</p>
<p>
</p>
<p>
The <var>fold</var> number specifes the column at
which lines are considered to be 'long', and get
broken/folded.
</p>
<p>
</p>
<p>
During generation of the document this method will
perform some consistency checks and try to
automatically generate missing header
information needed to build the mime data
(eg. filling in the boundary parameter in the
content-type header for multipart
documents). <br /> However, you should not
depend on automatic behaviors but should fill in
as much detail as possible before generating data.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setContent$">setContent: </a></h3>
- (void) <b>setContent:</b> (id)newContent;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets a new value for the content of the document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setContent$type$">setContent: type: </a></h3>
- (void) <b>setContent:</b> (id)newContent<b> type:</b> (NSString*)type;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method calling
<a rel="gsdoc" href="#method$GSMimeDocument-setContent$type$name$">
-setContent:type:name:
</a>
to set document content and <var>type</var> with a
<code>nil</code> value for name... useful for
top-level documents rather than parts within a
document (parts should really be named).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setContent$type$name$">setContent: type: name: </a></h3>
- (void) <b>setContent:</b> (id)newContent<b> type:</b> (NSString*)type<b> name:</b> (NSString*)name;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Convenience method to set the content of the
document along with creating a content-type
header for it.
</p>
<p>
</p>
<p>
The <var>type</var> parameter may be a simple common
content <var>type</var> (text, multipart, or
application), in which case the default
subtype for that <var>type</var> is used.
Alternatively it may be full detail of a
content <var>type</var> header value, which will
be parsed into 'type', 'subtype' and 'parameters'.
<br /> NB. In this case, if the parsed data
contains a 'name' parameter and the
<var>name</var> argument is non-nil, the argument
value will override the parsed value.
</p>
<p>
</p>
<p>
You can get the same effect by calling
<a rel="gsdoc" href="#method$GSMimeDocument-setContent$">
-setContent:
</a>
to set the document content, then creating a
<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>
instance, initialising it with the content
<var>type</var> information you want using
<a rel="gsdoc" href="#method$GSMimeHeader-initWithName$value$parameters$">[GSMimeHeader -initWithName:value:parameters:]</a>
, and calling the <a rel="gsdoc" href="#method$GSMimeDocument-setHeader$">-setHeader:</a>
method to attach it to the document.
</p>
<p>
</p>
<p>
Using this method imposes a few extra checks and
restrictions on the combination of content
and type/subtype you may use... so you may want to
use the more primitive methods in order to bypass
these checks if you are using unusual
type/subtype information or if you need to
provide additional parameters in the header.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setContentType$">setContentType: </a></h3>
- (void) <b>setContentType:</b> (NSString*)newType;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Convenience method to set the content type of
the document without altering any content. The
supplied <var>newType</var> may be full type
information including subtype and parameters
as found after the colon in a mime Content-Type
header.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setHeader$">setHeader: </a></h3>
- (void) <b>setHeader:</b> (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*)info;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method may be called to set a header in the
document. Any other headers with the same name
will be removed from the document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeDocument-setHeader$value$parameters$">setHeader: value: parameters: </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*) <b>setHeader:</b> (NSString*)name<b> value:</b> (NSString*)value<b> parameters:</b> (NSDictionary*)parameters;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to create a new header and
add it to the receiver replacing any existing header of
the same <var>name</var>. <br /> Returns the newly
created header. <br /> See
<a rel="gsdoc" href="#method$GSMimeHeader-initWithName$value$parameters$">[GSMimeHeader -initWithName:value:parameters:]</a>
and <a rel="gsdoc" href="#method$GSMimeDocument-setHeader$">-setHeader:</a>
methods.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSMimeDocument_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSMimeDocument Class</h2>
<h3><a name="ivariable$GSMimeDocument*_unused">_unused</a></h3>
@protected void* <b>_unused</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeDocument*content">content</a></h3>
@protected id <b>content</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeDocument*headers">headers</a></h3>
@protected NSMutableArray* <b>headers</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="004000000000">
Software documentation for the GSMimeHeader class
</a></h1>
<h2><a name="class$GSMimeHeader">GSMimeHeader</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSCopying</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="50%" align="left" />
<a href="#_GSMimeHeader_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader+makeQuoted$always$">+makeQuoted:always:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader+makeToken$">+makeToken:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader+makeToken$preservingCase$">+makeToken:preservingCase:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-copyWithZone$">-copyWithZone:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-fullValue">-fullValue</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-initWithName$value$">-initWithName:value:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-initWithName$value$parameters$">-initWithName:value:parameters:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-name">-name</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-namePreservingCase$">-namePreservingCase:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-objectForKey$">-objectForKey:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-objects">-objects</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-parameterForKey$">-parameterForKey:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-parameters">-parameters</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-parametersPreservingCase$">-parametersPreservingCase:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-rawMimeData">-rawMimeData</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-rawMimeDataPreservingCase$">-rawMimeDataPreservingCase:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-rawMimeDataPreservingCase$foldedAt$">-rawMimeDataPreservingCase:foldedAt:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-setName$">-setName:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-setObject$forKey$">-setObject:forKey:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-setParameter$forKey$">-setParameter:forKey:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-setParameters$">-setParameters:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-setValue$">-setValue:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-text">-text</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeHeader-value">-value</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSMimeHeader+makeQuoted$always$">makeQuoted: always: </a></h3>
+ (NSString*) <b>makeQuoted:</b> (NSString*)v<b> always:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Makes the value into a quoted string if necessary (ie
if it contains any special / non-token characters). If
<var>flag</var> is <code>YES</code> then the value is
made into a quoted string even if it does not contain
special characters.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader+makeToken$">makeToken: </a></h3>
+ (NSString*) <b>makeToken:</b> (NSString*)t;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convert the supplied string to a standardized token
by making it lowercase and removing all illegal
characters.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader+makeToken$preservingCase$">makeToken: preservingCase: </a></h3>
+ (NSString*) <b>makeToken:</b> (NSString*)t<b> preservingCase:</b> (BOOL)preserve;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convert the supplied string to a standardized token
by removing all illegal characters. If
<var>preserve</var> is <code>NO</code> then the
result is converted to lowercase. <br /> Returns an
autoreleased (and possibly modified) copy of
the original.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-copyWithZone$">copyWithZone: </a></h3>
- (id) <b>copyWithZone:</b> (NSZone*)z;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-fullValue">fullValue </a></h3>
- (NSString*) <b>fullValue</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the full value of the header including any
parameters and preserving case. This is an
unfolded (<strong>long</strong>) line with no
escape sequences (ie contains a unicode string not
necessarily plain ASCII). <br /> If you just
want the plain value excluding any parameters, use the
<a rel="gsdoc" href="#method$GSMimeHeader-value">
-value
</a>
method instead.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-initWithName$value$">initWithName: value: </a></h3>
- (id) <b>initWithName:</b> (NSString*)n<b> value:</b> (NSString*)v;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method calling
<a rel="gsdoc" href="#method$GSMimeHeader-initWithName$value$parameters$">
-initWithName:value:parameters:
</a>
with the supplied argument and <code>nil</code>
parameters.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-initWithName$value$parameters$">initWithName: value: parameters: </a></h3>
- (id) <b>initWithName:</b> (NSString*)n<b> value:</b> (NSString*)v<b> parameters:</b> (NSDictionary*)p;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialise a GSMimeHeader supplying a name, a
value and a dictionary of any parameters occurring
after the value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-name">name </a></h3>
- (NSString*) <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the name of this header... a lowercase
string.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-namePreservingCase$">namePreservingCase: </a></h3>
- (NSString*) <b>namePreservingCase:</b> (BOOL)preserve;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the name of this header as originally set
(without conversion to lowercase) if
<var>preserve</var> is <code>YES</code>, but as a
lowercase string if <var>preserve</var> is
<code>NO</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-objectForKey$">objectForKey: </a></h3>
- (id) <b>objectForKey:</b> (NSString*)k;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return extra information specific to a particular
header type.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-objects">objects </a></h3>
- (NSDictionary*) <b>objects</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a dictionary of all the additional objects
for the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-parameterForKey$">parameterForKey: </a></h3>
- (NSString*) <b>parameterForKey:</b> (NSString*)k;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the named parameter value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-parameters">parameters </a></h3>
- (NSDictionary*) <b>parameters</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the parameters of this header... a
dictionary whose keys are all lowercase strings,
and whose values are strings which may contain mixed
case.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-parametersPreservingCase$">parametersPreservingCase: </a></h3>
- (NSDictionary*) <b>parametersPreservingCase:</b> (BOOL)preserve;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the parameters of this header... a
dictionary whose keys are strings preserving the
case originally used to set the values or all
lowercase depending on the <var>preserve</var>
argument.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-rawMimeData">rawMimeData </a></h3>
- (NSMutableData*) <b>rawMimeData</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the full text of the header, built from its
component parts, and including a terminating
CR-LF
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-rawMimeDataPreservingCase$">rawMimeDataPreservingCase: </a></h3>
- (NSMutableData*) <b>rawMimeDataPreservingCase:</b> (BOOL)preserve;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-rawMimeDataPreservingCase$foldedAt$">rawMimeDataPreservingCase: foldedAt: </a></h3>
- (NSMutableData*) <b>rawMimeDataPreservingCase:</b> (BOOL)preserve<b> foldedAt:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)fold;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the full text of the header, built from its
component parts, and including a terminating
CR-LF. <br /> If <var>preserve</var> is
<code>YES</code> then we attempt to build the text
using the same case as it was originally parsed/set
from, otherwise we use common conventions of
capitalising the header names and using
lowercase parameter names. <br /> If
<var>fold</var> is greater than zero, lines with more
than the specified number of characters are considered
'long' and are folded into multiple lines.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-setName$">setName: </a></h3>
- (void) <b>setName:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the name of this header... and removes illegal
characters. <br /> If given a <code>nil</code>
or empty string argument, sets the name to 'unknown'.
<br /> NB. The value returned by the
<a rel="gsdoc" href="#method$GSMimeHeader-name">
-name
</a>
method will be a lowercase version of thae name.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-setObject$forKey$">setObject: forKey: </a></h3>
- (void) <b>setObject:</b> (id)o<b> forKey:</b> (NSString*)k;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Method to store specific information for particular
types of header. This is used for non-standard parts
of headers. <br /> Setting a <code>nil</code> value for
<var>o</var> will remove any existing value set using
the <var>k</var> as its key.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-setParameter$forKey$">setParameter: forKey: </a></h3>
- (void) <b>setParameter:</b> (NSString*)v<b> forKey:</b> (NSString*)k;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets a parameter of this header... converts name to
lowercase and removes illegal characters. <br />
If a <code>nil</code> parameter name is supplied,
removes any parameter with the specified key.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-setParameters$">setParameters: </a></h3>
- (void) <b>setParameters:</b> (NSDictionary*)d;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets all parameters of this header... converts names
to lowercase and removes illegal characters from them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-setValue$">setValue: </a></h3>
- (void) <b>setValue:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Sets the value of this header (without changing
parameters) <br /> If given a <code>nil</code>
argument, set an empty string value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-text">text </a></h3>
- (NSString*) <b>text</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the full text of the header, built from its
component parts, and including a terminating
CR-LF
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeHeader-value">value </a></h3>
- (NSString*) <b>value</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the value of this header (excluding any
parameters). <br /> Use the
<a rel="gsdoc" href="#method$GSMimeHeader-fullValue">
-fullValue
</a>
m,ethod if you want parameter included.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSMimeHeader_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSMimeHeader Class</h2>
<h3><a name="ivariable$GSMimeHeader*name">name</a></h3>
@protected NSString* <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeHeader*objects">objects</a></h3>
@protected NSMutableDictionary* <b>objects</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeHeader*params">params</a></h3>
@protected NSMutableDictionary* <b>params</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeHeader*value">value</a></h3>
@protected NSString* <b>value</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="005000000000">
Software documentation for the GSMimeParser class
</a></h1>
<h2><a name="class$GSMimeParser">GSMimeParser</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This class provides support for parsing MIME messages
into GSMimeDocument objects. Each parser object
maintains an associated document into which data
is stored.
</p>
<p>
</p>
<p>
You supply the document to be parsed as one or more
data items passed to the
<a rel="gsdoc" href="#method$GSMimeParser-parse$">
-parse:
</a>
method, and (if the method always returns
<code>YES</code>, you give it a final
<code>nil</code> argument to mark the end of the
document.
</p>
<p>
</p>
<p>
On completion of parsing a valid document, the
<a rel="gsdoc" href="#method$GSMimeParser-mimeDocument">[GSMimeParser -mimeDocument]</a>
method returns the resulting parsed document.
</p>
<p>
</p>
<p>
If you need to parse faulty documents (eg where a faulty
mail client has produced an email which does not
conform to the MIME standards), you should look at
the
<a rel="gsdoc" href="#method$GSMimeParser-setBuggyQuotes$">
-setBuggyQuotes:
</a>
and
<a rel="gsdoc" href="#method$GSMimeParser-setDefaultCharset$">
-setDefaultCharset:
</a>
methods, which are designed to cope with the most
common faults.
</p>
<p>
</div>
<hr width="50%" align="left" />
<a href="#_GSMimeParser_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser+documentFromData$">+documentFromData:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser+mimeParser">+mimeParser</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-contextFor$">-contextFor:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-data">-data</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-decodeData$fromRange$intoData$withContext$">-decodeData:fromRange:intoData:withContext:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-excess">-excess</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-expectNoHeaders">-expectNoHeaders</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-isComplete">-isComplete</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-isHttp">-isHttp</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-isInBody">-isInBody</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-isInHeaders">-isInHeaders</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-mimeDocument">-mimeDocument</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-parse$">-parse:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-parseHeader$">-parseHeader:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-parseHeaders$remaining$">-parseHeaders:remaining:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-scanHeaderBody$into$">-scanHeaderBody:into:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-scanName$">-scanName:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-scanPastSpace$">-scanPastSpace:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-scanSpecial$">-scanSpecial:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-scanToken$">-scanToken:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-setBuggyQuotes$">-setBuggyQuotes:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-setDefaultCharset$">-setDefaultCharset:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-setHeadersOnly">-setHeadersOnly</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeParser-setIsHttp">-setIsHttp</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSMimeParser+documentFromData$">documentFromData: </a></h3>
+ (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*) <b>documentFromData:</b> (NSData*)mimeData;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Convenience method to parse a single data item
as a MIME message and return the resulting document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser+mimeParser">mimeParser </a></h3>
+ (<a rel="gsdoc" href="#class$GSMimeParser">GSMimeParser</a>*) <b>mimeParser</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Create and return a parser.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-contextFor$">contextFor: </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeCodingContext">GSMimeCodingContext</a>*) <b>contextFor:</b> (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*)info;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return a coding context object to be used for
decoding data according to the scheme specified in
the header.
</p>
<p>
The default implementation supports the following
transfer encodings specified in either a
<code>transfer-encoding</code> of
<code>content-transfer-encoding</code> header -
</p>
<p>
<ul>
<li>
base64
</li>
<li>
quoted-printable
</li>
<li>
binary (no coding actually performed)
</li>
<li>
7bit (no coding actually performed)
</li>
<li>
8bit (no coding actually performed)
</li>
<li>
chunked (for HTTP/1.1)
</li>
<li>
x-uuencode
</li>
</ul>
To add new coding schemes to the parser, you need to
override this method to return a new coding
context for your scheme when the <var>info</var>
argument indicates that this is appropriate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-data">data </a></h3>
- (NSMutableData*) <b>data</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Return the data accumulated in the parser. If the
parser is still parsing headers, this will be the
header data read so far. If the parse has parsed the
body of the message, this will be the data of the
body, with any transfer encoding removed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-decodeData$fromRange$intoData$withContext$">decodeData: fromRange: intoData: withContext: </a></h3>
- (BOOL) <b>decodeData:</b> (NSData*)sData<b> fromRange:</b> (NSRange)aRange<b> intoData:</b> (NSMutableData*)dData<b> withContext:</b> (<a rel="gsdoc" href="#class$GSMimeCodingContext">GSMimeCodingContext</a>*)con;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
Decodes the raw data from the specified range in
the source data object and appends it to the
destination data object. The context object
provides information about the content encoding
type in use, and the state of the decoding
operation.
</p>
<p>
</p>
<p>
This method may be called repeatedly to
incrementally decode information as it
arrives on some communications channel. It should
be called with a <code>nil</code> source data item (or
with the atEnd flag of the context set to
<code>YES</code>) in order to flush any
information held in the context to the output
data object.
</p>
<p>
</p>
<p>
You may override this method in order to implement
additional coding schemes, but usually it
should be enough for you to implement a custom
GSMimeCodingContext subclass fotr
this method to use.
</p>
<p>
Correct the size of the output buffer (shrink back
from the original allocation to the actual unchunked
size).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-excess">excess </a></h3>
- (NSData*) <b>excess</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
If there was more data passed to the parser than
actually needed to form the document, this method
returns that excess data, othrwise it returns
<code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-expectNoHeaders">expectNoHeaders </a></h3>
- (void) <b>expectNoHeaders</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This method may be called to tell the parser that it
should not expect to parse any headers, and that the
data it will receive is body data. <br /> If the parse
is already in the body, or is complete, this method has
no effect. <br /> This is for use when some other
utility has been used to parse headers, and you
have set the headers of the document owned by the
parser accordingly. You can then use the
GSMimeParser to read the body data into the
document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-isComplete">isComplete </a></h3>
- (BOOL) <b>isComplete</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns <code>YES</code> if the document parsing is
known to be completed successfully. Returns
<code>NO</code> if either more data is needed, or if
the parser encountered an error.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-isHttp">isHttp </a></h3>
- (BOOL) <b>isHttp</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns <code>YES</code> if the parser is parsing
an HTTP document rather than a true MIME document.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-isInBody">isInBody </a></h3>
- (BOOL) <b>isInBody</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns <code>YES</code> if all the document
headers have been parsed but the document body
parsing may not yet be complete.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-isInHeaders">isInHeaders </a></h3>
- (BOOL) <b>isInHeaders</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns <code>YES</code> if parsing of the document
headers has not yet been completed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-mimeDocument">mimeDocument </a></h3>
- (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*) <b>mimeDocument</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the GSMimeDocument instance into which data
is being parsed or has been parsed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-parse$">parse: </a></h3>
- (BOOL) <b>parse:</b> (NSData*)d;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method is called repeatedly to pass raw mime
data into the parser. It returns <code>YES</code> as
<strong>long</strong> as it wants more data to
complete parsing of a document, and
<code>NO</code> if parsing is complete, either due
to having reached the end of a document or due to an
error.
</p>
<p>
</p>
<p>
Since it is not always possible to determine if the
end of a MIME document has been reached from its
content, the method may need to be called with a
<code>nil</code> or empty argument after you have
passed all the data to it... this tells it that
the data is complete.
</p>
<p>
</p>
<p>
The parser attempts to be as flexible as possible and
to continue parsing wherever it can. If an error
occurs in parsing, the
<a rel="gsdoc" href="#method$GSMimeParser-isComplete">
-isComplete
</a>
method will always return <code>NO</code>, even
after the
<a rel="gsdoc" href="#method$GSMimeParser-parse$">
-parse:
</a>
method has been called with a <code>nil</code>
argument.
</p>
<p>
</p>
<p>
A multipart document will be parsed to content
consisting of an NSArray of GSMimeDocument
instances representing each part. <br />
Otherwise, a document will become content of
type NSData, unless it is of content type
<em>text</em>, in which case it will be an NSString.
<br /> If a document has no content type
specified, it will be treated as <em>text</em>
, unless it is identifiable as a <em>file</em> (eg. t
has a content-disposition header containing a
filename parameter).
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-parseHeader$">parseHeader: </a></h3>
- (BOOL) <b>parseHeader:</b> (NSString*)aHeader;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method is called to parse a header line
<em>for the current document</em>, split its
contents into a GSMimeHeader object, and add
that information to the document. <br /> The method
is normally used internally by the
<a rel="gsdoc" href="#method$GSMimeParser-parse$">
-parse:
</a>
method, but you may also call it to parse an
entire header line and add it to the document
(this may be useful in conjunction with the
<a rel="gsdoc" href="#method$GSMimeParser-expectNoHeaders">
-expectNoHeaders
</a>
method, to parse a document body data into a
document where the headers are available from a
separate source).
</p>
<p>
<pre>
GSMimeParser *parser = [GSMimeParser mimeParser];
[parser parseHeader: @"content-type: text/plain"];
[parser expectNoHeaders];
[parser parse: bodyData];
[parser parse: nil];
</pre>
</p>
<p>
The standard implementation of this method scans the
header name and then calls
<a rel="gsdoc" href="#method$GSMimeParser-scanHeaderBody$into$">
-scanHeaderBody:into:
</a>
to complete the parsing of the header.
</p>
<p>
</p>
<p>
This method also performs consistency checks on
headers scanned so it is recommended that it is
not overridden, but that subclasses override
<a rel="gsdoc" href="#method$GSMimeParser-scanHeaderBody$into$">
-scanHeaderBody:into:
</a>
to implement custom scanning.
</p>
<p>
</p>
<p>
As a special case, for HTTP support, this method also
parses lines in the format of HTTP responses as if
they were headers named <code>http</code>. The
resulting header object contains additional
object values -
</p>
<p>
<dl>
<dt>HttpMajorVersion</dt>
<dd>
The first part of the version number
</dd>
<dt>HttpMinorVersion</dt>
<dd>
The second part of the version number
</dd>
<dt>NSHTTPPropertyServerHTTPVersionKey</dt>
<dd>
The full HTTP protocol version number
</dd>
<dt>NSHTTPPropertyStatusCodeKey</dt>
<dd>
The HTTP status code (numeric)
</dd>
<dt>NSHTTPPropertyStatusReasonKey</dt>
<dd>
The text message (if any) after the status code
</dd>
</dl>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-parseHeaders$remaining$">parseHeaders: remaining: </a></h3>
- (BOOL) <b>parseHeaders:</b> (NSData*)d<b> remaining:</b> (NSData**)body;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Parses headers from the supplied data returning
<code>YES</code> if more data is needed before the
end of thge headers are reached. <br /> If
<var>body</var> is not NULL and the end of the
headers were reached leaving some unused data, that
remaining data is returned. <br /> NB. The
returned data is a reference to part of the
original memory buffer provided in <var>d</var>,
so you must copy it if you intend to use it after
modifying or deallocating the original data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-scanHeaderBody$into$">scanHeaderBody: into: </a></h3>
- (BOOL) <b>scanHeaderBody:</b> (NSScanner*)scanner<b> into:</b> (<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>*)info;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
</p>
<p>
This method is called to parse a header line and
split its contents into the supplied
<a rel="gsdoc" href="#class$GSMimeHeader">GSMimeHeader</a>
instance.
</p>
<p>
</p>
<p>
On entry, the header (<var>info</var>) is already
partially filled, the name is a lowercase
representation of the header name. The
the <var>scanner</var> must be set to a scan
location immediately after the colon in the
original header string (ie to the header value
string).
</p>
<p>
</p>
<p>
If the header is parsed successfully, the method
should return <code>YES</code>, otherwise
<code>NO</code>.
</p>
<p>
</p>
<p>
You would not normally call this method directly
yourself, but may override it to support
parsing of new headers. <br /> If you do call
this yourself, you need to be aware that it may
change the state of the document in the parser.
</p>
<p>
</p>
<p>
You should be aware of the parsing that the
standard implementation performs, and that
<em>needs</em> to be done for certain headers in
order to permit the parser to work generally -
</p>
<p>
<dl>
<dt>content-disposition</dt>
<dd>
<dl>
<dt>Value</dt>
<dd>
The content disposition (excluding
parameters) as a lowercase string.
</dd>
</dl>
</dd>
<dt>content-type</dt>
<dd>
<dl>
<dt>Subtype</dt>
<dd>
The MIME subtype lowercase
</dd>
<dt>Type</dt>
<dd>
The MIME type lowercase
</dd>
<dt>value</dt>
<dd>
The full MIME type (xxx/yyy) in lowercase
</dd>
</dl>
</dd>
<dt>content-transfer-encoding</dt>
<dd>
<dl>
<dt>Value</dt>
<dd>
The transfer encoding type in lowercase
</dd>
</dl>
</dd>
<dt>http</dt>
<dd>
<dl>
<dt>HttpVersion</dt>
<dd>
The HTTP protocol version number
</dd>
<dt>HttpMajorVersion</dt>
<dd>
The first component of the version number
</dd>
<dt>HttpMinorVersion</dt>
<dd>
The second component of the version number
</dd>
<dt>HttpStatus</dt>
<dd>
The response status value (numeric code)
</dd>
<dt>Value</dt>
<dd>
The text message (if any)
</dd>
</dl>
</dd>
<dt>transfer-encoding</dt>
<dd>
<dl>
<dt>Value</dt>
<dd>
The transfer encoding type in lowercase
</dd>
</dl>
</dd>
</dl>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-scanName$">scanName: </a></h3>
- (NSString*) <b>scanName:</b> (NSScanner*)scanner;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A convenience method to use a <var>scanner</var> (that is
set up to scan a header line) to scan a name - a simple
word.
<ul>
<li>
Leading whitespace is ignored.
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-scanPastSpace$">scanPastSpace: </a></h3>
- (BOOL) <b>scanPastSpace:</b> (NSScanner*)scanner;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A convenience method to scan past any whitespace in the
<var>scanner</var> in preparation for scanning
something more interesting that comes after it.
Returns <code>YES</code> if any space was read,
<code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-scanSpecial$">scanSpecial: </a></h3>
- (NSString*) <b>scanSpecial:</b> (NSScanner*)scanner;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A convenience method to use a <var>scanner</var> (that is
set up to scan a header line) to scan in a special
character that terminated a token previously
scanned. If the token was terminated by whitespace
and no other special character, the string returned
will contain a single space character.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-scanToken$">scanToken: </a></h3>
- (NSString*) <b>scanToken:</b> (NSScanner*)scanner;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
A convenience method to use a <var>scanner</var> (that is
set up to scan a header line) to scan a header token -
either a quoted string or a simple word.
<ul>
<li>
Leading whitespace is ignored.
</li>
<li>
Backslash escapes in quoted text are
converted
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-setBuggyQuotes$">setBuggyQuotes: </a></h3>
- (void) <b>setBuggyQuotes:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Method to inform the parser that the data it is
parsing is likely to contain fields with buggy use
of backslash quotes... and it should try to be tolerant
of them and treat them as is they were escaped
backslashes. This is for use with things like
microsoft internet explorer, which puts the
backslashes used as file path separators in
parameters without quoting them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-setDefaultCharset$">setDefaultCharset: </a></h3>
- (void) <b>setDefaultCharset:</b> (NSString*)aName;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
This is a method to inform the parser that body parts
with no content-type header (which are treated as
text/plain) should use the specified
characterset rather than the default
(us-ascii). <br /> This also controls the
parsing of headers... in a legal MIME document
these must consist solely of us-ascii characters, but
setting a different default characterset (such as
latin1) will permit many illegal header lines
(produced by faulty mail clients) to be parsed.
<br /> HTTP requests use headers in the latin1
characterset, so this is the header line
characterset used most commonly by faulty
clients.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-setHeadersOnly">setHeadersOnly </a></h3>
- (void) <b>setHeadersOnly</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Method to inform the parser that only the headers
should be parsed and any remaining data be treated
as excess
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeParser-setIsHttp">setIsHttp </a></h3>
- (void) <b>setIsHttp</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Method to inform the parser that the data it is
parsing is an HTTP document rather than true MIME.
This method is called internally if the parser detects
an HTTP response line at the start of the headers it is
parsing.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSMimeParser_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSMimeParser Class</h2>
<h3><a name="ivariable$GSMimeParser*_defaultEncoding">_defaultEncoding</a></h3>
@protected NSStringEncoding <b>_defaultEncoding</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*_unused">_unused</a></h3>
@protected void* <b>_unused</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*boundary">boundary</a></h3>
@protected NSData* <b>boundary</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*bytes">bytes</a></h3>
@protected unsigned char* <b>bytes</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*child">child</a></h3>
@protected GSMimeParser* <b>child</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*context">context</a></h3>
@protected GSMimeCodingContext* <b>context</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*data">data</a></h3>
@protected NSMutableData* <b>data</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*dataEnd">dataEnd</a></h3>
@protected unsigned int <b>dataEnd</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*document">document</a></h3>
@protected GSMimeDocument* <b>document</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*expect">expect</a></h3>
@protected unsigned int <b>expect</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*input">input</a></h3>
@protected unsigned int <b>input</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*lineEnd">lineEnd</a></h3>
@protected unsigned int <b>lineEnd</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*lineStart">lineStart</a></h3>
@protected unsigned int <b>lineStart</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*rawBodyLength">rawBodyLength</a></h3>
@protected unsigned int <b>rawBodyLength</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSMimeParser*sectionStart">sectionStart</a></h3>
@protected unsigned int <b>sectionStart</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="006000000000">
Software documentation for the GSMimeSMTPClient class
</a></h1>
<h2><a name="class$GSMimeSMTPClient">GSMimeSMTPClient</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
The GSMimeSMTPClient class provides the ability to send
EMails
<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>
instances) via an SMTP server.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-abort">-abort</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-delegate">-delegate</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-flush$">-flush:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-lastError">-lastError</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-send$">-send:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-send$envelopeID$">-send:envelopeID:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setDelegate$">-setDelegate:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setHostname$">-setHostname:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setIdentity$">-setIdentity:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setOriginator$">-setOriginator:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setPort$">-setPort:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-setUsername$">-setUsername:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-state">-state</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$GSMimeSMTPClient-stateDesc">-stateDesc</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSMimeSMTPClient-abort">abort </a></h3>
- (void) <b>abort</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Shut down any message send in progress and abort any
queued messages.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-delegate">delegate </a></h3>
- (id) <b>delegate</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the current delegate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-flush$">flush: </a></h3>
- (BOOL) <b>flush:</b> (NSDate*)limit;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Tries to flush any queued messages to the SMTP
server, completing by the specified
<var>limit</var> date. <br /> If <var>limit</var> is
<code>nil</code> then a date in the distant future
is used. <br /> If the queue is emptied in time, this
method returns <code>YES</code>, otherwise it
returns <code>NO</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-lastError">lastError </a></h3>
- (NSError*) <b>lastError</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns the last error encountered, or
<code>nil</code> if there is none recorded.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-send$">send: </a></h3>
- (void) <b>send:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)message;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Add the <var>message</var> to the queue of emails to be
sent by the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-send$envelopeID$">send: envelopeID: </a></h3>
- (void) <b>send:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)message<b> envelopeID:</b> (NSString*)envid;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Add the <var>message</var> to the queue of emails to be
sent by the receiver. <br /> Also adds an envelope ID
string to be used to uniquely identify the
<var>message</var> for delivery receipting purposes.
<br /> For this to work, the SMTP gateway being used
must support the SMTP service extension for delivery
status notification (RFC 3460).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setDelegate$">setDelegate: </a></h3>
- (void) <b>setDelegate:</b> (id)d;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the delegate to receive callback methods indicating
when a message is sent, failed, or removed from the
queue unsent.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setHostname$">setHostname: </a></h3>
- (void) <b>setHostname:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the host for the SMTP server. If this is not set
(or is set to <code>nil</code>) then the
GSMimeSMTPClientHost user default is
used. If the host is <code>nil</code> or an empty
string then 'localhost' is used.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setIdentity$">setIdentity: </a></h3>
- (void) <b>setIdentity:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the host for the SMTP client to identify itsself to
the server. If this is not set (or is set to
<code>nil</code>) then the GSMimeSMTPClientIdentity
user default is used. If the identity is
<code>nil</code> or an empty string then a name of
the current host is use.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setOriginator$">setOriginator: </a></h3>
- (void) <b>setOriginator:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the originator for any emails sent by the SMTP
client. <br /> This overrides the value in the
'from' header of an email. <br /> If this is not set
(or is set to <code>nil</code>) then the
GSMimeSMTPClientOriginator user
default is used. If the originator is
<code>nil</code> or an empty string then the value
in the 'from' header of the email is used.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setPort$">setPort: </a></h3>
- (void) <b>setPort:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the port for the SMTP server. If this is not set
(or is set to <code>nil</code>) then the
GSMimeSMTPClientPort user default is
used. If the port is not an integer in the 1-65535
range, then '25' (the default SMTP port) is used.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-setUsername$">setUsername: </a></h3>
- (void) <b>setUsername:</b> (NSString*)s;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Set the username for authentication to the SMTP server.
If this is not set (or is set to <code>nil</code>) then
the GSMimeSMTPClientUsername user default is used. If
the username is <code>nil</code> or an empty string
then authentication is not attempted.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-state">state </a></h3>
- (int) <b>state</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
returns the receivers current state.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSMimeSMTPClient-stateDesc">stateDesc </a></h3>
- (NSString*) <b>stateDesc</b>;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Returns a string describing the receiver's current
state
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="007000000000">
Software documentation for the
NSObject(GSMimeSMTPClient) category
</a></h1>
<h2>NSObject(<a name="category$NSObject(GSMimeSMTPClient)">GSMimeSMTPClient</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GNUstepBase/GSMime.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Informal protocol for delegates of the
GSMimeSMTPClient class. The default
implementations of these methods do nothing.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSMime.html#method$NSObject(GSMimeSMTPClient)-smtpClient$mimeFailed$">-smtpClient:mimeFailed:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$NSObject(GSMimeSMTPClient)-smtpClient$mimeSent$">-smtpClient:mimeSent:</a></li>
<li><a rel="gsdoc" href="GSMime.html#method$NSObject(GSMimeSMTPClient)-smtpClient$mimeUnsent$">-smtpClient:mimeUnsent:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSObject(GSMimeSMTPClient)-smtpClient$mimeFailed$">smtpClient: mimeFailed: </a></h3>
- (void) <b>smtpClient:</b> (<a rel="gsdoc" href="#class$GSMimeSMTPClient">GSMimeSMTPClient</a>*)client<b> mimeFailed:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)doc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(GSMimeSMTPClient)-smtpClient$mimeSent$">smtpClient: mimeSent: </a></h3>
- (void) <b>smtpClient:</b> (<a rel="gsdoc" href="#class$GSMimeSMTPClient">GSMimeSMTPClient</a>*)client<b> mimeSent:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)doc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(GSMimeSMTPClient)-smtpClient$mimeUnsent$">smtpClient: mimeUnsent: </a></h3>
- (void) <b>smtpClient:</b> (<a rel="gsdoc" href="#class$GSMimeSMTPClient">GSMimeSMTPClient</a>*)client<b> mimeUnsent:</b> (<a rel="gsdoc" href="#class$GSMimeDocument">GSMimeDocument</a>*)doc;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="BaseAdditions.html">Up</a>
</font>
</body>
</html>
|