1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
|
"======================================================================
|
| IMAP protocol support
|
|
======================================================================"
"======================================================================
|
| Copyright (c) 2000 Leslie A. Tyrrell
|
| This file is part of the GNU Smalltalk class library.
|
| The GNU Smalltalk class library is free software; you can redistribute it
| and/or modify it under the terms of the GNU Lesser General Public License
| as published by the Free Software Foundation; either version 2.1, or (at
| your option) any later version.
|
| The GNU Smalltalk class library is distributed in the hope that it will be
| useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
| General Public License for more details.
|
| You should have received a copy of the GNU Lesser General Public License
| along with the GNU Smalltalk class library; see the file COPYING.LIB.
| If not, write to the Free Software Foundation, 59 Temple Place - Suite
| 330, Boston, MA 02111-1307, USA.
|
======================================================================"
Namespace current: NetClients.IMAP!
Object subclass: #IMAPCommand
instanceVariableNames: 'client sequenceID name arguments status responses completionResponse promise '
classVariableNames: 'ResponseRegistry '
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPCommand comment:
nil!
Object subclass: #IMAPFetchedItem
instanceVariableNames: 'name '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPFetchedItem comment:
nil!
NetProtocolInterpreter subclass: #IMAPProtocolInterpreter
instanceVariableNames: 'client responseStream commandSequencer mutex readResponseSemaphore continuationPromise commandsInProgress queuedCommands '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPProtocolInterpreter comment:
nil!
NetClient subclass: #IMAPClient
instanceVariableNames: 'state '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPClient comment:
nil!
Object subclass: #IMAPCommandSequencer
instanceVariableNames: 'prefix value '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPCommandSequencer comment:
nil!
Object subclass: #IMAPFetchedItemSectionSpecification
instanceVariableNames: 'specName parameters span rawContent '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPFetchedItemSectionSpecification comment:
nil!
Object subclass: #IMAPResponse
instanceVariableNames: 'source cmdName value '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPResponse comment:
nil!
IMAPResponse subclass: #IMAPContinuationResponse
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPResponse comment:
nil!
Object subclass: #IMAPState
instanceVariableNames: 'client '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPState comment:
nil!
TestCase subclass: #IMAPProtocolInterpreterTest
instanceVariableNames: 'pi '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPProtocolInterpreterTest comment:
nil!
IMAPResponse subclass: #IMAPDataResponse
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPDataResponse comment:
nil!
IMAPState subclass: #IMAPAuthenticatedState
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPAuthenticatedState comment:
nil!
IMAPResponse subclass: #IMAPStatusResponse
instanceVariableNames: 'text status '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPStatusResponse comment:
nil!
TestCase subclass: #IMAPResponseTest
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPResponseTest comment:
nil!
IMAPResponse subclass: #IMAPCommandCompletionResponse
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPCommandCompletionResponse comment:
nil!
TestCase subclass: #IMAPTest
instanceVariableNames: 'client '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPTest comment:
nil!
IMAPFetchedItem subclass: #IMAPBodySectionFetchedItem
instanceVariableNames: 'sectionSpec '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPBodySectionFetchedItem comment:
nil!
IMAPState subclass: #IMAPNonAuthenticatedState
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPNonAuthenticatedState comment:
nil!
IMAPFetchedItem subclass: #IMAPMessageEnvelopeFetchedItem
instanceVariableNames: 'envelope '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPMessageEnvelopeFetchedItem comment:
nil!
IMAPFetchedItem subclass: #IMAPBodyRFC822FetchedItem
instanceVariableNames: 'value '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPBodyRFC822FetchedItem comment:
nil!
IMAPFetchedItem subclass: #IMAPMessageMetadataFetchedItem
instanceVariableNames: 'value '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPMessageMetadataFetchedItem comment:
nil!
IMAPFetchedItemSectionSpecification subclass: #IMAPFetchedItemHeaderSectionSpecification
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPFetchedItemHeaderSectionSpecification comment:
nil!
IMAPFetchedItem subclass: #IMAPBodyStructureFetchedItem
instanceVariableNames: 'structure '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPBodyStructureFetchedItem comment:
nil!
TestCase subclass: #IMAPScannerTest
instanceVariableNames: 'parser '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPScannerTest comment:
nil!
IMAPFetchedItem subclass: #IMAPBodyFetchedItem
instanceVariableNames: 'parts '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPBodyFetchedItem comment:
nil!
IMAPDataResponse subclass: #IMAPDataResponseFetch
instanceVariableNames: 'fetchedItems metaResponses '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPDataResponseFetch comment:
nil!
IMAPStatusResponse subclass: #IMAPResponseMailboxStatus
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPResponseMailboxStatus comment:
nil!
IMAPStatusResponse subclass: #IMAPResponseTagged
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPResponseTagged comment:
nil!
IMAPDataResponse subclass: #IMAPDataResponseSearch
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPDataResponseSearch comment:
nil!
IMAPAuthenticatedState subclass: #IMAPSelectedState
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPSelectedState comment:
nil!
IMAPDataResponse subclass: #IMAPDataResponseList
instanceVariableNames: 'mbAttributes mbDelimiter mbName '
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPDataResponseList comment:
nil!
MIME.MailScanner subclass: #IMAPScanner
instanceVariableNames: 'flagBracketSpecial '
classVariableNames: 'TextMask QuotedTextMask QuotedPairChar AtomMask '
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPScanner comment:
nil!
IMAPDataResponseList subclass: #IMAPDataResponseLSub
instanceVariableNames: ''
classVariableNames: ''
poolDictionaries: ''
category: 'NetClients-IMAP'!
IMAPDataResponseLSub comment:
nil!
!IMAPCommand class methodsFor: 'class initialization'!
initialize
"IMAPCommand initialize"
(ResponseRegistry := Dictionary new)
at: 'FETCH' put: #('FETCH' 'OK' 'NO' 'BAD');
at: 'SEARCH' put: #('SEARCH' 'OK' 'NO' 'BAD');
at: 'SELECT' put: #('FLAGS' 'EXISTS' 'RECENT' 'OK' 'NO' 'BAD');
at: 'EXAMINE' put: #('FLAGS' 'EXISTS' 'RECENT' 'OK' 'NO' 'BAD');
at: 'LIST' put: #('LIST' 'OK' 'NO' 'BAD');
at: 'LSUB' put: #('LSUB' 'OK' 'NO' 'BAD');
at: 'STATUS' put: #('STATUS');
at: 'EXPUNGE' put: #('EXPUNGE' 'OK' 'NO' 'BAD');
at: 'STORE' put: #('FETCH' 'OK' 'NO' 'BAD');
at: 'UID' put: #('FETCH' 'SEARCH' 'OK' 'NO' 'BAD');
at: 'CAPABILITY' put: #('CAPABILITY' 'OK' 'BAD');
at: 'STORE' put: #('FETCH');
at: 'LOGOUT' put: #('BYE' 'OK' 'BAD');
at: 'CLOSE' put: #('OK' 'NO' 'BAD');
at: 'CHECK' put: #('OK' 'NO');
at: 'APPEND' put: #('OK' 'NO' 'BAD');
at: 'SUBSCRIBE' put: #('OK' 'NO' 'BAD');
at: 'RENAME' put: #('OK' 'NO' 'BAD');
at: 'DELETE' put: #('OK' 'NO' 'BAD');
at: 'CREATE' put: #('OK' 'NO' 'BAD');
at: 'LOGIN' put: #('OK' 'NO' 'BAD');
at: 'AUTHENTICATE' put: #('OK' 'NO' 'BAD');
at: 'NOOP' put: #('OK' 'BAD')! !
!IMAPCommand class methodsFor: 'defined responses'!
definedResponsesAt: aName
^self responseRegistry at: aName asUppercase ifAbsentPut: [IdentityDictionary new]!
responseRegistry
^ResponseRegistry! !
!IMAPCommand class methodsFor: 'instance creation'!
forClient: anIMAPPI name: aString arguments: arguments
" The intention here is to let users specify the complete string of command arguments. Because this string may contain atom-specials like $(, etc., this line may be sent as quoted string, which would be wrong. So we fool the printing logic to view this string as an atom. It is a hack, but seems like a convenient one "
| args |
args := arguments isCharacters
ifTrue: [#atom -> arguments]
ifFalse: [arguments].
^self new
forClient: anIMAPPI
name: aString
arguments: args!
login: aNameString password: aPassString
^self name: 'login' arguments: (Array with: (#string->aNameString) with: (#string->aPassString))!
new
^self basicNew initialize!
parse: scanner
"Read and parse next command from a stream. This is mainly useful for testing previously stored
exchange logs"
^self new parse: scanner!
readFrom: aStream
" Read and parse next command from a stream. This is mainly useful for testing previously stored exchange logs "
^self parse: (IMAPScanner on: aStream)! !
!IMAPCommand methodsFor: 'accessing'!
arguments
^arguments!
arguments: anObject
arguments := anObject!
client
^client!
client: anObject
client := anObject!
name
^name!
name: anObject
name := anObject!
sequenceID
^sequenceID!
sequenceID: anObject
sequenceID := anObject! !
!IMAPCommand methodsFor: 'completion response'!
completionResponse
^completionResponse!
completionResponse: anObject
completionResponse := anObject.
self beDone! !
!IMAPCommand methodsFor: 'execute'!
execute
"Prepend the given command and send it to the server."
self sendOn: client connectionStream.
self client connectionStream nl.
self beSent!
wait
^promise value! !
!IMAPCommand methodsFor: 'handle responses'!
definedResponses
^self class definedResponsesAt: self name asUppercase!
handle: aResponse
(aResponse hasTag: self sequenceID)
ifTrue:
[self completionResponse: aResponse.
^true].
(self isDefinedResponse: aResponse)
ifTrue:
[self responses add: aResponse.
^true].
^self notifyClientIfNeeded: aResponse!
isDefinedResponse: aResponse
^self definedResponses includes: aResponse cmdName!
needsClientNotification: aResponse
^false
" ^client isInterestedIn: aResponse"!
notifyClientIfNeeded: aResponse
^(self needsClientNotification: aResponse)
ifTrue: [client handle: aResponse]
ifFalse: [false]!
registerResponse: aResponse
(aResponse isCompletionResponse)
ifTrue: [ self completionResponse: aResponse ]
ifFalse: [ self responses add: aResponse ]!
responses
^responses notNil
ifTrue: [ responses ]
ifFalse: [ responses := OrderedCollection new ]! !
!IMAPCommand methodsFor: 'initialization'!
forClient: anIMAPPI name: aString arguments: args
self client: anIMAPPI.
self name: aString.
self arguments: (self canonicalizeArguments: args)!
initialize
promise := Promise new.
responses := OrderedCollection new: 1! !
!IMAPCommand methodsFor: 'obsolete'!
completedSuccessfully
^self successful! !
!IMAPCommand methodsFor: 'parsing'!
parse: scanner
"Read and parse next command from a stream. This is mainly useful for testing previously stored
exchange logs"
| tokens |
tokens := scanner deepTokenizeAsAssociation.
self
sequenceID: tokens first value;
name: (tokens at: 2) value;
arguments: (tokens copyFrom: 3 to: tokens size)! !
!IMAPCommand methodsFor: 'printing'!
printCompletionResponseOn: aStream indent: level
self completionResponse notNil
ifTrue: [ self completionResponse printOn: aStream indent: level]!
printOn: aStream
self scanner
printTokenList: self asTokenList on: aStream!
printResponseOn: aStream indent: level
(self responces isNil or: [ self responces isEmpty ]) ifTrue: [ ^String new].
self responses do: [ : eachResponse |
aStream nl. eachResponse printOn: aStream indent: level
]!
scanner
^IMAPScanner!
sendOn: aClient
"aClient is a IMAPProtocolInterpreter"
self client sendTokenList: self asTokenList! !
!IMAPCommand methodsFor: 'private'!
asTokenList
| list |
list := OrderedCollection with: (#atom->self sequenceID) with: (#atom->name).
self arguments notNil
ifTrue: [list addAll: self arguments].
^list!
canonicalizeArguments: arguments
" Arguments can one of: integer, string or array of thereof, potentially nested. Scalars are
converted into array with this scalar as a sole element "
arguments isNil ifTrue: [^Array new].
^(arguments isCharacters or: [arguments isSequenceable not])
ifTrue: [^Array with: arguments]
ifFalse: [ arguments ]!
promise
^promise! !
!IMAPCommand methodsFor: 'responses'!
commandResponse
| coll |
^(coll := self commandResponses) isEmpty
ifTrue: [ nil ]
ifFalse: [coll first]!
commandResponses
^self responses select: [:resp | resp cmdName match: self name]!
commandResponseValue
| resp |
^(resp := self commandResponse) isNil
ifTrue: [ nil ]
ifFalse: [resp value]!
statusResponses
^self responses
select: [ : eachResponse | eachResponse isStatusResponse ]! !
!IMAPCommand methodsFor: 'status'!
beDone
self status: #done.
self client commandIsDone: self.
self value: self completionResponse!
beSent
self status: #sent.
self client commandIsInProgress: self!
status
^status!
status: anObject
status := anObject!
value
^promise value!
value: anObject
promise value: status! !
!IMAPCommand methodsFor: 'testing'!
failed
^self successful not!
isDone
^self status = #done!
isSent
^self status = #sent!
successful
^self isDone
and: [ self completionResponse isOK ]! !
!IMAPFetchedItem class methodsFor: 'instance creation'!
canBe: aName
^false!
defaultFetchedItemClass
^IMAPFetchedItem!
named: aName
^(self properSubclassForItemNamed: aName) new
name: aName!
properSubclassForItemNamed: aName
^IMAPFetchedItem allSubclasses
detect: [ : each | each canBe: aName ]
ifNone: [ self defaultFetchedItemClass ]! !
!IMAPFetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
self subclassResponsibility! !
!IMAPFetchedItem methodsFor: 'name'!
name
^name!
name: aName
name := aName! !
!IMAPProtocolInterpreter methodsFor: 'accessing'!
client
^client!
client: imapClient
client := imapClient!
commandPrefix: aString
commandSequencer prefix: aString!
responseStream
^responseStream! !
!IMAPProtocolInterpreter methodsFor: 'connection'!
connect
super connect.
self resetCommandSequence.
responseStream := connectionStream.
commandSequencer reset.
self getResponse! !
!IMAPProtocolInterpreter methodsFor: 'constants and defaults'!
defaultCommandPrefix
^'imapv4_'!
defaultPortNumber
^143!
defaultResponseClass
^IMAPResponse!
lineEndConvention
^LineEndCRLF! !
!IMAPProtocolInterpreter methodsFor: 'events'!
commandIsDone: command
mutex
critical:
[commandsInProgress remove: command ifAbsent: [^self].
readResponseSemaphore wait]!
commandIsInProgress: command
mutex
critical:
[commandsInProgress addFirst: command.
readResponseSemaphore signal]!
commandIsQueued: command!
connectionIsReady
! !
!IMAPProtocolInterpreter methodsFor: 'initialize-release'!
initialize
super initialize.
mutex := Semaphore forMutualExclusion.
readResponseSemaphore := Semaphore new.
queuedCommands := SharedQueue new.
commandsInProgress := OrderedCollection new: 4.
commandSequencer := IMAPCommandSequencer newPrefix: self defaultCommandPrefix.
self commandReaderLoop fork.
self responseReaderLoop fork! !
!IMAPProtocolInterpreter methodsFor: 'private'!
commandReaderLoop
| command |
^[[command := queuedCommands next.
self class log: ['----------------------------------']
level: #IMAPClient.
self class log: ['C: ' , command printString]
level: #IMAPClient.
command execute] repeat]!
commandsInProgress
^commandsInProgress!
nextCommandSequenceNumber
^commandSequencer next!
queuedCommands
^queuedCommands!
resetCommandSequence
commandSequencer reset!
responseReaderLoop
^[[readResponseSemaphore wait; signal. self handleNextResponse ] whileTrue]!
responseStream: stream
" This is ONLY for debugging purposes "
responseStream := stream! !
!IMAPProtocolInterpreter methodsFor: 'public'!
executeCommand: aCommand
aCommand sequenceID isNil
ifTrue: [aCommand sequenceID: self nextCommandSequenceNumber].
queuedCommands nextPut: aCommand.
self commandIsQueued: aCommand! !
!IMAPProtocolInterpreter methodsFor: 'responses'!
getResponse
| resp |
resp := self defaultResponseClass readFrom: self responseStream.
self class log: [' S: ' , resp printLog ]
level: #IMAPServer.
^resp!
handle: aResponse
^self client handle: aResponse!
handleContinuationResponse: aResponse
| promise |
promise := continuationPromise.
continuationPromise := nil.
readResponseSemaphore wait.
promise value: aResponse!
handleNextResponse
| resp |
resp := self getResponse.
resp isNil ifTrue: [^false].
(self waitingForContinuation and: [ resp isContinuationResponse ])
ifTrue: [
self handleContinuationResponse: resp.
^true].
commandsInProgress
detect: [:command | command handle: resp]
ifNone: [self handle: resp].
^true!
waitForContinuation
| promise |
continuationPromise isNil ifTrue: [
continuationPromise := Promise new ].
promise := continuationPromise.
readResponseSemaphore signal.
^promise value!
waitingForContinuation
^continuationPromise notNil! !
!IMAPProtocolInterpreter methodsFor: 'sending tokens'!
argumentAsAssociation: argument
(argument isKindOf: Association) ifTrue: [^argument].
argument isNil ifTrue: [^'NIL'].
argument isCharacters ifTrue: [^#string->argument].
(argument isKindOf: Number) ifTrue: [^#number->argument].
argument isSequenceable ifTrue: [^#parenthesizedList->argument].
^argument!
sendLiteralString: string
IMAPScanner printLiteralStringLength: string on: self connectionStream.
self waitForContinuation.
IMAPScanner printLiteralStringContents: string on: self connectionStream!
sendToken: token tokenType: tokenType
tokenType = #literalString
ifTrue: [self sendLiteralString: token]
ifFalse: [IMAPScanner printToken: token tokenType: tokenType on: self connectionStream]!
sendTokenList: listOfTokens
| assoc |
listOfTokens
do:
[:arg |
assoc := self argumentAsAssociation: arg.
self sendToken: assoc value tokenType: assoc key]
separatedBy: [self connectionStream space]! !
!IMAPClient methodsFor: 'accessing'!
protocolInterpreter
^IMAPProtocolInterpreter!
state
^state!
state: aState
state := aState.
state client: self! !
!IMAPClient methodsFor: 'connection'!
connectToHost: aString port: aNumber
"Establish a connection to the host <aString>."
super connectToHost: aString port: aNumber.
self state: IMAPNonAuthenticatedState new!
!IMAPClient methodsFor: 'commands'!
append: message to: aMailboxName
^self state
append: message
to: aMailboxName
flags: nil
date: nil!
append: message to: aMailboxName flags: flags date: dateString
^self state
append: message
to: aMailboxName
flags: flags
date: dateString!
capability
^self state capability!
check
^self state check!
close
^self state close!
create: aMailBoxName
^self state create: aMailBoxName!
delete: aMailBoxName
^self state delete: aMailBoxName!
examine: aMailBoxName
^self state examine: aMailBoxName!
expunge
^self state expunge!
fetch: aCriteria
^self state fetch: aCriteria!
fetch: messageNumbers retrieve: criteria
^self state fetch: messageNumbers retrieve: criteria!
fetchRFC822Messages: messageNumbers
| result dict |
result := self state fetch: messageNumbers retrieve: 'rfc822'.
dict := Dictionary new: 4.
^result successful
ifTrue:
[result commandResponses do: [:resp | dict at: resp value put: (resp parameters at: 'RFC822')].
dict]
ifFalse: [nil]!
list: refName mailbox: name
^self state list: refName mailbox: name!
login
^self state login!
logout
^self state logout!
lsub: refName mailbox: name
^self state lsub: refName mailbox: name!
noop
^self state noop!
rename: oldMailBox newName: newMailBox
^self state rename: oldMailBox newName: newMailBox!
search: aCriteria
^self state search: aCriteria!
select: aMailBoxName
^self state select: aMailBoxName!
status: aMailBoxNameWithArguments
^self state status: aMailBoxNameWithArguments!
store: args
^self state store: args!
subscribe: aMailBoxName
^self state subscribe: aMailBoxName!
uid: aString
^self state uid: aString!
unsubscribe: aMailBoxName
^self state unsubscribe: aMailBoxName! !
!IMAPClient methodsFor: 'create&execute command'!
commandClassFor: cmdName
^self class commandClassFor: cmdName!
createCommand: aString
^self createCommand: aString arguments: nil!
createCommand: aString arguments: anArray
^IMAPCommand
forClient: clientPI
name: aString
arguments: anArray!
execute: cmd arguments: args changeStateTo: aStateBlock
^self
execute: [self createCommand: cmd arguments: args ]
changeStateTo: aStateBlock!
execute: aBlock changeStateTo: aStateBlock
| command |
command := aBlock value.
self executeCommand: command.
command wait.
command completedSuccessfully ifTrue: [self state: aStateBlock value ].
^command!
executeAndWait: aString
^self executeAndWait: aString arguments: nil!
executeAndWait: aString arguments: anArray
| command |
command := self createCommand: aString arguments: anArray.
self executeCommand: command.
command wait.
^command!
executeCommand: aCommand
^self clientPI executeCommand: aCommand! !
!IMAPClient methodsFor: 'private'!
canonicalizeMailboxName: aMailboxName
" #todo. Mailbox names are encoded in UTF-7 format. Add encoding logic here when available "
^aMailboxName!
messageSetAsString: messageNumbers
| stream |
stream := (String new: 64) writeStream.
messageNumbers
do: [:messageNumber | stream nextPutAll: messageNumber]
separatedBy: [stream nextPut: $,].
^stream contents! !
!IMAPClient methodsFor: 'responses'!
handle: aResponse
"^aResponse"
^true! !
!IMAPCommandSequencer class methodsFor: 'instance creation'!
new
^self basicNew initialize!
newPrefix: prefix
^self new prefix: prefix; yourself! !
!IMAPCommandSequencer methodsFor: 'accessing'!
next
self increment.
^self prefix, self value printString!
prefix
^prefix!
prefix: aValue
prefix := aValue!
value
^value!
value: aValue
value := aValue! !
!IMAPCommandSequencer methodsFor: 'initialization'!
initialize
value := 0!
reset
self value: 0! !
!IMAPCommandSequencer methodsFor: 'private'!
increment
self value: (self value + 1)! !
!IMAPFetchedItemSectionSpecification class methodsFor: 'instance creation'!
readFrom: tokenStream
| specName |
specName := tokenStream next.
specName isNil ifTrue: [ specName := 'Empty' ].
^(self properSubclassFor: specName) new
specName: specName ;
readFrom: tokenStream! !
!IMAPFetchedItemSectionSpecification class methodsFor: 'matching'!
canBe: aName
^#(
'TEXT'
'MIME'
) includes: aName asUppercase!
defaultClass
^IMAPFetchedItemSectionSpecification!
properSubclassFor: aName
^IMAPFetchedItemSectionSpecification withAllSubclasses
detect: [ : each | each canBe: aName ]
ifNone: [ self defaultClass ]! !
!IMAPFetchedItemSectionSpecification methodsFor: 'accessing'!
specName
^specName!
specName: aName
specName := aName! !
!IMAPFetchedItemSectionSpecification methodsFor: 'content'!
extractContentFrom: tokenStream
"
Check for a partial fetch- this would include a range specification given in angle brackets.
Otherwise, there should only be a single token containing the requested content.
"
| peekStream |
peekStream := tokenStream peek readStream.
(peekStream peek = $<)
ifTrue: [ self extractSpannedContentSpanFrom: tokenStream ]
ifFalse: [ rawContent := tokenStream next ]!
extractSpannedContentSpanFrom: tokenStream
"we've lost some information- we need the bytecount, but it is gone. Must revisit this!!"
| startPoint |
startPoint := (tokenStream next readStream
next ;
upTo: $>) asNumber.
rawContent := tokenStream next.
"we're going to try to simply use the length of the raw content as the span length- however, this is not actually correct, though it is close."
span := (startPoint) @ (rawContent size)!
rawContent
^rawContent! !
!IMAPFetchedItemSectionSpecification methodsFor: 'instance creation'!
readFrom: tokenStream
"
The section spec will be either numeric (if the message is MIME this is oK) or one of the following:
'HEADER'
'HEADER.FIELDS'
'HEADER.FIELDS.NOT'
'MIME'
'TEXT'
Some examples would be:
1
1.HEADER
HEADER
HEADER.FIELDS
3.2.3.5.HEADER.FIELDS (to fetch header fields for part 3.2.3.5)
"
"the numeric part could be pulled out at this point as the position spec, followed by the section spec, then followed by optional? parameters."
"positionSpec := ?"
parameters := tokenStream next! !
!IMAPFetchedItemSectionSpecification methodsFor: 'span'!
pvtFullSpan
^0 to: (self rawContent size)!
span
"Items are not always requested in their entirety. The span tells us which part of the desired content was retrieved."
^span notNil
ifTrue: [ span ]
ifFalse: [ self pvtFullSpan ]!
span: anInterval
"Items are not always requested in their entirety. The span tells us which part of the desired content was retrieved."
span := anInterval! !
!IMAPResponse class methodsFor: 'parsing, general'!
defaultResponseClass
^IMAPResponse!
parse: scanner
| theToken theResponse |
theToken := scanner nextToken.
theToken isNil ifTrue: [ ^nil ].
"
IMAP Server responses are classified as either tagged or untagged.
Untagged responses begin with either the asterisk or plus sign, while tagged responses begin with the command id.
"
theResponse := (#($* '+') includes: theToken)
ifTrue: [ self parseUntagged: scanner withStar: theToken == $* ]
ifFalse: [ self parseTagged: scanner withTag: theToken ].
scanner upTo: Character nl.
^theResponse
source: scanner sourceTrail;
yourself!
parserForUntaggedResponse: responseName
| properSubclass |
properSubclass := IMAPResponse allSubclasses
detect: [ : each | each canParse: responseName ]
ifNone: [ self defaultResponseClass ].
^properSubclass new!
parserTypeForTaggedStatus: status
^IMAPResponseTagged!
parseTagged: scanner withTag: tag
| status |
status := scanner nextToken.
^(self parserTypeForTaggedStatus: status)
parse: scanner
tag: tag
status: status!
parseContinuationResponse: scanner
^IMAPContinuationResponse new!
parseUntagged: scanner withStar: isStar
| token token2 |
"An untagged responses might be a continuation responses.
These begin with the plus sign rather than the asterisk."
isStar
ifFalse: [ ^self parseContinuationResponse: scanner ].
token := scanner nextToken.
"At this point, we know the response is untagged, but IMAP's untagged responses are not well designed.
Some responses provide numeric data first, response or condition name second, while others do it the other way around.
What we are doing here is determining what order these things are in, and then doing the parsing accordingly."
^(token first isLetter)
ifTrue: [
(self parserForUntaggedResponse: token)
parse: scanner with: token
]
ifFalse: [
token2 := scanner nextToken.
(self parserForUntaggedResponse: token2)
parse: scanner forCommandOrConditionNamed: token2 withValue: token
]!
readFrom: stream
^self parse: (self scannerOn: stream)!
scannerOn: stream
^IMAPScanner on: stream! !
!IMAPResponse class methodsFor: 'testing'!
canParse: responseName
^false! !
!IMAPResponse methodsFor: 'accessing'!
cmdName
^cmdName!
cmdName: aString
cmdName := aString!
source
^source!
source: aString
source := aString!
tag
^nil!
value
^value!
value: aValue
value := aValue! !
!IMAPResponse methodsFor: 'parsing, general'!
parse: scanner
self value: scanner deepTokenize!
parse: scanner forCommandOrConditionNamed: commandOrConditionName withValue: codeValue
self cmdName: commandOrConditionName.
self value: codeValue.
self parse: scanner!
parse: scanner with: commandConditionOrStatusName
self cmdName: commandConditionOrStatusName.
self parse: scanner!
scanFrom: scanner
self value: scanner deepTokenize!
scanFrom: scanner forCommandOrConditionNamed: commandOrConditionName withValue: codeValue
self cmdName: commandOrConditionName.
self value: codeValue.
self scanFrom: scanner!
scanFrom: scanner with: commandConditionOrStatusName
self cmdName: commandConditionOrStatusName.
self scanFrom: scanner! !
!IMAPResponse methodsFor: 'printing'!
printLog
^self source!
printOn: stream
source notNil ifTrue: [ stream nextPutAll: source ]! !
!IMAPResponse methodsFor: 'testing'!
hasTag: aString
^false!
isContinuationResponse
^false!
isStatusResponse
^false! !
!IMAPState class methodsFor: 'instance creation'!
forClient: client
^self new client: client! !
!IMAPState methodsFor: 'accessing'!
client
^client! !
!IMAPState methodsFor: 'any state valid commands'!
capability
^client executeAndWait: 'capability'!
logout
| command |
(command := client executeAndWait: 'logout') completedSuccessfully
ifTrue: [ client state: IMAPState new].
^command!
noop
^client executeAndWait: 'noop'! !
!IMAPState methodsFor: 'commands'!
append
self signalError!
check: aClient
self signalError!
close: aClient
self signalError!
copy
self signalError!
create: aClient arguments: aList
self signalError!
delete: aClient arguments: aList
self signalError!
examine: aClient arguments: aList
self signalError!
expunge: aClient
self signalError!
fetch: aClient arguments: aList
self signalError!
list: aClient arguments: aList
self signalError!
login: pi
self signalError!
lsub: aClient arguments: aLIst
self signalError!
rename: aClient arguments: aList
self signalError!
search: aClient arguments: aLIst
self signalError!
select: aClient arguments: aList
self signalError!
status
self signalError!
store: aClient arguments: aList
self signalError!
subscribe: aClient arguments: aList
self signalError!
uid: aClient arguments: aList
self signalError!
unsubscribe: aClient arguments: aList
self signalError! !
!IMAPState methodsFor: 'errors'!
signalError
^self protocolError: 'wrong state'! !
!IMAPState methodsFor: 'initialize-release'!
client: aValue
client := aValue! !
!IMAPState methodsFor: 'obsolete'!
capability: aClient
| command |
^(command := aClient executeAndWait: 'capability') completedSuccessfully
ifTrue: [command]
ifFalse: [false]!
logout: aClient
| command |
(command := aClient executeAndWait: 'logout') completedSuccessfully
ifTrue: [ aClient state: IMAPState new].
^command!
noop: client
| command |
^(command := client executeAndWait: 'noop') completedSuccessfully
ifTrue: [command]
ifFalse: [false]! !
!IMAPState methodsFor: 'testing'!
isAuthenticated
^false!
isSelected
^false! !
!IMAPProtocolInterpreterTest methodsFor: 'running'!
setUp
pi := IMAPProtocolInterpreter new.
pi client: IMAPClient new! !
!IMAPProtocolInterpreterTest methodsFor: 'Testing'!
testScript1
self executeCompleteTestScript: 'C: abcd CAPABILITY
S: * CAPABILITY IMAP4rev1 AUTH=KERBEROS_V4
S: abcd OK CAPABILITY completed
' readStream!
testScript2
| stream |
stream :=
'C: A003 APPEND saved-messages (\Seen) {309}
S: + Ready for additional command text
C: Date: Mon, 7 Feb 1994 21:52:25 -0800 (PST)
C: From: Fred Foobar <foobar@Blurdybloop.COM>
C: Subject: afternoon meeting
C: To: mooch@owatagu.siam.edu
C: Message-Id: <B27397-0100000@Blurdybloop.COM>
C: MIME-Version: 1.0
C: Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
C:
C: Hello Joe, do you think we can meet at 3:30 tomorrow?
C: 1234567
S: A003 OK APPEND completed' readStream.
self executeCompleteTestScript: stream! !
!IMAPProtocolInterpreterTest methodsFor: 'utility'!
executeCompleteTestScript: aStream
"Execute script respresenting complete execution of one or more commands.
At the end of the script all commands must have been completed, so there will be
no queued or outstanding commands and all returned commands will be in 'done' state"
| cmds |
cmds := self executeTestScript: aStream.
cmds last value. " Wait for the last command "
self assert: pi queuedCommands size = 0.
self assert: pi commandsInProgress size = 0.
cmds do: [:cmd | self assert: cmd isDone].
^cmds!
executeTestScript: aStream
"Execute script is the form:
C: abcd CAPABILITY
S: * CAPABILITY IMAP4rev1 AUTH=KERBEROS_V4
S: abcd OK CAPABILITY completed
Lines starting with 'C: ' are client commands, lines starting with 'S: ' are server responses"
| cmd cmdStream respStream line |
cmdStream := (String new: 64) writeStream.
respStream := (String new: 64) writeStream.
[aStream atEnd]
whileFalse:
[cmd := aStream peek asUppercase.
line := aStream next: 3; upTo: Character nl.
(cmd == $C)
ifTrue: [cmdStream nextPutAll: line; nl]
ifFalse: [respStream nextPutAll: line; nl]].
pi responseStream: respStream contents readStream.
^self sendCommandsFrom: cmdStream contents readStream!
sendCommandFrom: stream
| cmd |
cmd := IMAPCommand readFrom: stream.
cmd client: pi.
pi executeCommand: cmd.
^cmd!
sendCommandsFrom: aStream
"Assumption currently is, every command occupies one line. This is because
IMAPComand>>readFrom reads until end of stream. So we will read command's line
from the stream and feed it to the command as a separate stream.
Answers ordered collection of commands sent"
|cmds|
cmds := OrderedCollection new.
pi connectionStream: (String new: 256) writeStream.
[aStream atEnd]
whileFalse:
[cmds addLast: (self sendCommandFrom: aStream)].
^cmds! !
!IMAPDataResponse class methodsFor: 'testing'!
canParse: responseName
^false! !
!IMAPContinuationResponse methodsFor: 'testing'!
isContinuationResponse
^true! !
!IMAPAuthenticatedState methodsFor: 'commands'!
append: message to: aMailboxName flags: flags date: dateString
| args |
args := OrderedCollection with: (client canonicalizeMailboxName: aMailboxName).
flags notNil ifTrue: [args add: flags].
dateString notNil ifTrue: [args add: #atom -> dateString].
args add: #literalString -> message.
^client executeAndWait: 'append' arguments: args!
create: aMailboxName
^client
execute: 'create'
arguments: aMailboxName
changeStateTo: [IMAPSelectedState new]!
delete: aMailboxName
^client executeAndWait: 'delete' arguments: aMailboxName!
examine: aMailBoxName
^client
execute: 'examine'
arguments: aMailBoxName
changeStateTo: [IMAPSelectedState new]!
list: refName mailbox: name
^client executeAndWait: 'list' arguments: (Array with: refName with: name)!
lsub: refName mailbox: name
^client executeAndWait: 'lsub' arguments: (Array with: refName with: name)!
rename: oldMailBox newName: newMailBox
^client executeAndWait: 'rename' arguments: (Array with: oldMailBox with: newMailBox)!
select: aMailBoxName
^client
execute: 'select'
arguments: aMailBoxName
changeStateTo: [IMAPSelectedState new]!
status: aMailBoxNameWithArguments
^client
executeAndWait: 'status'
arguments: aMailBoxNameWithArguments.
" arguments: (Array with: aMailBoxNameWithArguments)"!
subscribe: aMailBoxName
^client executeAndWait: 'subscribe' arguments: (Array with: aMailBoxName)!
unsubscribe: aMailBoxName
^client executeAndWait: 'unsubscribe' arguments: (Array with: aMailBoxName)! !
!IMAPAuthenticatedState methodsFor: 'obsolete'!
create: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'create' arguments: aList) completedSuccessfully
ifTrue:
[aClient state: IMAPSelectedState new.
command]
ifFalse: [false]!
delete: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'delete' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
examine: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'examine' arguments: aList) completedSuccessfully
ifTrue:
[aClient state: IMAPSelectedState new.
command]
ifFalse: [nil]!
list: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'list' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
lsub: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'lsub' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
rename: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'rename' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
select: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'select'
arguments: aList)
completedSuccessfully
ifTrue: [ aClient state: IMAPSelectedState new. command ]
ifFalse: [ nil ]!
subscribe: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'subscribe' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
unsubscribe: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'unsubscribe' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]! !
!IMAPAuthenticatedState methodsFor: 'testing'!
isAuthenticated
^true! !
!IMAPStatusResponse class methodsFor: 'testing'!
canParse: commandOrConditionName
^#('OK' 'NO' 'BAD' 'BYE') includes: commandOrConditionName! !
!IMAPStatusResponse methodsFor: 'accessing'!
status
^status!
status: aStatus
status := aStatus!
text
^text! !
!IMAPStatusResponse methodsFor: 'parsing, general'!
parse: scanner
| val key |
scanner skipWhiteSpace.
(scanner peekFor: $[ )
ifTrue: [
self value: OrderedCollection new.
scanner flagBracketSpecial: true.
key := scanner nextToken asUppercase.
(#('UIDVALIDITY' 'UNSEEN') includes: key) ifTrue: [ val := scanner nextToken asNumber ].
'PERMANENTFLAGS' = key ifTrue: [ val := scanner deepNextToken ].
'NEWNAME' = key ifTrue: [ |old new|
old := scanner nextToken.
new := scanner nextToken.
val := Array with: old with: new ].
[
(scanner nextToken ~~ $]) and: [ scanner tokenType ~= #doIt ]
] whileTrue.
scanner flagBracketSpecial: false.
].
text := scanner scanText.
(#('ALERT' 'PARSE' 'TRYCREATE' 'READ-ONLY' 'READ-WRITE') includes: key)
ifTrue: [ val := text ].
self value: (key->val)!
parse: scanner with: commandConditionOrStatusName
self cmdName: commandConditionOrStatusName.
self status: commandConditionOrStatusName.
self parse: scanner! !
!IMAPStatusResponse methodsFor: 'testing, imap'!
isBad
^self status = 'BAD'!
isNotAccepted
^self status = 'NO'!
isOK
^self status = 'OK'! !
!IMAPStatusResponse methodsFor: 'testing, response type'!
isStatusResponse
^true! !
!IMAPResponseTest methodsFor: 'Testing'!
testFetch
| scanner resp str |
str := '* 12 "FETCH" (BODY[HEADER] {341}
Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
)'.
scanner := IMAPScanner on: str readStream.
resp := IMAPResponse parse: scanner.
self assert: (resp isKindOf: IMAPDataResponseFetch).
self assert: resp cmdName = 'FETCH'.
self assert: resp messageNumber = '12'.
self assert: (resp bodyFetch parts isKindOf: SequenceableCollection).
self assert: (resp bodyFetch parts allSatisfy: [ :each | each sectionSpec specName = 'HEADER'])!
testResponseHandling
| command str |
command := IMAPCommand new sequenceID: 'a_1'; name: 'FETCH'; yourself.
command client: IMAPProtocolInterpreter new.
[command value] fork.
self assert: (command handle: (IMAPResponse readFrom: ('* FLAGS (\Seen \Answered \Deleted)' readStream))) not.
self assert: (command handle: (IMAPResponse readFrom: ('a_2 OK bla' readStream))) not.
self assert: command isDone not.
str := '* 12 "FETCH" (BODY[HEADER] {341}
Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
)'.
self assert: (command handle: (IMAPResponse readFrom: str readStream)).
self assert: (command handle: (IMAPResponse readFrom: ('a_1 OK FETCH completed' readStream))).
self assert: command isDone.
self assert: command completionResponse status = 'OK'.
self assert: command promise hasValue!
testTaggedMessages
| scanner resp |
scanner := IMAPScanner on: 'oasis_1 OK LOGIN completed' readStream.
resp := IMAPResponse parse: scanner.
self assert: (resp isKindOf: IMAPResponseTagged).
self assert: resp tag = 'oasis_1'.
self assert: resp status = 'OK'.
self assert: resp text = 'LOGIN completed'!
testUnTaggedMessages
| scanner resp |
scanner := IMAPScanner on: '* FLAGS (\Seen \Answered \Deleted)' readStream.
resp := IMAPResponse parse: scanner.
self assert: resp cmdName = 'FLAGS'.
self assert: resp value first = #('\Seen' '\Answered' '\Deleted')! !
!IMAPTest methodsFor: 'Running'!
login
"establish a socket connection to the IMAP server and log me in"
client := IMAPClient loginToHost: 'SKIPPER' asUser: 'itktest' withPassword: 'Cincom*062000'.
self assert: (client isKindOf: IMAPClient)!
logout
client logout! !
!IMAPTest methodsFor: 'Testing'!
testAppend
| message |
self login.
message :=
'Date: Mon, 7 Feb 1994 21:52:25 -0800 (PST)
From: Fred Foobar <foobar@Blurdybloop.COM>
Subject: afternoon meeting
To: mooch@owatagu.siam.edu
Message-Id: <B27397-0100000@Blurdybloop.COM>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
Hello Joe, do you think we can meet at 3:30 tomorrow?'.
client append: message to: 'inbox'.
self logout!
testCreateRenameDelete
| comm box box1 |
box := 'mybox'.
box1 := 'myBoxRenamed'.
self login.
[comm := client create: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: comm completedSuccessfully.
comm := client rename: box newName: box1.
self assert: (comm isKindOf: IMAPCommand).
self assert: comm completedSuccessfully]
ensure:
[client delete: box1. self logout]!
testExamine
| box comm |
self login.
box := 'inbox'.
comm := client examine: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
self logout!
testList
| box comm |
" box := nil.
box isNil ifTrue:[ ^nil].
"
self login.
[
box := 'news/mail/box' asString.
comm := client create: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client list: 'news/' mailbox: 'mail/*' .
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
self assert: (comm responses first mbName asUppercase = box asUppercase).
] ensure: [
comm := client delete: box.
].
self logout!
testNoopCapability
| comm |
self login.
comm := client noop.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client capability.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
self logout!
testSelectCheck
| box comm |
" box := nil.
box isNil ifTrue:[ ^nil].
"
self login.
[
box := 'news/mail/box' asString.
comm := client create: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client select: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client check.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
] ensure: [
comm := client delete: box.
]!
testSelectClose
| box comm |
" box := nil.
box isNil ifTrue:[ ^nil].
"
self login.
[
box := 'news/mail/box' asString.
comm := client create: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client select: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client close.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
] ensure: [
comm := client delete: box.
]!
testSelectExpunge
" Test case doesn't return untagged response: EXPUNGE as expected"
| box comm |
" box := nil.
box isNil ifTrue:[ ^nil].
"
self login.
box := 'inbox' asString.
comm := client select: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client expunge.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully)!
testSelectFetch
| box comm |
self login.
box := 'inbox' asString.
client select: box.
comm := client fetch: '2:3 (flags internaldate uid RFC822)'.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
" comm := client fetch: '2,4 (flags internaldate uid BODY.PEEK[header])'."
" client fetch: '1:4 (uid Body.Peek[Header.Fields (Subject Date From Message-Id)])'."
" client fetch: '1:2 (flags internaldate uid RFC822)'."
" client fetch: '1 (Body.Peek[header])'."
" comm := client fetch: '3 (BodyStructure)'."
" client fetch: '2 full'."
self logout!
testSelectSearch
| box |
" box := nil.
box isNil ifTrue: [ ^box].
"
self login.
box := 'inbox' asString.
client select: box.
client search: 'undeleted unanswered from "Kogan, Tamara"'.
self logout!
testSelectStore
" | box |
self login.
box := 'inbox' asString.
self assert: ((client select: box) == true).
(client store: '1:1 +FLAGS (\Deleted)') inspect.
(client store: '1:1 -FLAGS (\Deleted)') inspect.
self logout.
"!
testSelectUID
" No expected response | box |
self login.
box := 'inbox' asString.
self assert: ((client select: box) == true).
(client uid: 'fetch 1:1 FLAGS') inspect.
self logout.
"!
testSubscribeUnsubLSUB
| box comm |
box := nil.
box isNil ifTrue:[ ^nil].
self login.
[
box := 'news/mail/box' asString.
comm := client create: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client subscribe: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
comm := client lsub: 'news/' mailbox: 'mail/*' .
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
self assert: (comm responses first mbName asUppercase = box asUppercase).
comm := client unsubscribe: box.
self assert: (comm isKindOf: IMAPCommand).
self assert: (comm completedSuccessfully).
] ensure: [
comm := client delete: box.
].
self logout! !
!IMAPBodySectionFetchedItem class methodsFor: 'matching'!
canBe: aName
"
Can the reciever represent items fetched using the given name? This is not as straightforward as it ought to be.
IMAPv4 uses 'BODY' fetches in two very different ways, so we will have to be careful about that.
For now, we are not making the distinction, so we will have to revisit this in the future.
Also, note that we don't include 'RFC822.SIZE'. Such a fetch does not return anything complex- it's actually just a simple metadata fetch.
"
" ^#(
'BODY'
'BODY.PEEK'
'RFC822'
'RFC822.HEADER'
'RFC822.TEXT'
) includes: aName."
^false! !
!IMAPBodySectionFetchedItem methodsFor: 'accessing'!
sectionSpec
^sectionSpec! !
!IMAPBodySectionFetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
"
For the body parts extraction case, tokens will be something like:
$[
'HEADER.FIELDS'
#('FIELD1' 'FIELD2')
$]
'...content as described above...'
Whereas for the body (structure) case, the tokens will be something like:
#('TEXT' 'PLAIN' #('CHARSET' 'us-ascii') nil nil '8BIT' '763' '8')
What a screwed up spec.
"
"devel thought: It might would be good if the reciever could tell what had been requested, and what had been recieved."
| specTokens |
specTokens := tokenStream
upTo: $[ ;
upTo: $].
(self sectionSpecificationFrom: specTokens)
extractContentFrom: tokenStream!
sectionSpecificationFrom: tokens
^sectionSpec := IMAPFetchedItemSectionSpecification readFrom: tokens readStream! !
!IMAPBodySectionFetchedItem methodsFor: 'header fields'!
headerFieldNamed: aName ifAbsent: aBlock
"hmm... need a more compex example here."
self halt! !
!IMAPNonAuthenticatedState methodsFor: 'commands'!
authenticate!
login
^client
execute: 'login'
arguments: (Array with: client user username with: client user password)
changeStateTo: [IMAPAuthenticatedState new]! !
!IMAPNonAuthenticatedState methodsFor: 'obsolete'!
login: aClient arguments: aList
| command |
command := aClient executeAndWait: 'login' arguments: aList.
command completedSuccessfully
ifTrue: [aClient state: IMAPAuthenticatedState new].
^command! !
!IMAPMessageEnvelopeFetchedItem class methodsFor: 'matching'!
canBe: aName
"
Can the reciever represent items fetched using the given name?
Note that we include 'RFC822.SIZE' .
This is just a simple metadata fetch, unlike such things as 'RFC822' or 'RFC822.HEADER' .
"
^'ENVELOPE'= aName! !
!IMAPMessageEnvelopeFetchedItem methodsFor: 'accessing'!
bccLine
^self envelope at: 8!
ccLine
^self envelope at: 7!
dateLine
^self envelope at: 1!
fromAuthor
^(self fromLine at: 1) at: 1!
fromLine
^self envelope at: 3!
inReplyToLine
^self envelope at: 9!
replyToAuthor
^(self replyToLine at: 1) at: 1!
replyToLine
^self envelope at: 5!
senderAuthor
^(self senderLine at: 1) at: 1!
senderLine
^self envelope at: 4!
subjectLine
^self envelope at: 2!
toLine
^self envelope at: 6!
uniqueMessageIDLine
^self envelope at: 10! !
!IMAPMessageEnvelopeFetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
"the envelope is an array of message metadata- we'll come back to this for interpretation later."
self envelope: (tokenStream next)! !
!IMAPMessageEnvelopeFetchedItem methodsFor: 'envelope'!
envelope
^envelope!
envelope: anArray
"We have yet to interpret the contents of the given array... we shall need to get to that later."
envelope := anArray! !
!IMAPMessageEnvelopeFetchedItem methodsFor: 'printing'!
printDevelOn: aStream indent: level
aStream
crtab: level ;
nextPutAll: 'Date: ' ;
nextPutAll: self dateLine ;
crtab: level ;
nextPutAll: 'Subject: ' ;
nextPutAll: self subjectLine ;
crtab: level ;
nextPutAll: 'From: ' ;
print: self fromAuthor ;
crtab: level ;
nextPutAll: 'Sender: ' ;
print: self senderAuthor ;
crtab: level ;
nextPutAll: 'ReplyTo: ' ;
print: self replyToAuthor ;
crtab: level ;
nextPutAll: 'To: ' ;
print: self toLine ;
crtab: level ;
nextPutAll: 'In Reply To: ' ;
print: self inReplyToLine ;
crtab: level ;
nextPutAll: 'Message ID: ' ;
nextPutAll: self uniqueMessageIDLine ;
crtab: level ;
nextPutAll: 'Bcc: ' ;
print: self bccLine ;
crtab: level ;
nextPutAll: 'Cc: ' ;
print: self ccLine ;
yourself!
printOn: aStream
self printDevelOn: aStream indent: 0! !
!IMAPBodyRFC822FetchedItem class methodsFor: 'matching'!
canBe: aName
"
Note that we don't include 'RFC822.SIZE'.
Such a fetch does not return anything complex- it's actually just a simple metadata fetch.
"
^#(
'RFC822'
'RFC822.HEADER'
'RFC822.TEXT'
) includes: aName! !
!IMAPBodyRFC822FetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
"
Cases:
RFC822
RFC822.Header
RFC822.Text
"
value := tokenStream next! !
!IMAPMessageMetadataFetchedItem class methodsFor: 'matching'!
canBe: aName
"
Can the reciever represent items fetched using the given name?
Note that we include 'RFC822.SIZE' .
This is just a simple metadata fetch, unlike such things as 'RFC822' or 'RFC822.HEADER' .
"
^#(
'FLAGS'
'INTERNALDATE'
'RFC822.SIZE'
'UID'
) includes: aName! !
!IMAPMessageMetadataFetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
self value: (tokenStream next)! !
!IMAPMessageMetadataFetchedItem methodsFor: 'value'!
value
^value!
value: anObject
value := anObject! !
!IMAPFetchedItemHeaderSectionSpecification class methodsFor: 'matching'!
canBe: aName
^'HEADER*'
match: aName
ignoreCase: true! !
!IMAPBodyStructureFetchedItem class methodsFor: 'matching'!
canBe: aName
^'BODYSTRUCTURE' = aName! !
!IMAPBodyStructureFetchedItem methodsFor: 'accessing'!
structure
^structure!
structure: aStructure
structure := aStructure! !
!IMAPBodyStructureFetchedItem methodsFor: 'building'!
extractContentFrom: tokenStream
"
The structure will be something like:
#('TEXT' 'PLAIN' #('CHARSET' 'us-ascii') nil nil '8BIT' '763' '8')
"
self structure: tokenStream next! !
!IMAPScannerTest methodsFor: 'running'!
setUp
parser := IMAPScanner new!
stream6
| str |
str := (String new: 512) writeStream.
str nextPutAll: '* 12 FETCH (FLAGS (\Seen) INTERNALDATE "17-Jul-1996 02:44:25 -0700"
RFC822.SIZE 4286 ENVELOPE ("Wed, 17 Jul 1996 02:23:25 -0700 (PDT)"
"IMAP4rev1 WG mtg summary and minutes"
(("Terry Gray" NIL "gray" "cac.washington.edu"))
(("Terry Gray" NIL "gray" "cac.washington.edu"))
(("Terry Gray" NIL "gray" "cac.washington.edu"))
((NIL NIL "imap" "cac.washington.edu"))
((NIL NIL "minutes" "CNRI.Reston.VA.US")
("John Klensin" NIL "KLENSIN" "INFOODS.MIT.EDU")) NIL NIL
"<B27397-0100000@cac.washington.edu>")
BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 3028 92))
'; nl.
^str! !
!IMAPScannerTest methodsFor: 'testing'!
testDeepTokenize
| tokens |
tokens := parser on: '* FLAGS (\Seen \Answered \Flagged \Deleted XDraft)' readStream; deepTokenize.
self assert: tokens = #($* 'FLAGS' #('\Seen' '\Answered' '\Flagged' '\Deleted' 'XDraft')).
self assert: parser atEnd!
testDeepTokenize1
| tokens |
tokens := parser on: '(BODYSTRUCTURE (("TEXT" "PLAIN" ("charset" "iso-8859-1") NIL nil "QUOTED-PRINTABLE" 7 2 NIL NIL NIL)("APPLICATION" "OCTET-STREAM" ("name" "StoreErrorDialog.st") NiL NIL "BASE64" 4176 NIL NIL NIL) "mixed" ("boundary" "=_STAMPed_MAIL_=") NIL NIL))' readStream; deepTokenize.
self assert: tokens = #(#('BODYSTRUCTURE' #(#('TEXT' 'PLAIN' #('charset' 'iso-8859-1') nil nil 'QUOTED-PRINTABLE' '7' '2' nil nil nil) #('APPLICATION' 'OCTET-STREAM' #('name' 'StoreErrorDialog.st') nil nil 'BASE64' '4176' nil nil nil) 'mixed' #('boundary' '=_STAMPed_MAIL_=') nil nil))).
self assert: parser atEnd.
tokens := parser on: '(BODYSTRUCTURE (("TEXT" "PLAIN" ("charset" "iso-8859-1") NIL NIL "QUOTED-PRINTABLE" 7 2 NIL NIL NIL)("APPLICATION" "OCTET-STREAM" ("name" "StoreErrorDialog.st") NIL NIL "BASE64" 4176 NIL NIL NIL) "mixed" ("boundary" "=_STAMPed_MAIL_=") NIL NIL))' readStream; deepTokenizeAsAssociation!
testDeepTokenizeAsAssoc
| tokens str |
str := '* 12 "FETCH" ((a b nil) BODY[HEADER] {341}
Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
)'.
tokens := parser on: str readStream; deepTokenizeAsAssociation.
self assert: tokens first = (#special->$*).
self assert: (tokens at: 2) = (#atom->'12').
self assert: (tokens at: 3) = (#quotedText->'FETCH').
self assert: (tokens at: 4) = (#parenthesizedList->(Array with: (#parenthesizedList->(Array with: #atom->'a' with: #atom->'b' with: #nil->nil)) with: #atom->'BODY[HEADER]' with: #literalString->
'Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
')).
self assert: parser atEnd!
testLiteralStrings
| tokens str |
str := '* 12 FETCH (BODY[HEADER] {341}
Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
)'. " Extra char for every cr -- will be different in external streams "
tokens := parser on: str readStream; deepTokenize.
self assert: tokens = #($* '12' 'FETCH' #('BODY[HEADER]' 'Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
')).
self assert: parser atEnd!
testSourceTrail
| str trail |
str := '* 12 "FETCH" (BODY[HEADER] {341}
Date: Wed, 17 Jul 1996 02:23:25 -0700 (PDT)
From: Terry Gray <gray@cac.washington.edu>
Subject: IMAP4rev1 WG mtg summary and minutes
To: imap@cac.washington.edu
cc: minutes@CNRI.Reston.VA.US, John Klensin <KLENSIN@INFOODS.MIT.EDU>
Message-Id: <B27397-0100000@cac.washington.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; CHARSET=US-ASCII
)'.
parser on: str readStream; sourceTrailOn; deepTokenizeAsAssociation.
trail := parser sourceTrail.
self assert: trail = str.
self assert: parser sourceTrail isNil.
self assert: parser atEnd!
testTaggedResponses
|tokens|
tokens := parser on: 'oasis_3 OK FETCH completed.' readStream; tokenize.
self assert: tokens = #('oasis_3' 'OK' 'FETCH' 'completed.').
self assert: parser atEnd! !
!IMAPBodyFetchedItem class methodsFor: 'matching'!
canBe: aName
"
Can the reciever represent items fetched using the given name? This is not as straightforward as it ought to be.
IMAPv4 uses 'BODY' fetches in two very different ways, so we will have to be careful about that.
For now, we are not making the distinction, so we will have to revisit this in the future.
"
^#(
'BODY'
'BODY.PEEK'
) includes: aName! !
!IMAPBodyFetchedItem methodsFor: 'building'!
extractBodySectionContentFrom: tokenStream
self parts
add: (IMAPBodySectionFetchedItem new extractContentFrom: tokenStream)!
extractContentFrom: tokenStream
"
For the body parts extraction case, tokens will be something like:
$[
'HEADER.FIELDS'
#('FIELD1' 'FIELD2')
$]
'...content as described above...'
Whereas for the body (structure) case, the tokens will be something like:
#('TEXT' 'PLAIN' #('CHARSET' 'us-ascii') nil nil '8BIT' '763' '8')
What a screwed up spec.
"
"devel thought: It might would be good if the reciever could tell what had been requested, and what had been recieved."
"First off, are we talking about a body section fetch, or a short-form body structure fetch? Bastards!!"
(tokenStream peek = $[ )
ifTrue: [ self extractBodySectionContentFrom: tokenStream ]
ifFalse: [ self extractShortFormBodyStructureFrom: tokenStream ]!
extractShortFormBodyStructureFrom: tokenStream
"
Whereas for the body (structure) case, the tokens will be something like:
#('TEXT' 'PLAIN' #('CHARSET' 'us-ascii') nil nil '8BIT' '763' '8')
"
self parts
add: (IMAPBodyStructureFetchedItem new extractContentFrom: tokenStream)! !
!IMAPBodyFetchedItem methodsFor: 'parts'!
parts
^parts notNil
ifTrue: [ parts ]
ifFalse: [ parts := OrderedCollection new ]! !
!IMAPDataResponseFetch class methodsFor: 'testing'!
canParse: responseName
^'FETCH' = responseName
" ^false"! !
!IMAPDataResponseFetch methodsFor: 'fetchable items'!
bodyFetch
^self
fetchedItemNamed: 'body'
ifAbsent: [ nil ]!
bodyText
^(self fetchedItemNamed: 'body') parts first
sectionSpec rawContent!
envelope
^self
fetchedItemNamed: 'envelope'
ifAbsent: [ nil ]!
extractFetchedItemsFrom: tokenStream
[
(tokenStream atEnd not) and: [ self fetchableItemNames includes: (tokenStream peek) ]
] whileTrue: [
(self newFetchedItemNamed: (tokenStream next))
extractContentFrom: tokenStream
]!
fetchableItemNames
^#(
'ALL'
'BODY' "actually, there are two forms represented by this name- see the spec."
'BODY.PEEK'
'BODYSTRUCTURE'
'ENVELOPE'
'FAST'
'FULL'
'FLAGS'
'INTERNALDATE'
'RFC822'
'RFC822.HEADER'
'RFC822.SIZE'
'RFC822.TEXT'
'UID'
)!
fetchedHeaderNamed: aHeaderName ifAbsent: aBlock
^self headerFetch
fieldNamed: aHeaderName
ifAbsent: [ aBlock value ]!
fetchedItemNamed: aName
^self
fetchedItemNamed: aName
ifAbsent: [ nil ]!
fetchedItemNamed: aName ifAbsent: aBlock
| seekName |
seekName := aName asLowercase.
^self fetchedItems
at: seekName
ifAbsent: [ aBlock value ]!
fetchedItems
^fetchedItems notNil
ifTrue: [ fetchedItems ]
ifFalse: [ fetchedItems := Dictionary new ]!
hasUID
^self fetchedItems
includesKey: 'uid'!
hasUniqueMessageID
^self hasFetchedItemHaving: 'message-ID'!
itemHolding: anItemName
^self fetchedItems
traverse: [ : eachItem | eachItem ]
seeking: [ : eachItem | eachItem holds: anItemName ]!
newFetchedItemNamed: aName
^self fetchedItems
at: (aName asLowercase)
put: (IMAPFetchedItem named: aName)!
rawUniqueMessageID
"If available, answer the unique message ID as provided within the message's headers."
^self bodyFetch
headerFieldNamed: 'message-ID'
ifAbsent: [ nil ]!
uid
"The UID is an item that may or not have been fetched by the reciever."
| uidRaw |
uidRaw := self
fetchedItemNamed: 'UID'
ifAbsent: [ nil ].
^uidRaw notNil
ifTrue: [ uidRaw value asNumber ]
ifFalse: [ nil ]! !
!IMAPDataResponseFetch methodsFor: 'message number'!
messageNumber
^self sequenceNumber!
messageNumber: aNumber
self sequenceNumber: aNumber!
messageSequenceNumber
^self sequenceNumber!
sequenceNumber
^self fetchedItemNamed: 'sequence_number'!
sequenceNumber: aNumber
^self fetchedItems
at: 'sequence_number'
put: aNumber! !
!IMAPDataResponseFetch methodsFor: 'meta responses'!
metaResponses
^metaResponses!
metaResponses: statusResponses
metaResponses := statusResponses! !
!IMAPDataResponseFetch methodsFor: 'parsing, general'!
parse: scanner
| tokens |
scanner flagBracketSpecial: true.
tokens := scanner deepNextToken.
scanner flagBracketSpecial: false.
self extractFetchedItemsFrom: tokens readStream!
value: aNumber
self sequenceNumber: (value := aNumber)! !
!IMAPResponseMailboxStatus class methodsFor: 'testing'!
canParse: conditionName
"should be more- I need to check this."
^#('UNSEEN' 'EXISTS') includes: conditionName! !
!IMAPResponseMailboxStatus methodsFor: 'parsing, general'!
parse: scanner
self halt.
super parse: scanner!
parse: scanner forCommandOrConditionNamed: commandOrConditionName withValue: codeValue
self cmdName: commandOrConditionName.
self value: codeValue! !
!IMAPResponseTagged class methodsFor: 'parsing, general'!
parse: scanner tag: tag status: status
^self new
parse: scanner
tag: tag
status: status!
scanFrom: scanner tag: tag status: status
^self new
scanFrom: scanner tag: tag status: status! !
!IMAPResponseTagged class methodsFor: 'testing'!
canParse: cmdName
^false! !
!IMAPResponseTagged methodsFor: 'accessing'!
tag
^self cmdName!
text
^text! !
!IMAPResponseTagged methodsFor: 'parsing, general'!
parse: scanner tag: tag status: statusString
self cmdName: tag.
self status: statusString.
^self parse: scanner! !
!IMAPResponseTagged methodsFor: 'testing'!
hasTag: tagString
^self tag match: tagString! !
!IMAPDataResponseSearch class methodsFor: 'testing'!
canParse: responseName
^'SEARCH' = responseName! !
!IMAPDataResponseSearch methodsFor: 'id sequences'!
basicIDSequences
| intervals currentStart currentStop currentInterval |
intervals := OrderedCollection new.
currentInterval := (-1 -> -1).
self numericIDs do: [ : eachNumericID |
(eachNumericID = (currentInterval value + 1))
ifTrue: [ currentInterval value: eachNumericID ]
ifFalse: [
currentStop := currentStart := eachNumericID.
intervals add: (currentInterval := (currentStart -> currentStop)).
]
].
^intervals collect: [ : eachInterval |
(eachInterval key = eachInterval value)
ifTrue: [ eachInterval key printString ]
ifFalse: [ eachInterval key printString, ':', eachInterval value printString ]
]!
idSequences
"
This would be a good place to further condense the basic id sequences.
Currently we offer a series of ranges, but these ranges could be combined, eg:
#('1:123' '231:321' etc...)
could become:
#('1:123, 231:321' etc...)
This would reduce the number of fetch requests that would be needed to retrieve the messages identified by the search response.
"
^self basicIDSequences!
numericIDs
^self rawIDs collect: [ : eachRawID | eachRawID asNumber ]!
rawIDs
^self value! !
!IMAPSelectedState methodsFor: 'commands'!
check
^client executeAndWait: 'check'!
close
^client
execute: 'close'
arguments: nil
changeStateTo: [IMAPAuthenticatedState new]!
copy!
expunge
^client executeAndWait: 'expunge'!
fetch: aCriteria
^client executeAndWait: 'fetch' arguments: aCriteria!
fetch: messageNumbers retrieve: criteria
| msgString args |
msgString := client messageSetAsString: messageNumbers.
args := OrderedCollection with: msgString.
criteria notNil ifTrue: [criteria isCharacters
ifTrue: [args add: criteria]
ifFalse: [args addAll: criteria]].
^client executeAndWait: 'fetch' arguments: args!
search: aCriteria
^client executeAndWait: 'search' arguments: aCriteria!
store: args
^client executeAndWait: 'store' arguments: args!
uid: aString
^client executeAndWait: 'uid' arguments: aString! !
!IMAPSelectedState methodsFor: 'obsolete'!
check: aClient
^client executeAndWait: 'check'!
close: aClient
| command |
^(command := aClient executeAndWait: 'close') completedSuccessfully
ifTrue: [aClient state: IMAPAuthenticatedState new. command]
ifFalse: [nil]!
expunge: aClient
| command |
^(command := aClient executeAndWait: 'expunge') completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
fetch: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'fetch' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
search: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'search' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]!
store: aClient arguments: aList
| command |
^(command := aClient executeAndWait: 'store' arguments: aList) completedSuccessfully
ifTrue: [command]
ifFalse: [nil]! !
!IMAPSelectedState methodsFor: 'testing'!
isSelected
^true! !
!IMAPDataResponseList class methodsFor: 'testing'!
canParse: cmdName
^'LIST' = cmdName! !
!IMAPDataResponseList methodsFor: 'accessing'!
mbAttributes
^mbAttributes!
mbDelimeter
^mbDelimiter!
mbName
^mbName! !
!IMAPDataResponseList methodsFor: 'parsing, general'!
parse: scanner
" Parse message attributes"
" (\NOSELECT) '/' ~/Mail/foo"
| tokens |
tokens := scanner deepTokenize.
mbAttributes := tokens at: 1.
mbDelimiter := tokens at: 2.
mbName := tokens at: 3! !
!IMAPScanner class methodsFor: 'character classification'!
atomSpecials
" These characters cannot occur inside an atom"
^'( ){%*"\'!
specials
^self atomSpecials! !
!IMAPScanner class methodsFor: 'class initialization'!
initClassificationTable
super initClassificationTable.
self initClassificationTableWith: TextMask when:
[:c | c ~~ Character cr ].
self initClassificationTableWith: AtomMask when:
[:c | c > Character space and: [ (self atomSpecials includes: c) not] ].
self initClassificationTableWith: QuotedTextMask when:
[:c | c ~~ $" and: [ c ~~ $\ and: [ c ~~ Character cr ]]]!
initialize
" IMAPScanner initialize "
self initializeConstants; initClassificationTable!
initializeConstants
AtomMask := 256.
QuotedTextMask := 4096.
TextMask := 8192! !
!IMAPScanner class methodsFor: 'printing'!
defaultTokenType
^#string!
printAtom: atom on: stream
atom isNil
ifTrue: [stream nextPutAll: 'NIL']
ifFalse: [stream nextPutAll: atom "asUppercase"]!
printIMAPString: value on: stream
"Print string as either atom or quoted text"
value isNil ifTrue: [ self printNilOn: stream].
(self shouldBeQuoted: value)
ifTrue: [self printQuotedText: value on: stream ]
ifFalse: [self printAtom: value on: stream]!
printLiteralString: aString on: stream
"Note that this method is good for printing but not for sending.
IMAP requires sender to send string length, then wait for continuation response"
self printLiteralStringLength: aString on: stream.
self printLiteralStringContents: aString on: stream!
printLiteralStringContents: aString on: stream
stream nextPutAll: aString!
printLiteralStringLength: aString on: stream
stream nextPut: ${.
aString size printOn: stream.
stream nextPut: $}; nl!
printNilOn: stream
stream nextPutAll: 'NIL'!
printParenthesizedList: arrayOfAssociations on: stream
"In order to accurately print parenthesized list, we need to know
token types of every element. This is applied recursively"
stream nextPut: $(.
self printTokenList: arrayOfAssociations on: stream.
stream nextPut: $)!
printToken: value tokenType: aSymbol on: stream
aSymbol = #string ifTrue: [^self printIMAPString: value on: stream].
aSymbol = #literalString ifTrue: [^self printLiteralString: value on: stream].
aSymbol = #atom ifTrue: [^self printAtom: value on: stream].
aSymbol = #quotedText ifTrue: [^self printQuotedText: value on: stream].
aSymbol = #nil ifTrue: [^self printNilOn: stream].
aSymbol = #parenthesizedList ifTrue: [^self printParenthesizedList: value on: stream]. "Invalid token type"
aSymbol = #special ifTrue: [^stream nextPut: value].
self halt!
stringAsAssociation: string
(self shouldBeQuoted: string) ifFalse: [^#atom -> string].
(string first == $\ and:
[string size > 1 and:
[self shouldBeQuoted: (string copyFrom: 2 to: string size) not]])
ifTrue: [^#atom -> string].
^#quotedText -> string!
tokenAsAssociation: token
(token isKindOf: Association) ifTrue: [^token].
token isNil ifTrue: [^'NIL'].
token isCharacters ifTrue: [^self stringAsAssociation: token].
(token isKindOf: Number) ifTrue: [^#number -> token].
token isSequenceable ifTrue: [^#parenthesizedList -> token].
^token! !
!IMAPScanner class methodsFor: 'testing'!
isAtomChar: char
^((self classificationTable at: char asInteger + 1) bitAnd: AtomMask) ~= 0!
shouldBeQuoted: string
^(string detect: [ :char | (self isAtomChar: char) not ] ifNone: [ nil ]) notNil! !
!IMAPScanner methodsFor: 'accessing'!
flagBracketSpecial
flagBracketSpecial isNil ifTrue: [flagBracketSpecial := false].
^flagBracketSpecial!
flagBracketSpecial: aBoolean
flagBracketSpecial := aBoolean! !
!IMAPScanner methodsFor: 'multi-character scans'!
doSpecialScanProcessing
"Hacks that require special handling of IMAP tokens go here.
The most frustrating one for us was handling of message/mailbox flags that have format \<atom> as
in \Seen. The problem is that $\ is not an atom-char, so these flags are tokenized as #($\ 'Seen').
We make heuristical decision here if current token is $\ immediately followed by a letter. We will
then read next token and merge $\ and next token answering a string. This is ONLY applied inside a
parenthesized list"
(token == $\ and: [(self classificationMaskFor: self peek)
anyMask: AlphabeticMask])
ifTrue:
[self nextToken.
token := '\' , token.
tokenType := #string]!
scanAtom
"atom = 1*<any CHAR except atom-specials (which includes atomSpecials, space and CTLs)>"
token := self scanWhile: [(self isBracketSpecial: hereChar) not and: [self matchCharacterType: AtomMask]].
(token match: 'NIL')
ifTrue:
["RFC2060 defines NIL as a special atom type, atoms are not case-sensitive"
token := nil.
tokenType := #nil]
ifFalse: [tokenType := #atom].
^token!
scanLiteralText
"<{> nnn <}> <CRLF> <nnn bytes>"
| nbytes string |
nbytes := self scanLiteralTextLength.
string := self nextBytesAsString: nbytes.
token := string copyReplaceAll: (String with: Character cr with: Character nl) with: (String with: Character nl).
tokenType := #literalString.
^token!
scanLiteralTextLength
"<{> nnn <}> <CRLF>"
" We are positioned at the first brace character "
token := self scanToken: [ self matchCharacterType: DigitMask ] delimitedBy: '{}' notify: 'Malformed literal length'.
self upTo: Character nl.
^Integer readFrom: token readStream!
scanParenthesizedList
| stream |
stream := (Array new: 4) writeStream.
self mustMatch: $(notify: 'Parenthesized list should begin with ('.
self
deepTokenizeUntil: [ token == $) ]
do: [
self doSpecialScanProcessing.
stream nextPut: token
].
token ~~ $) ifTrue: [self notify: 'Non-terminated parenthesized list'].
token := stream contents.
tokenType := #parenthesizedList.
^token!
scanParenthesizedListAsAssociation
| stream |
stream := (Array new: 4) writeStream.
self mustMatch: $(notify: 'Parenthesized list should begin with ('.
self deepTokenizeAsAssociationUntil: [token == $)]
do: [:assoc | self doSpecialScanProcessing. stream nextPut: (tokenType->token)].
token ~~ $) ifTrue: [self notify: 'Non-terminated parenthesized list'].
token := stream contents.
tokenType := #parenthesizedList.
^tokenType->token!
scanQuotedChar
"Scan possible quoted character. If the current char is $\, read in next character and make it a quoted
string character"
^(hereChar == $\)
ifTrue:
[self step.
classificationMask := QuotedTextMask.
true]
ifFalse: [false]!
scanQuotedText
" quoted-string = <""> *(quoted_char / quoted-pair) <"">
quoted_char = <any CHAR except <""> and <\>"
" We are positioned at the first double quote character "
token := self scanToken: [ self scanQuotedChar; matchCharacterType: QuotedTextMask ] delimitedBy: '""' notify: 'Unmatched quoted text'.
tokenType := #quotedText.
^token!
scanText
"RFC822: text = <Any CHAR, including bare CR & bare LF, but not including CRLF. This is a 'catchall' category and cannot be tokenized. Text is used only to read values of unstructured fields"
^self
skipWhiteSpace;
scanWhile: [ (self matchCharacterType: CRLFMask) not ]! !
!IMAPScanner methodsFor: 'printing'!
printLiteralString: aString on: stream
self class printLiteralStringLength: aString on: stream.
self class printLiteralStringContents: aString on: stream! !
!IMAPScanner methodsFor: 'private'!
isBracketSpecial: char
^self flagBracketSpecial
and: [ '[]' includes: char ]!
nextBytesAsString: nbytes
| str |
^source isExternalStream
ifTrue: [
[self binary.
str := (source next: nbytes) asString.
self sourceTrailNextPutAll: str.
str]
ensure: [self text]]
ifFalse: [super next: nbytes]!
nextIMAPToken
| char |
self skipWhiteSpace.
char := self peek.
char isNil "end of input"
ifTrue: [tokenType := #doIt.
^token := nil].
char == $" ifTrue: [^self scanQuotedText].
char == ${ ifTrue: [^self scanLiteralText].
((char < Character space) or: [(self specials includes: char) or: [self isBracketSpecial: char]])
ifTrue: [
"Special character. Make it token value and set token type "
tokenType := #special.
token := self next.
^token
].
(self matchCharacterType: AtomMask)
ifTrue: [^self scanAtom].
tokenType := #doIt.
token := char.
^token! !
!IMAPScanner methodsFor: 'tokenization'!
deepNextToken
^(self nextToken == $( )
ifTrue: [
self
stepBack ;
scanParenthesizedList
]
ifFalse: [ token ]!
deepNextTokenAsAssociation
^self nextToken == $(
ifTrue: [self stepBack; scanParenthesizedListAsAssociation]
ifFalse: [tokenType->token]!
deepTokenize
| stream |
stream := (Array new: 4) writeStream.
[self deepNextToken.
tokenType = #doIt or: [token == Character cr or: [token == Character nl]]]
whileFalse: [stream nextPut: token].
token == Character cr ifTrue: [ self stepBack ].
token == Character nl ifTrue: [ self stepBack ].
^stream contents!
deepTokenizeAsAssociation
| stream assoc |
stream := (Array new: 4) writeStream.
[assoc := self deepNextTokenAsAssociation.
assoc key = #doIt]
whileFalse: [stream nextPut: assoc].
^stream contents!
deepTokenizeAsAssociationUntil: aBlock do: actionBlock
| assoc |
[self skipWhiteSpace.
assoc := self deepNextTokenAsAssociation.
assoc key = #doIt or: aBlock]
whileFalse: [actionBlock value: assoc]!
deepTokenizeUntil: aBlock do: actionBlock
[
self
skipWhiteSpace ;
deepNextToken.
(tokenType == #doIt) or: aBlock
] whileFalse: [ actionBlock value ]!
nextToken
^self nextIMAPToken!
specials
^self class atomSpecials! !
!IMAPDataResponseLSub class methodsFor: 'testing'!
canParse: cmdName
^'LSUB' = cmdName! !
IMAPCommand initialize!
IMAPScanner initialize!
Namespace current: Smalltalk!
|
