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
|
<!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="Netchannels_tut.html">
<link rel="next" href="Netsendmail_tut.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"><title>Ocamlnet 4 Reference Manual : Netmime_tut</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Netchannels_tut.html" title="Netchannels_tut">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Netsendmail_tut.html" title="Netsendmail_tut">Next</a>
</div>
<h1>Netmime_tut</h1>
<div class="info-desc">
<h2 id="tutorial">Netmime Tutorial</h2>
<h3 id="2_StructureofMailMessages">Structure of Mail Messages</h3>
<p>Nowadays mail messages are in MIME format. This format allows us to
attach files to messages, and to encode the main text in markup
languages like HTML. In principle, mail messages have only one header
block (with fields like "Subject", sender and receiver addresses, etc.)
and one body block. However, this is only one view on the mail format,
e.g. as seen by MTAs (mail transfer agents). The MIME format adds the
possibility to structure the body block into "parts" by additional
encoding sequences. The MTAs can simply ignore this additional
stuff, but software creating and analyzing mails can usually not. In
<code class="code">Netmime</code>, one can control whether one wants to see the parts or
not.</p>
<p>Logically, the parts of the mail body are small mail messages themselves.
This means that every part has again a header and a body. The header
can, in principal, contain any number of fields, and any kind of field,
but in practice only a small subset of the possible fields are used,
in particular only those fields that are necessary to describe the body of the
part. The body can be a normal text or data block, but it is explicitly
also allowed that the body is again structured into a sequence of parts.
Thus complex mail messages are recursive data structures (to be exact,
they are trees).</p>
<p>For example, a message with two attachments usually looks like:</p>
<pre class="codepre"><code class="code"> (mail_header, mail_body)
|
+-- (main_text_header, main_text_body)
+-- (att1_header, att1_body)
+-- (att2_header, att2_body)
</code></pre>
<p>The headers contains two crucial fields that control the structure of
the message:</p>
<ul>
<li>The <code class="code">Content-type</code> describes the kind of data found in the body,
e.g. "text/html". When the <code class="code">Content-type</code> has the major type
"multipart" (e.g. "multipart/mixed"), the body is composed of
subparts. For all other types, the body is a leaf of the message
tree. (To be exact, there is another major type that opens a further
dimension of "message-in-message" composition: "message". This type
is usually used when it is not clear whether the inner message is
syntactically correct. <code class="code">Netmime</code> handles this type always as
leaf, but users of <code class="code">Netmime</code> can try to parse these inner messages
themselves.)</li>
<li>The <code class="code">Content-transfer-encoding</code> describes how the body data is
encoded as ASCII text. It is usually only set for leaves.
Recommended values are <code class="code">"quoted-printable"</code> for bodies that
contain some kind of ASCII text, and <code class="code">"base64"</code> for binary
data.</li>
</ul>
<h3 id="2_MessagesinNetmime">Messages in <code class="code">Netmime</code></h3>
<p>In <code class="code">Netmime</code>, the types of mail headers and mail bodies are defined
before and independent of their implementations: We have the
types</p>
<ul>
<li><code class="code">class type mime_header</code>: Specification of possible header implementations</li>
<li><code class="code">class type mime_body</code>: Specification of possible body implementations</li>
<li><code class="code">type complex_mime_message</code>: The type of a message tree</li>
</ul>
<p>and the implementations</p>
<ul>
<li><code class="code">class basic_mime_header</code>: A basic header implementation</li>
<li><code class="code">class memory_mime_body</code>: A body implementation storing the contents
in an O'Caml string in-memory</li>
<li><code class="code">class file_mime_body</code>: A second body implementation storing the
contents in an external file</li>
</ul>
<p>Of course, the implementation classes fulfill the specifications of
the corresponding class types. For completeness, there are also
reduced read-only class types that maybe helpful for signatures
to indicate that a function does not modify a header or body.
In principal, one can also define further implementations provided
they fit to the class types.</p>
<p>The type <code class="code">complex_mime_message</code> represents the message as a tree.
We have:</p>
<pre class="codepre"><code class="code">type complex_mime_message = mime_header * complex_mime_body
and complex_mime_body =
[ `Body of mime_body
| `Parts of complex_mime_message list
]
</code></pre><p>For example, the above mentioned mail with two attachments has
the following representation:</p>
<pre class="codepre"><code class="code">let tree =
(mail_header, `Parts [ (main_text_header, `Body main_text_body);
(att1_header, `Body att1_body);
(att2_header, `Body att2_body) ] )
</code></pre>
<p>Here, <code class="code">*_header</code> are objects of type <code class="code">mime_header</code>, and
<code class="code">*_body</code> are objects of type <code class="code">mime_body</code>. It is obvious how to
create the tree once one has these objects: Just use the
syntax in this expression. Beginners of O'Caml should recall
that it is as easy to decompose such structured values by using
the pattern matching feature of the language. For example, to get
the <code class="code">main_text_header</code> of <code class="code">tree</code>, use</p>
<pre class="codepre"><code class="code">let main_text_header =
match tree with
(_, `Parts ( (mth, _) :: _ )) -> mth
| _ -> failwith "Message has unexpected structure"
</code></pre>
<p>(Note that <code class="code"> [x1;x2;...] </code> is just an abbreviation for
<code class="code"> x1 :: x2 :: ... :: [] </code>; by switching to the "::" syntax
the message may have any number of parts in order to be
matching.) At the first glance, it looks a bit strange to
access the inner parts of mail messages in this way, but
pattern matching is a very powerful sword once one gets
accustomed to it.</p>
<p>Another hint: Because <code class="code">complex_mime_message</code> is a quite
challanging type for the compiler, it is often necessary to
give type annotations, such as</p>
<p><code class="code"> (tree : complex_mime_message) </code></p>
<p>before passing such values to functions, otherwise you get compiler
errors.</p>
<h3 id="2_AccessingHeaders">Accessing Headers</h3>
<p>It is easy to get and set the fields of headers, e.g.
<code class="code"> mail_header # field "subject" </code> returns the "Subject"
header field as string (or raises <code class="code">Not_found</code>). The names of
header fields are case-insensitive. To set a field, use
<code class="code">update_field</code>, e.g.
<code class="code"> mail_header # update_field "subject" "Ocamlnet is great" </code>.</p>
<p>The methods <code class="code">field</code> and <code class="code">update_field</code> process the field value
as unparsed string (the parsers do only very little preprocessing,
e.g. one can configure to remove all linefeeds). The module
<a href="Netmime_string.html"><code class="code">Netmime_string</code></a> has a lot functions to parse and generate field
values with a certain syntax. For example, "Subject" may contain
so-called encoded words to express text written in a character
set other than ASCII. To parse this, use</p>
<pre class="codepre"><code class="code">let subject = mail_header # field "subject" in
let word_list = Netmime_string.scan_encoded_text_value subject in
</code></pre><p>Now, the words contained in <code class="code">word_list</code> can be accessed with
a number of functions, e.g.</p>
<pre class="codepre"><code class="code">let word_val = Netmime_string.get_decoded_word word in
let word_cset = Netmime_string.get_charset word
</code></pre><p>Here, the string <code class="code">word_val</code> is the word written in the character set
<code class="code">word_cset</code>.</p>
<p>For example, for the "Subject" field</p>
<p><code class="code">=?iso-8859-1?q?this=20is=20some=20text?=</code></p>
<p>this method returns a <code class="code">word_list</code> with one word, and for this word
<code class="code">word_val = "this is some text"</code> and <code class="code">word_cset = "iso-8859-1"</code>.</p>
<p>To create such structured header values, there is the function <code class="code">write_value</code>
in <a href="Netmime_string.html"><code class="code">Netmime_string</code></a>. This function requires some more background beyond the
scope of this tutorial. As this function also supports folding of header
fields, we explain only this particular application.</p>
<p>Folding means that long header values must be split into several lines.
There is a soft limit of 78 bytes and a hard limit of 998 bytes
(not counting the end-of-line sequence). The soft limit only ensures that
values can be displayed in usual terminals or windows without needing horizontal
scrolling. Values exceeding the hard limit may be truncated in mail transport,
however. To fold a string <code class="code">s</code> composed of words, first split it into its
<code class="code">words</code>, make atoms of them, format them with <code class="code">write_value</code>, and put the result into
the header field (note: this example can be programmed better, see below):</p>
<pre class="codepre"><code class="code">let name = "Subject" in
let words = Str.split (Str.regexp "[ \t]+") s in
let atoms = List.map (fun w -> Netmime_string.Atom w) in
let buf = Buffer.create 100 in
let ch = new Netchannels.output_buffer buf in
Netmime_string.write_value
~maxlen1:(78 - String.length name - 2)
~maxlen:78
~hardmaxlen1:(998 - String.length name - 2)
~hardmaxlen:998
ch;
mail_header # update_field name (Buffer.contents buf)
</code></pre>
<p>Unfortunately, there is no general method that can fold any kind
of string. The problem is that folding is only allowed at certain
places in the string, but this depends on the type of the header
field. The shown method works only for informational texts like
"Subject". For other fields, like "Received", the method would
have to be varied, especially how the list <code class="code">atoms</code> is determined.
The syntax of the field must be known to compute <code class="code">atoms</code>.</p>
<p>In the module <a href="Netsendmail.html"><code class="code">Netsendmail</code></a> you can find formatting and
folding functions for informational texts like "Subject",
and for mail addresses. With these functions, the "Subject"
field could also be set by</p>
<pre class="codepre"><code class="code">let atoms = Netsendmail.create_text_tokens s in
mail_header # update_field
name (Netsendmail.format_field_value name atoms)
</code></pre>
<h3 id="2_AccessingBodies">Accessing Bodies</h3>
<p>Both types of bodies (in-memory, and file) support the following two
ways of accessing:</p>
<ul>
<li>Get/set the value as O'Caml string</li>
<li>Read/write the value as object channel (see <a href="Netchannels.html"><code class="code">Netchannels</code></a>)</li>
</ul>
<p>Note that when the value of a file-based body is changed, the file is
overwritten, independently of which of the two ways is taken.</p>
<p>The <code class="code">string</code> access is very simple: To get the value, just call
<code class="code">value</code>:</p>
<p><code class="code"> let s = body # value </code></p>
<p>To set the value, just call <code class="code">set_value</code>:</p>
<p><code class="code"> body # set_value s </code></p>
<p>The string returned by <code class="code">value</code> is not transfer-encoded, or better,
all such encodings (e.g. BASE-64) are decoded. Of course,
<code class="code">set_value</code> expects that the passed string is not decoded, too.</p>
<p>Note that using <code class="code">value</code> may be dangerous (or even fail) when the body
is stored in a file and is very large. <code class="code">value</code> forces that the file
is completely read into memory. You may run into serious problems when
there is not enough memory, or when the value is larger than
<code class="code">Sys.max_string_length</code> (16MB on 32 bit platforms).</p>
<p>Fortunately, there is the channel-based access method. It does not
need much memory, even when large bodies are accessed. However, one
does not get access to the completely body at once, but only chunk
by chunk. For example, to read a body line by line, use:</p>
<pre class="codepre"><code class="code">let ch = body # open_value_rd() in
let line1 = ch # input_line() in
let line2 = ch # input_line() in
...
ch # close_in()
</code></pre>
<p>As for <code class="code">value</code>, there are no transfer encodings in the returned lines.</p>
<p>The channel <code class="code">ch</code> can be used whereever an Ocamlnet function allows it,
i.e. it is a full implementation. For example, one can pass it to the
HTML parser:</p>
<pre class="codepre"><code class="code">let ch = body # open_value_rd() in
let html_doc = Nethtml.parse ch in
ch # close_in()
</code></pre>
<p>To set the value using a channel, a body can also be opened for writing:</p>
<pre class="codepre"><code class="code">
let ch = body # open_value_wr() in
ch # output_string "First line\n";
ch # output_string "Second line\n";
...
ch # close_out()
</code></pre>
<h3 id="2_Parsingmailmessages">Parsing mail messages</h3>
<p>The message to parse must be available as an object channel. Recall that
you can create an object channel from a string with</p>
<p><code class="code"> let ch = new Netchannels.input_string s </code></p>
<p>and from a file with</p>
<p><code class="code"> let ch = new Netchannels.input_channel (open_in "filename") </code></p>
<p>so one can parse mail messages coming from any source. As only sequential
access is needed, it is even possible to read directly from a Unix pipe.</p>
<p>Now, it is required to create a so-called netstream from <code class="code">ch</code>:</p>
<p><code class="code"> let nstr = new Netstream.input_stream ch </code></p>
<p>A netstream is an object channel with additional look-ahead features.
We need it here because the parser can then recognize certain patterns in
the message in a simpler manner, for example the escape sequences
separating the parts of a structured body.</p>
<p>Finally, one can invoke the parser:</p>
<p><code class="code"> let tree = Netmime_channels.read_mime_message nstr </code></p>
<p>There are a number of optional arguments for this function that can
modify the way the message tree is generated. By default, all bodies
are created in memory, and the tree is deeply parsed (i.e. inner
multipart bodies are represented in tree form).</p>
<p>When bodies should be written to disk, the argument <code class="code">storage_style</code>
can be passed: It is a function that is called whenever a header
has been parsed, but before the corresponding body. The function must
return the body object for representation and the output channel
connected to the body object. For example, to write the bodies
into numbered files:</p>
<pre class="codepre"><code class="code">let n = ref 1
let ext_storage_style header =
let body = new file_mime_body ("file" ^ string_of_int !n) in
incr n;
(body, body#open_out_wr())
let tree = read_mime_message ~storage_style:ext_storage_style nstr
</code></pre>
<p>There is also the auxiliary function <code class="code">storage</code> to create such a
storage style argument.</p>
<p>The <code class="code">header</code> can be used to generate the file name from it. Often,
the <code class="code">filename</code> argument of the <code class="code">Content-disposition</code> field is the
original file name before the attachment was appended to the
mail message. To get this name:</p>
<pre class="codepre"><code class="code">let filename =
try
let disp, disp_params = header # content_disposition() in
(* disp is usually "attachment", but we don't check *)
List.assoc "filename" disp_params
with
Not_found ->
... (* No such paramater, use other method to gen filename *)
</code></pre>
<p>It is usually a good idea to check for dangerous characters in this name
("/", "..") before constructing the name of the disk file.</p>
<p>A final remark: Don't forget to close <code class="code">nstr</code> after parsing (this implicitly
closes <code class="code">ch</code>).</p>
<h3 id="2_CreatingMailMessages">Creating Mail Messages</h3>
<p>For simple applications, the <a href="Netsendmail.html"><code class="code">Netsendmail</code></a> module has a
<a href="Netsendmail.html#VALcompose"><code class="code">Netsendmail.compose</code></a> function.
It can create a mail message with attachments, and performs all the
encoding details. This function is well explained in its module mli.</p>
<p>Of course, you can also do this yourself: Create the required headers
and bodies, and put them together to the resulting <code class="code">tree</code>.</p>
<p>Example:</p>
<pre class="codepre"><code class="code">
let date =
Netdate.mk_mail_date ~zone:Netdate.localzone (Unix.time()) in
let mail_header =
new basic_mime_header [ "MIME-version", "1.0";
"Subject", "Sample mail";
"To", "recipient\@domain.net";
"From", "sender\@domain.net";
"Date", date;
"Content-type", "multipart/mixed" ] in
let main_text_header =
new basic_mime_header [ "Content-type", "text/plain;charset=ISO-8859-1";
"Content-transfer-encoding", "quoted-printable";
] in
let main_text_body =
new memory_mime_body "Hello world!\nThis is a sample mail.\n" in
let att_header =
new basic_mime_header [ "Content-type", "image/jpeg";
"Content-transfer-encoding", "base64";
"Content-disposition", "inline;description=\"My photo\"";
] in
let att_body =
new file_mime_body "photo.jpeg" in
let tree =
(mail_header, `Parts [ (main_text_header, `Body main_text_body);
(att_header, `Body att_body) ] )
</code></pre>
<h3 id="2_PrintingMailMessages">Printing Mail Messages</h3>
<p>In order to print <code class="code">tree</code> to the object channel <code class="code">ch</code>, simply call</p>
<p><code class="code"> Netmime_channels.write_mime_message ch tree </code></p>
<p>Before invoking this function, ensure the following:</p>
<ul>
<li>The <code class="code">Content-type</code> field of all leaves should be set</li>
<li>The <code class="code">Content-transfer-encoding</code> field of all leaves should be set
(in doubt use "base64"; if missing, the default is "7bit" -
probably not what you want)</li>
<li>The <code class="code">Content-type</code> field of multipart nodes should be set (it
defaults to "multipart/mixed" if missing)</li>
<li>The <code class="code">Content-transfer-encoding</code> fields of multipart nodes should
<b>not</b> be set - this is done by the function</li>
</ul>
<p>If the <code class="code">boundary</code> parameter is missing, the function will invent one;
you don't need to deal with this.</p>
<p>The MIME message is written according to the found transfer encodings
and the multi-part boundaries.</p>
<p>Don't forget to close <code class="code">ch</code> after writing!</p>
</div>
</body></html>
|
