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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Netstream.html">
<link rel="next" href="Netmime.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of extensions" rel=Appendix href="index_extensions.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Unixqueue_pollset" rel="Chapter" href="Unixqueue_pollset.html">
<link title="Unixqueue_select" rel="Chapter" href="Unixqueue_select.html">
<link title="Uq_resolver" rel="Chapter" href="Uq_resolver.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_multiplex" rel="Chapter" href="Uq_multiplex.html">
<link title="Uq_transfer" rel="Chapter" href="Uq_transfer.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Uq_io" rel="Chapter" href="Uq_io.html">
<link title="Uq_lwt" rel="Chapter" href="Uq_lwt.html">
<link title="Uq_libevent" rel="Chapter" href="Uq_libevent.html">
<link title="Uq_mt" rel="Chapter" href="Uq_mt.html">
<link title="Uq_client" rel="Chapter" href="Uq_client.html">
<link title="Uq_server" rel="Chapter" href="Uq_server.html">
<link title="Uq_datagram" rel="Chapter" href="Uq_datagram.html">
<link title="Uq_engines_compat" rel="Chapter" href="Uq_engines_compat.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Equeue_howto" rel="Chapter" href="Equeue_howto.html">
<link title="Netcamlbox" rel="Chapter" href="Netcamlbox.html">
<link title="Netcgi_apache" rel="Chapter" href="Netcgi_apache.html">
<link title="Netcgi_modtpl" rel="Chapter" href="Netcgi_modtpl.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Nethttp_client_conncache" rel="Chapter" href="Nethttp_client_conncache.html">
<link title="Nethttp_client" rel="Chapter" href="Nethttp_client.html">
<link title="Nettelnet_client" rel="Chapter" href="Nettelnet_client.html">
<link title="Netftp_data_endpoint" rel="Chapter" href="Netftp_data_endpoint.html">
<link title="Netftp_client" rel="Chapter" href="Netftp_client.html">
<link title="Nethttp_fs" rel="Chapter" href="Nethttp_fs.html">
<link title="Netftp_fs" rel="Chapter" href="Netftp_fs.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Netldap" rel="Chapter" href="Netldap.html">
<link title="Netclient_tut" rel="Chapter" href="Netclient_tut.html">
<link title="Netgss_bindings" rel="Chapter" href="Netgss_bindings.html">
<link title="Netgss" rel="Chapter" href="Netgss.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_util" rel="Chapter" href="Nethttpd_util.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netmcore" rel="Chapter" href="Netmcore.html">
<link title="Netmcore_camlbox" rel="Chapter" href="Netmcore_camlbox.html">
<link title="Netmcore_mempool" rel="Chapter" href="Netmcore_mempool.html">
<link title="Netmcore_heap" rel="Chapter" href="Netmcore_heap.html">
<link title="Netmcore_ref" rel="Chapter" href="Netmcore_ref.html">
<link title="Netmcore_array" rel="Chapter" href="Netmcore_array.html">
<link title="Netmcore_sem" rel="Chapter" href="Netmcore_sem.html">
<link title="Netmcore_mutex" rel="Chapter" href="Netmcore_mutex.html">
<link title="Netmcore_condition" rel="Chapter" href="Netmcore_condition.html">
<link title="Netmcore_queue" rel="Chapter" href="Netmcore_queue.html">
<link title="Netmcore_buffer" rel="Chapter" href="Netmcore_buffer.html">
<link title="Netmcore_matrix" rel="Chapter" href="Netmcore_matrix.html">
<link title="Netmcore_hashtbl" rel="Chapter" href="Netmcore_hashtbl.html">
<link title="Netmcore_process" rel="Chapter" href="Netmcore_process.html">
<link title="Netmcore_tut" rel="Chapter" href="Netmcore_tut.html">
<link title="Netmcore_basics" rel="Chapter" href="Netmcore_basics.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_semaphore" rel="Chapter" href="Netplex_semaphore.html">
<link title="Netplex_sharedvar" rel="Chapter" href="Netplex_sharedvar.html">
<link title="Netplex_mutex" rel="Chapter" href="Netplex_mutex.html">
<link title="Netplex_encap" rel="Chapter" href="Netplex_encap.html">
<link title="Netplex_mbox" rel="Chapter" href="Netplex_mbox.html">
<link title="Netplex_internal" rel="Chapter" href="Netplex_internal.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netplex_advanced" rel="Chapter" href="Netplex_advanced.html">
<link title="Netplex_admin" rel="Chapter" href="Netplex_admin.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Netmime_string" rel="Chapter" href="Netmime_string.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netmime_header" rel="Chapter" href="Netmime_header.html">
<link title="Netmime_channels" rel="Chapter" href="Netmime_channels.html">
<link title="Neturl_ldap" rel="Chapter" href="Neturl_ldap.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netpagebuffer" rel="Chapter" href="Netpagebuffer.html">
<link title="Netfs" rel="Chapter" href="Netfs.html">
<link title="Netglob" rel="Chapter" href="Netglob.html">
<link title="Netauth" rel="Chapter" href="Netauth.html">
<link title="Netsockaddr" rel="Chapter" href="Netsockaddr.html">
<link title="Netnumber" rel="Chapter" href="Netnumber.html">
<link title="Netxdr_mstring" rel="Chapter" href="Netxdr_mstring.html">
<link title="Netxdr" rel="Chapter" href="Netxdr.html">
<link title="Netcompression" rel="Chapter" href="Netcompression.html">
<link title="Netunichar" rel="Chapter" href="Netunichar.html">
<link title="Netasn1" rel="Chapter" href="Netasn1.html">
<link title="Netasn1_encode" rel="Chapter" href="Netasn1_encode.html">
<link title="Netoid" rel="Chapter" href="Netoid.html">
<link title="Netstring_tstring" rel="Chapter" href="Netstring_tstring.html">
<link title="Netdn" rel="Chapter" href="Netdn.html">
<link title="Netx509" rel="Chapter" href="Netx509.html">
<link title="Netascii_armor" rel="Chapter" href="Netascii_armor.html">
<link title="Nettls_support" rel="Chapter" href="Nettls_support.html">
<link title="Netmech_scram" rel="Chapter" href="Netmech_scram.html">
<link title="Netmech_scram_gssapi" rel="Chapter" href="Netmech_scram_gssapi.html">
<link title="Netmech_scram_sasl" rel="Chapter" href="Netmech_scram_sasl.html">
<link title="Netmech_scram_http" rel="Chapter" href="Netmech_scram_http.html">
<link title="Netgssapi_support" rel="Chapter" href="Netgssapi_support.html">
<link title="Netgssapi_auth" rel="Chapter" href="Netgssapi_auth.html">
<link title="Netchannels_crypto" rel="Chapter" href="Netchannels_crypto.html">
<link title="Netx509_pubkey" rel="Chapter" href="Netx509_pubkey.html">
<link title="Netx509_pubkey_crypto" rel="Chapter" href="Netx509_pubkey_crypto.html">
<link title="Netsaslprep" rel="Chapter" href="Netsaslprep.html">
<link title="Netmech_plain_sasl" rel="Chapter" href="Netmech_plain_sasl.html">
<link title="Netmech_crammd5_sasl" rel="Chapter" href="Netmech_crammd5_sasl.html">
<link title="Netmech_digest_sasl" rel="Chapter" href="Netmech_digest_sasl.html">
<link title="Netmech_digest_http" rel="Chapter" href="Netmech_digest_http.html">
<link title="Netmech_krb5_sasl" rel="Chapter" href="Netmech_krb5_sasl.html">
<link title="Netmech_gs2_sasl" rel="Chapter" href="Netmech_gs2_sasl.html">
<link title="Netmech_spnego_http" rel="Chapter" href="Netmech_spnego_http.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netsys_posix" rel="Chapter" href="Netsys_posix.html">
<link title="Netsys_pollset" rel="Chapter" href="Netsys_pollset.html">
<link title="Netlog" rel="Chapter" href="Netlog.html">
<link title="Netexn" rel="Chapter" href="Netexn.html">
<link title="Netsys_win32" rel="Chapter" href="Netsys_win32.html">
<link title="Netsys_pollset_posix" rel="Chapter" href="Netsys_pollset_posix.html">
<link title="Netsys_pollset_win32" rel="Chapter" href="Netsys_pollset_win32.html">
<link title="Netsys_pollset_generic" rel="Chapter" href="Netsys_pollset_generic.html">
<link title="Netsys_signal" rel="Chapter" href="Netsys_signal.html">
<link title="Netsys_oothr" rel="Chapter" href="Netsys_oothr.html">
<link title="Netsys_xdr" rel="Chapter" href="Netsys_xdr.html">
<link title="Netsys_rng" rel="Chapter" href="Netsys_rng.html">
<link title="Netsys_crypto_types" rel="Chapter" href="Netsys_crypto_types.html">
<link title="Netsys_types" rel="Chapter" href="Netsys_types.html">
<link title="Netsys_mem" rel="Chapter" href="Netsys_mem.html">
<link title="Netsys_tmp" rel="Chapter" href="Netsys_tmp.html">
<link title="Netsys_sem" rel="Chapter" href="Netsys_sem.html">
<link title="Netsys_pmanage" rel="Chapter" href="Netsys_pmanage.html">
<link title="Netsys_crypto" rel="Chapter" href="Netsys_crypto.html">
<link title="Netsys_tls" rel="Chapter" href="Netsys_tls.html">
<link title="Netsys_ciphers" rel="Chapter" href="Netsys_ciphers.html">
<link title="Netsys_digests" rel="Chapter" href="Netsys_digests.html">
<link title="Netsys_crypto_modes" rel="Chapter" href="Netsys_crypto_modes.html">
<link title="Netsys_gssapi" rel="Chapter" href="Netsys_gssapi.html">
<link title="Netsys_sasl_types" rel="Chapter" href="Netsys_sasl_types.html">
<link title="Netsys_sasl" rel="Chapter" href="Netsys_sasl.html">
<link title="Netsys_polypipe" rel="Chapter" href="Netsys_polypipe.html">
<link title="Netsys_polysocket" rel="Chapter" href="Netsys_polysocket.html">
<link title="Netsys_global" rel="Chapter" href="Netsys_global.html">
<link title="Nettls_gnutls_bindings" rel="Chapter" href="Nettls_gnutls_bindings.html">
<link title="Nettls_nettle_bindings" rel="Chapter" href="Nettls_nettle_bindings.html">
<link title="Nettls_gnutls" rel="Chapter" href="Nettls_gnutls.html">
<link title="Netunidata" rel="Chapter" href="Netunidata.html">
<link title="Netgzip" rel="Chapter" href="Netgzip.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_util" rel="Chapter" href="Rpc_util.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_auth_gssapi" rel="Chapter" href="Rpc_auth_gssapi.html">
<link title="Rpc_proxy" rel="Chapter" href="Rpc_proxy.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_intro_gss" rel="Chapter" href="Rpc_intro_gss.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_fs" rel="Chapter" href="Shell_fs.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Intro" rel="Chapter" href="Intro.html">
<link title="Platform" rel="Chapter" href="Platform.html">
<link title="Foreword" rel="Chapter" href="Foreword.html">
<link title="Ipv6" rel="Chapter" href="Ipv6.html">
<link title="Regexp" rel="Chapter" href="Regexp.html">
<link title="Tls" rel="Chapter" href="Tls.html">
<link title="Crypto" rel="Chapter" href="Crypto.html">
<link title="Authentication" rel="Chapter" href="Authentication.html">
<link title="Credentials" rel="Chapter" href="Credentials.html">
<link title="Gssapi" rel="Chapter" href="Gssapi.html">
<link title="Ocamlnet4" rel="Chapter" href="Ocamlnet4.html">
<link title="Get" rel="Chapter" href="Get.html"><link title="Splitting a string into lines" rel="Section" href="#lines">
<link title="Parsing and Printing Mail Headers" rel="Section" href="#headers">
<link title="Parsing Structured Values" rel="Section" href="#structured_values">
<link title="Parsing Certain Forms of Structured Values" rel="Section" href="#parsers_for_structured_values">
<link title="Printing Structured Values" rel="Section" href="#printers_for_structured_values">
<link title="Scanning MIME Messages" rel="Section" href="#scanning_mime">
<link title="Helpers for MIME Messages" rel="Section" href="#helpers_mime">
<title>Ocamlnet 4 Reference Manual : Netmime_string</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Netstream.html" title="Netstream">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Netmime.html" title="Netmime">Next</a>
</div>
<h1>Module <a href="type_Netmime_string.html">Netmime_string</a></h1>
<pre><span id="MODULENetmime_string"><span class="keyword">module</span> Netmime_string</span>: <code class="code">sig</code> <a href="Netmime_string.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="info-desc">
<p>Low-level functions to parse and print mail and MIME messages</p>
<p><code class="code">Netmime_string</code> contains a lot of functions to scan and print strings
formatted as MIME messages. For a higher-level view on this topic,
see the <code class="code">Netmime</code> module.</p>
<p><b>Contents</b></p>
<ul>
<li><a href="Netmime_string.html#lines"><i>Splitting a string into lines</i></a></li>
<li><a href="Netmime_string.html#headers"><i>Parsing and Printing Mail Headers</i></a></li>
<li><a href="Netmime_string.html#structured_values"><i>Parsing Structured Values</i></a></li>
<li><a href="Netmime_string.html#parsers_for_structured_values"><i>Parsing Certain Forms of Structured Values</i></a></li>
<li><a href="Netmime_string.html#printers_for_structured_values"><i>Printing Structured Values</i></a></li>
<li><a href="Netmime_string.html#scanning_mime"><i>Scanning MIME Messages</i></a></li>
<li><a href="Netmime_string.html#helpers_mime"><i>Helpers for MIME Messages</i></a>
</li>
</ul>
</div>
</div>
<hr width="100%">
<h2 id="lines">Splitting a string into lines</h2><p>These functions are all CR/LF-aware, i.e. lines can be terminated
by either LF or CR/LF.</p>
<pre><span id="VALfind_line_end"><span class="keyword">val</span> find_line_end</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">find_line_end s pos len</code>: Searches the next line end (CR/LF or
only LF), and returns the position. The search starts at position
<code class="code">pos</code>, and covers the next <code class="code">len</code> bytes. Raises <code class="code">Not_found</code>
if there is no line end.</p>
</div>
</div>
<pre><span id="VALfind_line_end_poly"><span class="keyword">val</span> find_line_end_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p>polymorphic version</p>
</div>
</div>
<pre><span id="VALfind_line_start"><span class="keyword">val</span> find_line_start</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">find_line_start s pos len</code>: Searches the next start, and returns its
position. The line start is the position after the next line end
(CR/LF or only LF). The search starts at position
<code class="code">pos</code>, and covers the next <code class="code">len</code> bytes. Raises <code class="code">Not_found</code>
if there is no line end.</p>
</div>
</div>
<pre><span id="VALfind_line_start_poly"><span class="keyword">val</span> find_line_start_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p>polymorphic version</p>
</div>
</div>
<pre><span id="VALfind_double_line_start"><span class="keyword">val</span> find_double_line_start</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">find_double_line_start s pos len</code>: Searches two adjacent line ends
(each may be a CR/LF combination or a single LF), and returns the
position after the second line end. The search starts at position
<code class="code">pos</code>, and covers the next <code class="code">len</code> bytes. Raises <code class="code">Not_found</code>
if the mentioned pattern is not found.</p>
</div>
</div>
<pre><span id="VALfind_double_line_start_poly"><span class="keyword">val</span> find_double_line_start_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p>polymorphic version</p>
</div>
</div>
<pre><span id="VALskip_line_ends"><span class="keyword">val</span> skip_line_ends</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">skip_line_ends s pos len</code>: Skips over adjacent line ends (terminated
by CR/LF or plain LF), and returns the position after the last
line end. The search starts at position
<code class="code">pos</code>, and covers the next <code class="code">len</code> bytes. Note that this function
cannot raise <code class="code">Not_found</code>.</p>
</div>
</div>
<pre><span id="VALskip_line_ends_poly"><span class="keyword">val</span> skip_line_ends_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p>polymorphic version</p>
</div>
</div>
<pre><span id="VALfold_lines_p"><span class="keyword">val</span> fold_lines_p</span> : <code class="type">('a -> int -> int -> int -> bool -> 'a) -> 'a -> string -> int -> int -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">fold_lines_p f acc0 s pos len</code>: Splits the substring of <code class="code">s</code>
from <code class="code">pos</code>
to <code class="code">pos+len</code> into lines, and folds over these lines like
<code class="code">List.fold_left</code>. The function <code class="code">f</code> is called as
<code class="code">f acc p0 p1 p2 is_last</code> where <code class="code">acc</code> is the current accumulator
(initialized with <code class="code">acc0</code>), and</p>
<ul>
<li><code class="code">p0</code> is the start position of the line in <code class="code">s</code></li>
<li><code class="code">p1</code> is the position of the line terminator in <code class="code">s</code></li>
<li><code class="code">p2</code> is the position after the line terminator in <code class="code">s</code></li>
<li><code class="code">is_last</code> is true if this is the last line in the iteration</li>
</ul>
<p>The lines can be terminated with CR/LF or LF. For the last line
the terminator is optional (<code class="code">p1=p2</code> is possible).</p>
<p>The function is tail-recursive.</p>
</div>
</div>
<pre><span id="VALfold_lines_p_poly"><span class="keyword">val</span> fold_lines_p_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -><br> ('a -> int -> int -> int -> bool -> 'a) -> 'a -> 's -> int -> int -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p>even more polymorphic</p>
</div>
</div>
<pre><span id="VALfold_lines"><span class="keyword">val</span> fold_lines</span> : <code class="type">('a -> string -> 'a) -> 'a -> string -> int -> int -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">fold_lines f acc0 s pos len</code>: Splits the substring of <code class="code">s</code>
from <code class="code">pos</code>
to <code class="code">pos+len</code> into lines, and folds over these lines like
<code class="code">List.fold_left</code>. The function <code class="code">f</code> is called as
<code class="code">f acc line</code> where <code class="code">acc</code> is the current accumulator
(initialized with <code class="code">acc0</code>), and <code class="code">line</code> is the current line
w/o terminator.</p>
<p>The lines can be terminated with CR/LF or LF.</p>
<p>The function is tail-recursive.</p>
<p>Example: Get the lines as list:</p>
<pre class="codepre"><code class="code"> List.rev(fold_lines (fun l acc -> acc::l) [] s pos len)
</code></pre></div>
</div>
<pre><span id="VALfold_lines_poly"><span class="keyword">val</span> fold_lines_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -><br> ('a -> 's -> 'a) -> 'a -> 's -> int -> int -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p>even more polymorphic</p>
</div>
</div>
<pre><span id="VALiter_lines"><span class="keyword">val</span> iter_lines</span> : <code class="type">(string -> unit) -> string -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">iter_lines f s pos len</code>: Splits the substring of <code class="code">s</code>
from <code class="code">pos</code>
to <code class="code">pos+len</code> into lines, and calls <code class="code">f line</code> for each
line.</p>
<p>The lines can be terminated with CR/LF or LF.</p>
</div>
</div>
<pre><span id="VALiter_lines_poly"><span class="keyword">val</span> iter_lines_poly</span> : <code class="type">'s <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> ('s -> unit) -> 's -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>even more polymorphic</p>
</div>
</div>
<pre><span id="VALskip_whitespace_left"><span class="keyword">val</span> skip_whitespace_left</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">skip_whitespace_left s pos len</code>: Returns the smallest
<code class="code">p</code> with <code class="code">p >= pos && p < pos+len</code> so that <code class="code">s.[p]</code> is not
a whitesapce character (space, TAB, CR, LF), and
<code class="code">s.[q]</code> is a whitespace character for all <code class="code">q<p</code>.
If this is not possible <code class="code">Not_found</code> will be raised.</p>
</div>
</div>
<pre><span id="VALskip_whitespace_right"><span class="keyword">val</span> skip_whitespace_right</span> : <code class="type">string -> int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">skip_whitespace_right s pos len</code>: Returns the biggest
<code class="code">p</code> with <code class="code">p >= pos && p < pos+len</code> so that <code class="code">s.[p]</code> is not
a whitesapce character (space, TAB, CR, LF), and
<code class="code">s.[q]</code> is a whitespace character for all <code class="code">q>p</code>.
If this is not possible <code class="code">Not_found</code> will be raised.</p>
</div>
</div>
<h2 id="headers">Parsing and Printing Mail Headers</h2><p><b>The Format of Mail Messages</b></p>
<p>Messages
consist of a header and a body; the first empty line separates both
parts. The header contains lines "<i>param-name</i><code class="code">:</code> <i>param-value</i>" where
the param-name must begin on column 0 of the line, and the "<code class="code">:</code>"
separates the name and the value. So the format is roughly:</p>
<pre class="codepre"><code class="code"> param1-name: param1-value
...
paramN-name: paramN-value
_
body </code></pre>
<p>(Where "_" denotes an empty line.)</p>
<p><b>Details</b></p>
<p>Note that parameter values are restricted; you cannot represent
arbitrary strings. The following problems can arise:</p>
<ul>
<li>Values cannot begin with whitespace characters, because there
may be an arbitrary number of whitespaces between the "<code class="code">:</code>" and the
value.</li>
<li>Values (and names of parameters, too) must only be formed of
7 bit ASCII characters. (If this is not enough, the MIME standard
knows the extension RFC 2047 that allows that header values may
be composed of arbitrary characters of arbitrary character sets.
See below how to decode such characters in values returned by
this function.)</li>
<li>Header values may be broken into several lines. Continuation
lines must begin with whitespace characters. This means that values
must not contain line breaks as semantic part of the value.
And it may mean that <i>one</i> whitespace character is not distinguishable
from <i>several</i> whitespace characters.</li>
<li>Header lines must not be longer than 78 characters (soft limit) or
998 characters (hard limit). Values that
would result into longer lines must be broken into several lines.
This means that you cannot represent strings that contain too few
whitespace characters.
(Note: The soft limit is to avoid that user agents have problems
with long lines. The hard limit means that transfer agents sometimes
do not transfer longer lines correctly.)</li>
<li>Some old gateways pad the lines with spaces at the end of the lines.</li>
</ul>
<p>This implementation of a mail scanner tolerates a number of
deviations from the standard: long lines are not rejected; 8 bit
values are generally accepted; lines may be ended only with LF instead of
CRLF.</p>
<p><b>Compatibility</b></p>
<p>These functions can parse all mail headers that conform to RFC 822 or
RFC 2822.</p>
<p>But there may be still problems, as RFC 822 allows some crazy
representations that are actually not used in practice.
In particular, RFC 822 allows it to use backslashes to "indicate"
that a CRLF sequence is semantically meant as line break. As this
function normally deletes CRLFs, it is not possible to recognize such
indicators in the result of the function.</p>
<pre><span id="VALfold_header"><span class="keyword">val</span> fold_header</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -><br> ?strip:bool -><br> ('a -> string -> string -> 'a) -> 'a -> string -> int -> int -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">fold_header f acc0 s pos len</code>:
Parses a MIME header in the string <code class="code">s</code> from <code class="code">pos</code> to exactly
<code class="code">pos+len</code>. The MIME header must be terminated by an empty line.</p>
<p>A folding operation is done over the header values while
the lines are extracted from the string, very much like
<code class="code">List.fold_left</code>. For each header <code class="code">(n,v)</code> where <code class="code">n</code> is the
name and <code class="code">v</code> is the value, the function <code class="code">f</code> is called as
<code class="code">f acc n v</code>.</p>
<p>If the header cannot be parsed, a <code class="code">Failure</code> is raised.</p>
<p>Certain transformations may be applied (default: no
transformations):</p>
<ul>
<li>If <code class="code">downcase</code> is set, the header names are converted to
lowercase characters</li>
<li>If <code class="code">unfold</code> is set, the line terminators are not included
in the resulting values. This covers both the end of line
characters at the very end of a header and the end of line
characters introduced by continuation lines.</li>
<li>If <code class="code">strip</code> is set, preceding and trailing white space is
removed from the value (including line terminators at the
very end of the value)</li>
</ul>
</div>
</div>
<pre><span id="VALlist_header"><span class="keyword">val</span> list_header</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -> ?strip:bool -> string -> int -> int -> (string * string) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">list_header s pos len</code>: Returns the headers as list of pairs
<code class="code">(name,value)</code>.</p>
<p>For the meaning of the arguments see <code class="code">fold_header</code> above.</p>
</div>
</div>
<pre><span id="VALscan_header"><span class="keyword">val</span> scan_header</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -><br> ?strip:bool -><br> string -> start_pos:int -> end_pos:int -> (string * string) list * int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let params, header_end_pos = scan_header s start_pos end_pos</code>:</p>
<p><b>Deprecated.</b></p>
<p>Scans the mail header that begins at position <code class="code">start_pos</code> in the string
<code class="code">s</code> and that must end somewhere before position <code class="code">end_pos</code>. It is intended
that in <code class="code">end_pos</code> the character position following the end of the body of
the MIME message is passed.</p>
<p>Returns the parameters of the header as <code class="code">(name,value)</code> pairs (in
<code class="code">params</code>), and in <code class="code">header_end_pos</code> the position of the character following
directly after the header (i.e. after the blank line separating
the header from the body).</p>
<ul>
<li>If <code class="code">downcase</code>, header names are converted to lowercase characters</li>
<li>The arguments <code class="code">unfold</code> and <code class="code">strip</code> have a slightly different meaning as
for the new function <code class="code">fold_header</code> above. In particular, whitespace
is already stripped off the returned values if <b>any</b> of <code class="code">unfold</code> or
<code class="code">strip</code> are enabled. (This is for backward compatibility.)</li>
</ul>
<p>Also, this function is different because <code class="code">downcase</code> and <code class="code">unfold</code> are
enabled by default, and only <code class="code">strip</code> is not enabled.</p>
</div>
</div>
<pre><span id="VALscan_header_tstring"><span class="keyword">val</span> scan_header_tstring</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -><br> ?strip:bool -><br> <a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a> -><br> start_pos:int -> end_pos:int -> (string * string) list * int</code></pre><div class="info ">
<div class="info-desc">
<p>The same for tagged strings</p>
</div>
</div>
<pre><span id="VALscan_header_poly"><span class="keyword">val</span> scan_header_poly</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -><br> ?strip:bool -><br> 's <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -><br> 's -> start_pos:int -> end_pos:int -> (string * string) list * int</code></pre><div class="info ">
<div class="info-desc">
<p>Polymorphic version</p>
</div>
</div>
<pre><span id="VALread_header"><span class="keyword">val</span> read_header</span> : <code class="type">?downcase:bool -><br> ?unfold:bool -><br> ?strip:bool -> <a href="Netstream.in_obj_stream-c.html">Netstream.in_obj_stream</a> -> (string * string) list</code></pre><div class="info ">
<div class="info-desc">
<p>This function expects that the current position of the passed
<code class="code">in_obj_stream</code> is the first byte of the header. The function scans the
header and returns it. After that, the stream position is after
the header and the terminating empty line (i.e. at the beginning of
the message body).</p>
<p>The options <code class="code">downcase</code>, <code class="code">unfold</code>, and <code class="code">strip</code> have the same meaning
as in <code class="code">scan_header</code>.</p>
<p><b>Example</b></p>
<p>To read the mail message "<code class="code">file.txt</code>":</p>
<pre class="codepre"><code class="code"> let ch = new Netchannels.input_channel (open_in "file.txt") in
let stream = new Netstream.input_stream ch in
let header = read_header stream in
stream#close_in() (* no need to close ch *)
</code></pre></div>
</div>
<pre><span id="VALwrite_header"><span class="keyword">val</span> write_header</span> : <code class="type">?soft_eol:string -><br> ?eol:string -> <a href="Netchannels.out_obj_channel-c.html">Netchannels.out_obj_channel</a> -> (string * string) list -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>This function writes the header to the passed <code class="code">out_obj_channel</code>. The
empty line following the header is also written.</p>
<p>Exact output format:</p>
<ul>
<li>The header is not folded, i.e. no additional CRLF sequences
are inserted into the header to avoid long header lines.
In order to produce correct headers, the necessary CRLF bytes
must already exist in the field values. (You can use the
function <code class="code">write_value</code> below for this.)</li>
<li>However, this function helps getting some details right. First,
whitespace at the beginning of field values is suppressed.
<b>Example:</b>
<code class="code">write_header ch ["x","Field value"; "y"," Other value"]</code> outputs:
<pre class="codepre"><code class="code"> x: Field value\r\n
y: Other value\r\n
\r\n</code></pre></li>
<li>The end-of-line sequences LF, and CRLF, followed by
whitespace are replaced by the passed <code class="code">soft_eol</code> string. If the
necessary space or tab character following the eol is missing, an
additional space character will be inserted.
<b>Example:</b>
<code class="code">write_header ch ["x","Field\nvalue"; "y","Other\r\n\tvalue"]</code> outputs:
<pre class="codepre"><code class="code"> x: Field\r\n
value
y: Other\r\n
\tvalue</code></pre></li>
<li>Empty lines (and lines only consisting of whitespace) are suppressed
if they occur inside the header.
<b>Example:</b>
<code class="code">write_header ch ["x","Field\n\nvalue"]</code> outputs:
<pre class="codepre"><code class="code"> x: Field\r\n
value</code></pre></li>
<li>Whitespace at the end of a header field is suppressed. One field
is separated from the next field by printing <code class="code">eol</code> once.</li>
</ul>
<p>These rules ensure that the printed header will be well-formed with
two exceptions:</p>
<ul>
<li>Long lines (> 72 characters) are neither folded nor rejected</li>
<li>True 8 bit characters are neither properly encoded nor rejected</li>
</ul>
<p>These two problems cannot be addressed without taking the syntax
of the header fields into account. See below how to create
proper header fields from <code class="code">s_token</code> lists.</p>
</div>
</div>
<h2 id="structured_values">Parsing Structured Values</h2><p>The following types and functions allow it to build scanners for
structured mail and MIME values in a highly configurable way.</p>
<p><b>Structured Values</b></p>
<p>RFC 822 (together with some other RFCs) defines lexical rules
how formal mail header values should be divided up into tokens. Formal
mail headers are those headers that are formed according to some
grammar, e.g. mail addresses or MIME types.</p>
<p>Some of the characters separate phrases of the value; these are
the "special" characters. For example, '@' is normally a special
character for mail addresses, because it separates the user name
from the domain name (as in <code class="code">user@domain</code>). RFC 822 defines a fixed set
of special
characters, but other RFCs use different sets. Because of this,
the following functions allow it to configure the set of special characters.</p>
<p>Every sequence of characters may be embraced by double quotes,
which means that the sequence is meant as literal data item;
special characters are not recognized inside a quoted string. You may
use the backslash to insert any character (including double quotes)
verbatim into the quoted string (e.g. "He said: \"Give it to me!\"").
The sequence of a backslash character and another character is called
a quoted pair.</p>
<p>Structured values may contain comments. The beginning of a comment
is indicated by '(', and the end by ')'. Comments may be nested.
Comments may contain quoted pairs. A
comment counts as if a space character were written instead of it.</p>
<p>Control characters are the ASCII characters 0 to 31, and 127.
RFC 822 demands that mail headers are 7 bit ASCII strings. Because
of this, this module also counts the characters 128 to 255 as
control characters.</p>
<p>Domain literals are strings embraced by '[' and ']'; such literals
may contain quoted pairs. Today, domain literals are used to specify
IP addresses (rare), e.g. <code class="code">user@[192.168.0.44]</code>.</p>
<p>Every character sequence not falling in one of the above categories
is an atom (a sequence of non-special and non-control characters).
When recognized, atoms may be encoded in a character set different than
US-ASCII; such atoms are called encoded words (see RFC 2047).</p>
<p><b>Scanning Using the Extended Interface</b></p>
<p>In order to scan a string containing a structured value, you must first
create a <code class="code">mime_scanner</code> using the function <code class="code">create_mime_scanner</code>.
The scanner contains the reference to the scanned string, and a
specification how the string is to be scanned. The specification
consists of the lists <code class="code">specials</code> and <code class="code">scan_options</code>.</p>
<p>The character list <code class="code">specials</code> specifies the set of special characters.
These are the characters that are not regarded as part of atoms,
because they work as delimiters that separate atoms (like <code class="code">@</code> in the
above example). In addition to this, when '"', '(', and '[' are
seen as regular characters not delimiting quoted string, comments, and
domain literals, respectively, these characters must also be added
to <code class="code">specials</code>. In detail, these rules apply:</p>
<ul>
<li><b>Spaces:</b><ul>
<li>If <code class="code">' '</code> <i>in</i> <code class="code">specials</code>: A space character is returned as <code class="code">Special ' '</code>.
Note that there may also be an effect on how comments are returned
(see below).</li>
<li>If <code class="code">' '</code> <i>not in</i> <code class="code">specials</code>: Spaces are not returned, although
they still delimit atoms.</li>
</ul>
</li>
<li><b>Tabs, CRs, LFs:</b><ul>
<li>If <code class="code">'\t'</code> <i>in</i> <code class="code">specials</code>: A tab character is returned as
<code class="code">Special '\t'</code>.</li>
<li>If <code class="code">'\t'</code> <i>not in</i> <code class="code">specials</code>: Tabs are not returned, although
they still delimit atoms.</li>
<li>If <code class="code">'\r'</code> <i>in</i> <code class="code">specials</code>: A CR character is returned as
<code class="code">Special '\r'</code>.</li>
<li>If <code class="code">'\r'</code> <i>not in</i> <code class="code">specials</code>: CRs are not returned, although
they still delimit atoms.</li>
<li>If <code class="code">'\n'</code> <i>in</i> <code class="code">specials</code>: A LF character is returned as
<code class="code">Special '\n'</code>.</li>
<li>If <code class="code">'\n'</code> <i>not in</i> <code class="code">specials</code>: LFs are not returned, although
they still delimit atoms.</li>
</ul>
</li>
<li><b>Comments:</b>
<ul>
<li>If <code class="code">'('</code> <i>in</i> <code class="code">specials</code>: Comments are not recognized. The
character '(' is returned as <code class="code">Special '('</code>.</li>
<li>If <code class="code">'('</code> <i>not in</i> <code class="code">specials</code>: Comments are recognized. How comments
are returned, depends on the following:<OL>
<li>If <code class="code">Return_comments</code> <i>in</i> <code class="code">scan_options</code>: Outer comments are
returned as <code class="code">Comment</code> (note that inner comments are recognized but
are not returned as tokens)</li>
<li>If otherwise <code class="code">' '</code> <i>in</i> <code class="code">specials</code>: Outer comments are returned as
<code class="code">Special ' '</code></li>
<li>Otherwise: Comments are recognized but not returned at all.</li>
</OL>
</li>
</ul>
</li>
<li><b>Quoted strings:</b><ul>
<li>If <code class="code">'"'</code> <i>in</i> <code class="code">specials</code>: Quoted strings are not recognized, and
double quotes are returned as <code class="code">Special '"'</code>.</li>
<li>If <code class="code">'"'</code> <i>not in</i> <code class="code">specials</code>: Quoted strings are returned as
<code class="code">QString</code> tokens.</li>
</ul>
</li>
<li><b>Domain literals:</b>
<ul>
<li>If '[' <i>in</i> <code class="code">specials</code>: Domain literals are not recognized, and
left brackets are returned as <code class="code">Special</code> '['.</li>
<li>If '[' <i>not in</i> <code class="code">specials</code>: Domain literals are returned as
<code class="code">DomainLiteral</code> tokens.</li>
</ul>
</li>
</ul>
<p>If recognized, quoted strings are returned as <code class="code">QString s</code>, where
<code class="code">s</code> is the string without the embracing quotes, and with already
decoded quoted pairs.</p>
<p>Control characters <code class="code">c</code> are returned as <code class="code">Control c</code>.</p>
<p>If recognized, comments may either be returned as spaces (in the case
you are not interested in the contents of comments), or as <code class="code">Comment</code> tokens.
The contents of comments are not further scanned; you must start a
subscanner to analyze comments as structured values.</p>
<p>If recognized, domain literals are returned as <code class="code">DomainLiteral s</code>, where
<code class="code">s</code> is the literal without brackets, and with decoded quoted pairs.</p>
<p>Atoms are returned as <code class="code">Atom s</code> where <code class="code">s</code> is a longest sequence of
atomic characters (all characters which are neither special nor control
characters nor delimiters for substructures). If the option
<code class="code">Recognize_encoded_words</code> is on, atoms which look like encoded words
are returned as <code class="code">EncodedWord</code> tokens. (Important note: Neither '?' nor
'=' must be special in order to enable this functionality.)</p>
<p>After the <code class="code">mime_scanner</code> has been created, you can scan the tokens by
invoking <code class="code">scan_token</code> which returns one token at a time, or by invoking
<code class="code">scan_token_list</code> which returns all following tokens.</p>
<p>There are two token types: <code class="code">s_token</code> is the base type and is intended to
be used for pattern matching. <code class="code">s_extended_token</code> is a wrapper that
additionally contains information where the token occurs.</p>
<p><b>Scanning Using the Simple Interface</b></p>
<p>Instead of creating a <code class="code">mime_scanner</code> and calling the scan functions,
you may also invoke <code class="code">scan_structured_value</code>. This function returns the
list of tokens directly; however, it is restricted to <code class="code">s_token</code>.</p>
<p><b>Examples</b></p>
<ul>
<li>Simple address: <pre class="codepre"><code class="code"> scan_structured_value "user@domain.com" [ '@'; '.' ] []
= [ Atom "user"; Special '@'; Atom "domain"; Special '.'; Atom "com" ]
</code></pre></li>
<li>Spaces are not returned: <pre class="codepre"><code class="code"> scan_structured_value "user @ domain . com" [ '@'; '.' ] []
= [ Atom "user"; Special '@'; Atom "domain"; Special '.'; Atom "com" ]
</code></pre></li>
<li>Comments are not returned: <pre class="codepre"><code class="code"> scan_structured_value "user(Do you know him?)@domain.com" [ '@'; '.' ] []
= [ Atom "user"; Special '@'; Atom "domain"; Special '.'; Atom "com" ]
</code></pre></li>
<li>Comments are indicated if requested: <pre class="codepre"><code class="code"> scan_structured_value "user(Do you know him?)@domain.com" [ '@'; '.' ]
[ Return_comments ]
= [ Atom "user"; Comment; Special '@'; Atom "domain"; Special '.';
Atom "com" ]
</code></pre></li>
<li>Spaces are returned if special: <pre class="codepre"><code class="code"> scan_structured_value "user (Do you know him?) @ domain . com"
[ '@'; '.'; ' ' ] []
= [ Atom "user"; Special ' '; Special ' '; Special ' '; Special '@';
Special ' '; Atom "domain";
Special ' '; Special '.'; Special ' '; Atom "com" ]
</code></pre></li>
<li>Both spaces and comments are requested: <pre class="codepre"><code class="code"> scan_structured_value "user (Do you know him?) @ domain . com"
[ '@'; '.'; ' ' ] [ Return_comments ]
= [ Atom "user"; Special ' '; Comment; Special ' '; Special '@';
Special ' '; Atom "domain";
Special ' '; Special '.'; Special ' '; Atom "com" ]
</code></pre></li>
<li>Another case: <pre class="codepre"><code class="code"> scan_structured_value "user @ domain . com" [ '@'; '.'; ' ' ] []
= [ Atom "user"; Special ' '; Special '@'; Special ' '; Atom "domain";
Special ' '; Special '.'; Special ' '; Atom "com" ]
</code></pre></li>
<li>'(' is special: <pre class="codepre"><code class="code"> scan_structured_value "user(Do you know him?)@domain.com" ['@'; '.'; '(']
[]
= [ Atom "user"; Special '('; Atom "Do"; Atom "you"; Atom "know";
Atom "him?)"; Special '@'; Atom "domain"; Special '.'; Atom "com" ]
</code></pre></li>
<li>Quoted strings: <pre class="codepre"><code class="code"> scan_structured_value "\"My.name\"@domain.com" [ '@'; '.' ] []
= [ QString "My.name"; Special '@'; Atom "domain"; Special '.';
Atom "com" ]
</code></pre></li>
<li>Encoded words are not returned: <pre class="codepre"><code class="code"> scan_structured_value "=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?="
[ ] [ ]
= [ Atom "=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?=" ]
</code></pre></li>
<li>Encoded words are returned if requested: <pre class="codepre"><code class="code"> scan_structured_value "=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?="
[ ] [ Recognize_encoded_words ]
= [ EncodedWord(("ISO-8859-1",""), "Q", "Keld_J=F8rn_Simonsen") ]
</code></pre></li>
</ul>
<pre><code><span id="TYPEs_token"><span class="keyword">type</span> <code class="type"></code>s_token</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.Atom"><span class="constructor">Atom</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.EncodedWord"><span class="constructor">EncodedWord</span></span> <span class="keyword">of</span> <code class="type">((string * string) * string * string)</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
<div class="info-desc">
<p>Args: <code class="code">((charset,lang),encoding,encoded_word)</code></p>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.QString"><span class="constructor">QString</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.Control"><span class="constructor">Control</span></span> <span class="keyword">of</span> <code class="type">char</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.Special"><span class="constructor">Special</span></span> <span class="keyword">of</span> <code class="type">char</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.DomainLiteral"><span class="constructor">DomainLiteral</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.Comment"><span class="constructor">Comment</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_token.End"><span class="constructor">End</span></span></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>A token may be one of:</p>
<ul>
<li><code class="code">QString s</code>: The quoted string <code class="code">s</code>, i.e a string between double
quotes. Quoted pairs are already decoded in <code class="code">s</code>.</li>
<li><code class="code">Control c</code>: The control character <code class="code">c</code> (0-31, 127, 128-255)</li>
<li><code class="code">Special c</code>: The special character <code class="code">c</code>, i.e. a character from
the <code class="code">specials</code> list</li>
<li><code class="code">DomainLiteral s</code>: The bracketed string <code class="code">s</code>, i.e. a string between
brackets. Quoted pairs are already decoded in <code class="code">s</code>.</li>
<li><code class="code">Comment</code>: A string between parentheses. This kind of token is only
generated when the option <code class="code">Return_comments</code> is in effect.</li>
<li><code class="code">EncodedWord((charset,lang),encoding,encoded_word)</code>: An RFC-2047 style
encoded word: <code class="code">charset</code> is the name of the character set; <code class="code">lang</code> is
the language specifier (from RFC 2231) or ""; <code class="code">encoding</code> is either
"Q" or "B"; and <code class="code">encoded_word</code> is the word encoded in <code class="code">charset</code> and
<code class="code">encoding</code>. This kind of token is only generated when the option
<code class="code">Recognize_encoded_words</code> is in effect (if not, <code class="code">Atom</code> is generated
instead).</li>
<li><code class="code">Atom s</code>: A string which is neither quoted not bracketed nor
written in RFC 2047 notation, and which is not a control or special
character, i.e. the "rest"</li>
<li><code class="code">End</code>: The end of the string</li>
</ul>
</div>
</div>
<pre><code><span id="TYPEs_option"><span class="keyword">type</span> <code class="type"></code>s_option</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_option.No_backslash_escaping"><span class="constructor">No_backslash_escaping</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
<div class="info-desc">
<p>Do not handle backslashes in quoted string and comments as escape
characters; backslashes are handled as normal characters.
For example: The wrong qstring <code class="code">"C:\dir\file"</code> will be returned as
<code class="code">QString "C:\dir\file"</code> when this option is in effect, and not as
<code class="code">QString "C:dirfile"</code> as by default.
-- This is a common error in many MIME implementations.</p>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_option.Return_comments"><span class="constructor">Return_comments</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
<div class="info-desc">
<p>Comments are returned as token <code class="code">Comment</code> (unless '(' is included
in the list of special characters, in which case comments are
not recognized at all).
You may get the exact location of the comment by applying
<code class="code">get_pos</code> and <code class="code">get_length</code> to the extended token.</p>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTs_option.Recognize_encoded_words"><span class="constructor">Recognize_encoded_words</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
<div class="info-desc">
<p>Enables that encoded words are recognized and returned as
<code class="code">EncodedWord</code> instead of <code class="code">Atom</code>.</p>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<pre><span id="TYPEs_extended_token"><span class="keyword">type</span> <code class="type"></code>s_extended_token</span> </pre>
<div class="info ">
<div class="info-desc">
<p>An opaque type containing the information of <code class="code">s_token</code> plus:</p>
<ul>
<li>where the token occurs</li>
<li>RFC-2047 access functions</li>
</ul>
</div>
</div>
<pre><span id="VALget_token"><span class="keyword">val</span> get_token</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> <a href="Netmime_string.html#TYPEs_token">s_token</a></code></pre><div class="info ">
<div class="info-desc">
<p>Return the <code class="code">s_token</code> within the <code class="code">s_extended_token</code></p>
</div>
</div>
<pre><span id="VALget_decoded_word"><span class="keyword">val</span> get_decoded_word</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> string</code></pre>
<pre><span id="VALget_charset"><span class="keyword">val</span> get_charset</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Return the decoded word (the contents of the word after decoding the
"Q" or "B" representation), and the character set of the decoded word
(uppercase).</p>
<p>These functions not only work for <code class="code">EncodedWord</code>. The function
<code class="code">get_decoded_word</code> returns for the other kinds of token:</p>
<ul>
<li><code class="code">Atom</code>: Returns the atom without decoding it</li>
<li><code class="code">QString</code>: Returns the characters inside the double quotes, and
ensures that any quoted pairs are decoded</li>
<li><code class="code">Control</code>: Returns the one-character string</li>
<li><code class="code">Special</code>: Returns the one-character string</li>
<li><code class="code">DomainLiteral</code>: Returns the characters inside the brackets, and
ensures that any quoted pairs are decoded</li>
<li><code class="code">Comment</code>: Returns <code class="code">""</code></li>
</ul>
<p>The function <code class="code">get_charset</code> returns <code class="code">"US-ASCII"</code> for them.</p>
</div>
</div>
<pre><span id="VALget_language"><span class="keyword">val</span> get_language</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the language if the token is an <code class="code">EncodedWord</code>, and <code class="code">""</code> for
all other tokens.</p>
</div>
</div>
<pre><span id="VALget_pos"><span class="keyword">val</span> get_pos</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the byte position where the token starts in the string
(the first byte has position 0)</p>
</div>
</div>
<pre><span id="VALget_line"><span class="keyword">val</span> get_line</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the line number where the token starts (numbering begins
usually with 1)</p>
</div>
</div>
<pre><span id="VALget_column"><span class="keyword">val</span> get_column</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the column of the line where the token starts (first column
is number 0)</p>
</div>
</div>
<pre><span id="VALget_length"><span class="keyword">val</span> get_length</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the length of the token in bytes</p>
</div>
</div>
<pre><span id="VALseparates_adjacent_encoded_words"><span class="keyword">val</span> separates_adjacent_encoded_words</span> : <code class="type"><a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> -> bool</code></pre><div class="info ">
<div class="info-desc">
<p>True iff the current token is white space (i.e. <code class="code">Special ' '</code>,
<code class="code">Special '\t'</code>, <code class="code">Special '\r'</code> or <code class="code">Special '\n'</code>) and the last
non-white space token was <code class="code">EncodedWord</code> and the next non-white
space token will be <code class="code">EncodedWord</code>.</p>
<p>The background of this function is that white space between
encoded words does not have a meaning, and must be ignored
by any application interpreting encoded words.</p>
</div>
</div>
<pre><span id="TYPEmime_scanner"><span class="keyword">type</span> <code class="type"></code>mime_scanner</span> </pre>
<div class="info ">
<div class="info-desc">
<p>The opaque type of a scanner for structured values</p>
</div>
</div>
<pre><span id="VALcreate_mime_scanner"><span class="keyword">val</span> create_mime_scanner</span> : <code class="type">specials:char list -><br> scan_options:<a href="Netmime_string.html#TYPEs_option">s_option</a> list -><br> ?pos:int -> ?line:int -> ?column:int -> string -> <a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a></code></pre><div class="info ">
<div class="info-desc">
<p>Creates a new <code class="code">mime_scanner</code> scanning the passed string.</p>
</div>
</div>
<div class="param_info"><code class="code">specials</code> : The list of characters recognized as special characters.</div>
<div class="param_info"><code class="code">scan_options</code> : The list of global options modifying the behaviour
of the scanner</div>
<div class="param_info"><code class="code">pos</code> : The position of the byte where the scanner starts in the
passed string. Defaults to 0.</div>
<div class="param_info"><code class="code">line</code> : The line number of this first byte. Defaults to 1.</div>
<div class="param_info"><code class="code">column</code> : The column number of this first byte. Default to 0.</div>
<p>Note for <code class="code">create_mime_scanner</code>:</p>
<p>The optional parameters <code class="code">pos</code>, <code class="code">line</code>, <code class="code">column</code> are intentionally placed after
<code class="code">scan_options</code> and before the string argument, so you can specify
scanners by partially applying arguments to <code class="code">create_mime_scanner</code>
which are not yet connected with a particular string:</p>
<pre class="codepre"><code class="code"> let my_scanner_spec = create_mime_scanner my_specials my_options in
...
let my_scanner = my_scanner_spec my_string in
...</code></pre>
<pre><span id="VALget_pos_of_scanner"><span class="keyword">val</span> get_pos_of_scanner</span> : <code class="type"><a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a> -> int</code></pre>
<pre><span id="VALget_line_of_scanner"><span class="keyword">val</span> get_line_of_scanner</span> : <code class="type"><a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a> -> int</code></pre>
<pre><span id="VALget_column_of_scanner"><span class="keyword">val</span> get_column_of_scanner</span> : <code class="type"><a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the current position, line, and column of a <code class="code">mime_scanner</code>.
The primary purpose of these functions is to simplify switching
from one <code class="code">mime_scanner</code> to another within a string:</p>
<pre class="codepre"><code class="code"> let scanner1 = create_mime_scanner ... s in
... now scanning some tokens from s using scanner1 ...
let scanner2 = create_mime_scanner ...
?pos:(get_pos_of_scanner scanner1)
?line:(get_line_of_scanner scanner1)
?column:(get_column_of_scanner scanner1)
s in
... scanning more tokens from s using scanner2 ... </code></pre>
<p><b>Restriction:</b> These functions are not available if the option
<code class="code">Recognize_encoded_words</code> is on. The reason is that this option
enables look-ahead scanning; please use the location of the last
scanned token instead.</p>
<p>Note: To improve the performance of switching, it is recommended to
create scanner specs in advance (see the example <code class="code">my_scanner_spec</code>
above).</p>
</div>
</div>
<pre><span id="VALscan_token"><span class="keyword">val</span> scan_token</span> : <code class="type"><a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a> -><br> <a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> * <a href="Netmime_string.html#TYPEs_token">s_token</a></code></pre><div class="info ">
<div class="info-desc">
<p>Returns the next token, or <code class="code">End</code> if there is no more token. The
token is returned both as extended and as normal token.</p>
</div>
</div>
<pre><span id="VALscan_token_list"><span class="keyword">val</span> scan_token_list</span> : <code class="type"><a href="Netmime_string.html#TYPEmime_scanner">mime_scanner</a> -><br> (<a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> * <a href="Netmime_string.html#TYPEs_token">s_token</a>) list</code></pre><div class="info ">
<div class="info-desc">
<p>Returns all following tokens as a list (excluding <code class="code">End</code>)</p>
</div>
</div>
<pre><span id="VALscan_structured_value"><span class="keyword">val</span> scan_structured_value</span> : <code class="type">string -><br> char list -> <a href="Netmime_string.html#TYPEs_option">s_option</a> list -> <a href="Netmime_string.html#TYPEs_token">s_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>This function is included for backwards compatibility, and for all
cases not requiring extended tokens.</p>
<p>It scans the passed string according to the list of special characters
and the list of options, and returns the list of all tokens.</p>
</div>
</div>
<pre><span id="VALspecials_rfc822"><span class="keyword">val</span> specials_rfc822</span> : <code class="type">char list</code></pre>
<pre><span id="VALspecials_rfc2045"><span class="keyword">val</span> specials_rfc2045</span> : <code class="type">char list</code></pre><div class="info ">
<div class="info-desc">
<p>The sets of special characters defined by the RFCs 822 and 2045.</p>
</div>
</div>
<h2 id="parsers_for_structured_values">Parsing Certain Forms of Structured Values</h2>
<pre><span id="VALscan_encoded_text_value"><span class="keyword">val</span> scan_encoded_text_value</span> : <code class="type">string -> <a href="Netmime_string.html#TYPEs_extended_token">s_extended_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Scans a "text" value. The returned token list contains only
<code class="code">Special</code>, <code class="code">Atom</code> and <code class="code">EncodedWord</code> tokens.
Spaces, TABs, CRs, LFs are returned (as <code class="code">Special</code>) unless
they occur between adjacent encoded words in which case
they are suppressed. The characters '(', '[', and '"' are also
returned as <code class="code">Special</code> tokens, and are not interpreted as delimiters.</p>
<p>For instance, this function can be used to scan the "Subject"
field of mail messages.</p>
</div>
</div>
<pre><span id="VALscan_value_with_parameters"><span class="keyword">val</span> scan_value_with_parameters</span> : <code class="type">string -> <a href="Netmime_string.html#TYPEs_option">s_option</a> list -> string * (string * string) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let name, params = scan_value_with_parameters s options</code>:
Scans values with annotations like
<code class="code">name ; p1=v1 ; p2=v2 ; ...</code>
For example, MIME types like "text/plain;charset=ISO-8859-1" can
be parsed.</p>
<p>The values may or may not be quoted. The characters ";", "=", and
even "," are only accepted as part of values when they are quoted.
On sytax errors, the function fails.</p>
<p>RFC 2231: This function supports some features of this RFC:
Continued parameter values are concatenated. For example:</p>
<pre class="codepre"><code class="code"> Content-Type: message/external-body; access-type=URL;
URL*0="ftp://";
URL*1="cs.utk.edu/pub/moore/bulk-mailer/bulk-mailer.tar" </code></pre>
<p>This is returned as:</p>
<pre class="codepre"><code class="code">"message/external-body",
[ ("access-type", "URL");
("URL", "ftp://cs.utk.edu/pub/moore/bulk-mailer/bulk-mailer.tar") ]
) </code></pre>
<p>However, encoded parameter values are not handled specially. The
parameter
<code class="code">title*=us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A</code>
would be returned as
<code class="code">("title*", "us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A")</code>.
Use <code class="code">scan_values_with_parameters_ep</code> instead (see below).</p>
<p>Raises <code class="code">Failure</code> on syntax errors.</p>
</div>
</div>
<pre><span id="TYPEs_param"><span class="keyword">type</span> <code class="type"></code>s_param</span> </pre>
<div class="info ">
<div class="info-desc">
<p>The type of encoded parameters (RFC 2231)</p>
</div>
</div>
<pre><span id="VALparam_value"><span class="keyword">val</span> param_value</span> : <code class="type"><a href="Netmime_string.html#TYPEs_param">s_param</a> -> string</code></pre>
<pre><span id="VALparam_charset"><span class="keyword">val</span> param_charset</span> : <code class="type"><a href="Netmime_string.html#TYPEs_param">s_param</a> -> string</code></pre>
<pre><span id="VALparam_language"><span class="keyword">val</span> param_language</span> : <code class="type"><a href="Netmime_string.html#TYPEs_param">s_param</a> -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Return the decoded value of the parameter, the charset (uppercase),
and the language.
If the charset is not available, <code class="code">""</code> will be returned.
If the language is not available, <code class="code">""</code> will be returned.</p>
</div>
</div>
<pre><span id="VALmk_param"><span class="keyword">val</span> mk_param</span> : <code class="type">?charset:string -> ?language:string -> string -> <a href="Netmime_string.html#TYPEs_param">s_param</a></code></pre><div class="info ">
<div class="info-desc">
<p>Creates a parameter from a value (in decoded form). The parameter
may have a charset and a language.</p>
</div>
</div>
<pre><span id="VALprint_s_param"><span class="keyword">val</span> print_s_param</span> : <code class="type">Stdlib.Format.formatter -> <a href="Netmime_string.html#TYPEs_param">s_param</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Prints a parameter to the formatter (as toploop printer)</p>
</div>
</div>
<pre><span id="VALscan_value_with_parameters_ep"><span class="keyword">val</span> scan_value_with_parameters_ep</span> : <code class="type">string -><br> <a href="Netmime_string.html#TYPEs_option">s_option</a> list -><br> string * (string * <a href="Netmime_string.html#TYPEs_param">s_param</a>) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let name, params = scan_value_with_parameters_ep s options</code>:
This version of the scanner copes with encoded parameters according
to RFC 2231.
Note: "ep" means "encoded parameters".</p>
<p>Example:
<code class="code">doc.html;title*=us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A</code></p>
<p>The parameter <code class="code">title</code> would be returned as:</p>
<ul>
<li>name is <code class="code">"title"</code></li>
<li>value is <code class="code">"This is ***fun***"</code></li>
<li>charset is <code class="code">"US-ASCII"</code></li>
<li>language is <code class="code">"en-us"</code></li>
</ul>
<p>Raises <code class="code">Failure</code> on syntax errors.</p>
</div>
</div>
<pre><span id="VALscan_mime_type"><span class="keyword">val</span> scan_mime_type</span> : <code class="type">string -> <a href="Netmime_string.html#TYPEs_option">s_option</a> list -> string * (string * string) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let name, params = scan_mime_type s options</code>:
Scans MIME types like
<code class="code">text/plain; charset=iso-8859-1</code>
The name of the type and the names of the parameters are converted
to lower case.</p>
<p>Raises <code class="code">Failure</code> on syntax errors.</p>
</div>
</div>
<pre><span id="VALscan_mime_type_ep"><span class="keyword">val</span> scan_mime_type_ep</span> : <code class="type">string -><br> <a href="Netmime_string.html#TYPEs_option">s_option</a> list -><br> string * (string * <a href="Netmime_string.html#TYPEs_param">s_param</a>) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let name, params = scan_mime_type_ep s options</code>:
This version copes with RFC-2231-encoded parameters.</p>
<p>Raises <code class="code">Failure</code> on syntax errors.</p>
</div>
</div>
<pre><span id="VALsplit_mime_type"><span class="keyword">val</span> split_mime_type</span> : <code class="type">string -> string * string</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let (main_type, sub_type) = split_mime_type content_type</code>:
Splits the MIME type into main and sub type, for example
<code class="code"> split_mime_type "text/plain" = ("text", "plain") </code>.
The returned strings are always lowercase.</p>
<p>Raises <code class="code">Failure</code> on syntax errors.</p>
</div>
</div>
<h2 id="printers_for_structured_values">Printing Structured Values</h2>
<pre><span id="EXCEPTIONLine_too_long"><span class="keyword">exception</span> Line_too_long</span></pre>
<div class="info ">
<div class="info-desc">
<p>Raised when the hard limit of the line length is exceeded</p>
</div>
</div>
<pre><span id="VALwrite_value"><span class="keyword">val</span> write_value</span> : <code class="type">?maxlen1:int -><br> ?maxlen:int -><br> ?hardmaxlen1:int -><br> ?hardmaxlen:int -><br> ?fold_qstring:bool -><br> ?fold_literal:bool -><br> ?unused:int Stdlib.ref -><br> ?hardunused:int Stdlib.ref -><br> <a href="Netchannels.out_obj_channel-c.html">Netchannels.out_obj_channel</a> -> <a href="Netmime_string.html#TYPEs_token">s_token</a> list -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Writes the list of <code class="code">s_token</code> to the <code class="code">out_obj_channel</code>. The value
is optionally folded into several lines while writing, but this
is off by default. To enable folding, pass <b>both</b> <code class="code">maxlen1</code> and
<code class="code">maxlen</code>:
The <code class="code">maxlen1</code> parameter specifies the length of the first line
to write, the <code class="code">maxlen</code> parameter specifies the length of the
other lines.</p>
<p>If enabled, folding tries to ensure that the value is written
in several lines that are not longer as specified by
<code class="code">maxlen1</code> and <code class="code">maxlen</code>. The value is split into lines by inserting
"folding space" at certain locations (which is usually a linefeed
followed by a space character, see below). The following
table specifies between which tokens folding may happen:</p>
<pre class="codepre"><code class="code"> +=========================================================+
1st \ 2nd | Atom | QString | DLiteral | EncWord | Special | Spec ' '|
==============+======+=========+==========+=========+=========+=========+
Atom | FS | FS | FS | FS | - | F |
QString | FS | FS | FS | FS | - | F |
DomainLiteral | FS | FS | FS | FS | - | F |
EncodedWord | FS | FS | FS | FS | - | F |
Special | - | - | - | - | - | F |
Special ' ' | - | - | - | - | - | - |
==============+======+=========+==========+=========+=========+=========+
</code></pre>
<p>The table shows between which two types of tokens a space or a folding
space is inserted:</p>
<ul>
<li><code class="code">FS</code>: folding space</li>
<li><code class="code">F</code>: linefeed without extra space</li>
<li><code class="code">-</code>: nothing can be inserted here</li>
</ul>
<p>Folding space is <code class="code">"\n "</code>, i.e. only LF, not CRLF is used as end-of-line
character. The function <code class="code">write_header</code> will convert these LF to CRLF
if needed.</p>
<p><code class="code">Special '\t'</code> is handled like <code class="code">Special ' '</code>. Control characters are just
printed, without folding. Comments, however, are substituted by
either space or folding space. The token <code class="code">End</code> is ignored.</p>
<p>Furthermore, folding may also happen within tokens:</p>
<ul>
<li><code class="code">Atom</code>, <code class="code">Control</code>, and <code class="code">Special</code> are never split up into parts.
They are simply printed.</li>
<li><code class="code">EncodedWord</code>s, however, are reformatted. This especially means:
adjacent encoded words are first concatenated if possible
(same character set, same encoding, same language), and then
split up into several pieces with optimally chosen lengths.
<b>Note:</b> Because this function gets <code class="code">s_token</code> as input and not
<code class="code">s_extended_token</code>, it is not known whether <code class="code">Special ' '</code> tokens
(or other whitespace) between adjacent EncodedWords must be
ignored. Because of this, <code class="code">write_value</code> only reformats adjacent encoded
words when there is not any whitespace between them.</li>
<li><code class="code">QString</code> may be split up in a special way unless <code class="code">fold_qstring</code>
is set to <code class="code">false</code>. For example, <code class="code">"One Two Three"</code> may be split up into
three lines <code class="code">"One\n Two\n \ Three"</code>. Because some header fields
explicitly forbid folding of quoted strings, it is possible to
set <code class="code">~fold_qstring:false</code> (it is <code class="code">true</code> by default).
<b>Note:</b> Software should not rely on that the different types of
whitespace (especially space and TAB) remain intact at the
beginning of a line. Furthermore, it may also happen that
additional whitespace is added at the end of a line by the
transport layer.</li>
<li><code class="code">DomainLiteral</code>: These are handled like <code class="code">QString</code>. The parameter
<code class="code">~fold_literal:false</code> turns folding off if it must be prevented,
it is <code class="code">true</code> by default.</li>
<li><code class="code">Comment</code>: Comments are effectively omitted! Instead of <code class="code">Comment</code>,
a space or folding space is printed. However, you can output comments
by passing sequences like <code class="code"> Special "("; ...; Special ")" </code>.</li>
</ul>
<p>It is possible to get the actual number of characters back that
can still be printed into the last line without making the line
too long. Pass an <code class="code">int ref</code> as <code class="code">unused</code> to get this value (it may
be negative!). Pass an
<code class="code">int ref</code> as <code class="code">hardunused</code> to get the number of characters that may
be printed until the hard limit is exceeded.</p>
<p>The function normally does not fail when a line becomes too long,
i.e. it exceeds <code class="code">maxlen1</code> or <code class="code">maxlen</code>.
However, it is possible to specify a hard maximum length
(<code class="code">hardmaxlen1</code> and <code class="code">hardmaxlen</code>). If these are exceeded, the function
will raise <code class="code">Line_too_long</code>.</p>
<p>For electronic mail, a <code class="code">maxlen</code> of 78 and a <code class="code">hardmaxlen</code> of 998 is
recommended.</p>
<p><b>Known Problems:</b></p>
<ul>
<li>The reformatter for EncodedWords takes into
account that multi-byte characters must not be split up. However,
this works only when the multi-byte character set is known
to <code class="code">Netconversion</code>. You can assume that UTF-8 and UTF-16 always
work. If the character set is not known the reformatter may
split the string at wrong positions.</li>
<li>The reformatter for EncodedWords may parse the token, and if
this fails, you will get the exception <code class="code">Malformed_code</code>.
This is only done in some special cases, however.</li>
<li>The function prints spaces between adjacent atoms. Although
this is allowed in principal, other MIME implementations might fail when
there are spaces at unexpected locations. Workaround: If
no spaces are desired, concatenate adjacent atoms before
passing them to this function.</li>
</ul>
<p><b>Further Tips:</b></p>
<ul>
<li>Pass ~maxlen1:0 and ~maxlen:0 to get shortest lines</li>
<li>Use the reformatter for encoded words! It works well. For
example, to output a long sentence, just wrap it into
<b>one</b> <code class="code">EncodedWord</code>. The reformatter takes care to
fold the word into several lines.</li>
</ul>
</div>
</div>
<pre><span id="VALparam_tokens"><span class="keyword">val</span> param_tokens</span> : <code class="type">?maxlen:int -><br> (string * <a href="Netmime_string.html#TYPEs_param">s_param</a>) list -> <a href="Netmime_string.html#TYPEs_token">s_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Formats a parameter list. For example,
<code class="code">[ "a", "b"; "c", "d" ]</code> is transformed to the token sequence
corresponding to <code class="code">; a=b; c=d</code>.
If <code class="code">maxlen</code> is specified, it is ensured that the individual
parameter (e.g. <code class="code">"a=b;"</code>) is not longer than <code class="code">maxlen-1</code>, such that
it will fit into a line with maximum length <code class="code">maxlen</code>.
By default, no maximum length is guaranteed.
If <code class="code">maxlen</code> is passed, or if a parameter specifies a character
set or language, the encoding of RFC 2231 will be applied. If these
conditions are not met, the parameters will be encoded traditionally.</p>
</div>
</div>
<pre><span id="VALsplit_uri"><span class="keyword">val</span> split_uri</span> : <code class="type">string -> <a href="Netmime_string.html#TYPEs_token">s_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Splits a long URI according to the algorithm of RFC 2017.
The input string must only contain 7 bit characters, and
must be, if necessary, already be URL-encoded.</p>
</div>
</div>
<h2 id="scanning_mime">Scanning MIME Messages</h2>
<pre><span id="VALscan_multipart_body"><span class="keyword">val</span> scan_multipart_body</span> : <code class="type">string -><br> start_pos:int -><br> end_pos:int -> boundary:string -> ((string * string) list * string) list</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">let [params1, value1; params2, value2; ...]
= scan_multipart_body s start_pos end_pos boundary</code>:</p>
<p>Scans the string <code class="code">s</code> that is the body of a multipart message.
The multipart message begins at position <code class="code">start_pos</code> in <code class="code">s</code>, and
<code class="code">end_pos</code> is the position
of the character following the message. In <code class="code">boundary</code> the boundary string
must be passed (this is the "boundary" parameter of the multipart
MIME type, e.g. <code class="code">multipart/mixed;boundary="some string"</code> ).</p>
<p>The return value is the list of the parts, where each part
is returned as pair <code class="code">(params, value)</code>. The left component <code class="code">params</code>
is the list of name/value pairs of the header of the part. The
right component is the raw content of the part, i.e. if the part
is encoded ("content-transfer-encoding"), the content is returned
in the encoded representation. The caller is responsible for decoding
the content.</p>
<p>The material before the first boundary and after the last
boundary is not returned.</p>
<p><b>Multipart Messages</b></p>
<p>The MIME standard defines a way to group several message parts to
a larger message (for E-Mails this technique is known as "attaching"
files to messages); these are the so-called multipart messages.
Such messages are recognized by the major type string "multipart",
e.g. <code class="code">multipart/mixed</code> or <code class="code">multipart/form-data</code>. Multipart types MUST
have a <code class="code">boundary</code> parameter because boundaries are essential for the
representation.</p>
<p>Multipart messages have a format like (where "_" denotes empty lines):</p>
<pre class="codepre"><code class="code"> ...Header...
Content-type: multipart/xyz; boundary="abc"
...Header...
_
Body begins here ("prologue")
--abc
...Header part 1...
_
...Body part 1...
--abc
...Header part 2...
_
...Body part 2
--abc
...
--abc--
Epilogue </code></pre>
<p>The parts are separated by boundary lines which begin with "--" and
the string passed as boundary parameter. (Note that there may follow
arbitrary text on boundary lines after "--abc".) The boundary is
chosen such that it does not occur as prefix of any line of the
inner parts of the message.</p>
<p>The parts are again MIME messages, with header and body. Note
that it is explicitely allowed that the parts are even multipart
messages.</p>
<p>The texts before the first boundary and after the last boundary
are ignored.</p>
<p>Note that multipart messages as a whole MUST NOT be encoded.
Only the PARTS of the messages may be encoded (if they are not
multipart messages themselves).</p>
<p>Please read RFC 2046 if want to know the gory details of this
brain-dead format.</p>
</div>
</div>
<pre><span id="VALscan_multipart_body_and_decode"><span class="keyword">val</span> scan_multipart_body_and_decode</span> : <code class="type">string -><br> start_pos:int -><br> end_pos:int -> boundary:string -> ((string * string) list * string) list</code></pre><div class="info ">
<div class="info-desc">
<p>Same as <code class="code">scan_multipart_body</code>, but decodes the bodies of the parts
if they are encoded using the methods "base64" or "quoted printable".
Fails, if an unknown encoding is used.</p>
</div>
</div>
<pre><span id="VALscan_multipart_body_from_netstream"><span class="keyword">val</span> scan_multipart_body_from_netstream</span> : <code class="type"><a href="Netstream.in_obj_stream-c.html">Netstream.in_obj_stream</a> -><br> boundary:string -><br> create:((string * string) list -> 'a) -><br> add:('a -> <a href="Netstream.in_obj_stream-c.html">Netstream.in_obj_stream</a> -> int -> int -> unit) -><br> stop:('a -> unit) -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">scan_multipart_body_from_netstream s boundary create add stop</code>:</p>
<p>Reads the MIME message from the netstream <code class="code">s</code> block by block. The
parts are delimited by the <code class="code">boundary</code>.</p>
<p>Once a new part is detected and begins, the function <code class="code">create</code> is
called with the MIME header as argument. The result <code class="code">p</code> of this function
may be of any type.</p>
<p>For every chunk of the part that is being read, the function <code class="code">add</code>
is invoked: <code class="code">add p s k n</code>.</p>
<p>Here, <code class="code">p</code> is the value returned by the <code class="code">create</code> invocation for the
current part. <code class="code">s</code> is the netstream. The current window of <code class="code">s</code> contains
the read chunk completely; the chunk begins at position <code class="code">k</code> of the
window (relative to the beginning of the window) and has a length
of <code class="code">n</code> bytes.</p>
<p>When the part has been fully read, the function <code class="code">stop</code> is
called with <code class="code">p</code> as argument.</p>
<p>That means, for every part the following is executed:</p>
<ul>
<li><code class="code">let p = create h</code></li>
<li><code class="code">add p s k1 n1</code></li>
<li><code class="code">add p s k2 n2</code></li>
<li>...</li>
<li><code class="code">add p s kN nN</code></li>
<li><code class="code">stop p</code></li>
</ul>
<p><b>Important Precondition:</b></p>
<ul>
<li>The block size of the netstream <code class="code">s</code> must be at least
<code class="code">String.length boundary + 4</code></li>
</ul>
<p><b>Exceptions:</b></p>
<ul>
<li>Exceptions can happen because of ill-formed input, and within
the callbacks of the functions <code class="code">create</code>, <code class="code">add</code>, <code class="code">stop</code>.</li>
<li>If the exception happens while part <code class="code">p</code> is being read, and the
<code class="code">create</code> function has already been called (successfully), the
<code class="code">stop</code> function is also called (you have the chance to close files).
The exception is re-raised after <code class="code">stop</code> returns.</li>
</ul>
</div>
</div>
<pre><span id="VALread_multipart_body"><span class="keyword">val</span> read_multipart_body</span> : <code class="type">(<a href="Netstream.in_obj_stream-c.html">Netstream.in_obj_stream</a> -> 'a) -><br> string -> <a href="Netstream.in_obj_stream-c.html">Netstream.in_obj_stream</a> -> 'a list</code></pre><div class="info ">
<div class="info-desc">
<p>This is the "next generation" multipart message parser. It is
called as follows:</p>
<p><code class="code">let parts = read_multipart_body f boundary s</code></p>
<p>As precondition, the current position of the stream <code class="code">s</code> must be at
the beginning of the message body. The string <code class="code">boundary</code> must
be the message boundary (without "--"). The function <code class="code">f</code> is called
for every message part, and the resulting list <code class="code">parts</code> is the
concatentation of the values returned by <code class="code">f</code>.</p>
<p>The stream passed to <code class="code">f</code> is a substream of <code class="code">s</code> that begins at the
first byte of the header of the message part. The function <code class="code">f</code>
can read data from the substream as necessary. The substream
terminates at the end of the message part. This means that <code class="code">f</code> can simply
read the data of the substream from the beginning to the end. It is
not necessary that <code class="code">f</code> reads the substream until EOF, however.</p>
<p>After all parts have been read, the trailing material of stream <code class="code">s</code>
is skipped until EOF of <code class="code">s</code> is reached.</p>
</div>
</div>
<h2 id="helpers_mime">Helpers for MIME Messages</h2>
<pre><span id="VALcreate_boundary"><span class="keyword">val</span> create_boundary</span> : <code class="type">?random:string list -> ?nr:int -> unit -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Creates a boundary string that can be used to separate multipart
messages.
The string is 63 characters long and has the following "features":</p>
<ul>
<li>Most of the string consists of the minus character yielding
a clear optical effect</li>
<li>The string contains "=__". This sequence cannot be obtained
by the quoted-printable encoding, so you need not to care whether
strings encoded as quoted-printable contain the boundary.</li>
<li>The string contains "<&>;" which is illegal in HTML, XML, and
SGML.</li>
<li>The string does not contain double quotes or backslashes,
so you can safely put double quotes around it in the MIME header.</li>
<li>The string contains <code class="code">nr</code>, so you can safely distinguish between
several boundaries occurring in the same MIME body if you
assign different <code class="code">nr</code>.</li>
<li>The string contains a hash value composed of the first
256 bytes of all strings passed as <code class="code">random</code>, and influenced
by the current GC state.</li>
</ul>
</div>
</div>
</body></html>
|
