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
|
<!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="Netmime.html">
<link rel="next" href="Neturl.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="Composing Messages" rel="Section" href="#composing">
<link title="Sending Messages" rel="Section" href="#sending">
<title>Ocamlnet 4 Reference Manual : Netsendmail</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Netmime.html" title="Netmime">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Neturl.html" title="Neturl">Next</a>
</div>
<h1>Module <a href="type_Netsendmail.html">Netsendmail</a></h1>
<pre><span id="MODULENetsendmail"><span class="keyword">module</span> Netsendmail</span>: <code class="code">sig</code> <a href="Netsendmail.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="info-desc">
<p>Functions to compose and send electronic mails</p>
<p><b>Contents</b></p>
<ul>
<li><a href="Netsendmail.html#composing"><i>Composing Messages</i></a> </li>
<li><a href="Netsendmail.html#sending"><i>Sending Messages</i></a></li>
</ul>
<p>The tutorial has been moved to <a href="Netsendmail_tut.html"><code class="code">Netsendmail_tut</code></a>.</p>
</div>
</div>
<hr width="100%">
<h2 id="composing">Composing Messages</h2>
<p>The core function is <a href="Netsendmail.html#VALcompose"><code class="code">Netsendmail.compose</code></a> generating a MIME mail.
The mail can be sent with <a href="Netsendmail.html#VALsendmail"><code class="code">Netsendmail.sendmail</code></a>, written to an
object channel with <code class="code">Netmime.write_mime_message</code>, or postprocessed
by a user function.</p>
<p>The call to <code class="code">compose</code> can be as easy as</p>
<pre class="codepre"><code class="code"> compose ~from_addr:("me", "me@domain.net")
~to_addrs:["you", "you@domain.com"]
~subject:"I have a message for you"
"Hello, this is my message!\n"
</code></pre>
<p>This call generates the message as <a href="Netmime.html#TYPEcomplex_mime_message"><code class="code">Netmime.complex_mime_message</code></a>,
and can be directly sent with <a href="Netsendmail.html#VALsendmail"><code class="code">Netsendmail.sendmail</code></a>.</p>
<p>The <code class="code">compose</code> function is the simplified interface; alternatively one
can also generate the mail by calling <a href="Netsendmail.html#VALwrap_mail"><code class="code">Netsendmail.wrap_mail</code></a>,
<a href="Netsendmail.html#VALwrap_parts"><code class="code">Netsendmail.wrap_parts</code></a>, and <a href="Netsendmail.html#VALwrap_attachment"><code class="code">Netsendmail.wrap_attachment</code></a>, getting
more fine-grained control of certain options.</p>
<pre><span id="VALcompose"><span class="keyword">val</span> compose</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?from_addr:string * string -><br> ?cc_addrs:(string * string) list -><br> ?bcc_addrs:(string * string) list -><br> ?content_type:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> ?container_type:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> ?attachments:<a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a> list -><br> to_addrs:(string * string) list -><br> subject:string -> string -> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a></code></pre><div class="info ">
<div class="info-desc">
<p>Composes a mail message with a main text, and optionally
a number of attachments.</p>
<p>The addresses <code class="code">from_addr</code>, <code class="code">to_addrs</code>, <code class="code">cc_addrs</code>, and <code class="code">bcc_addrs</code> are
passed as pairs <code class="code">(human_readable,formal)</code> where
<code class="code">human_readable</code> is an arbitrary printable string identifying the
sender/receiver, and where <code class="code">formal</code> is the RFC-822 mailbox specification.
An example is <code class="code">("Stolpmann, Gerd", "gerd@gerd-stolpmann.de")</code>.</p>
<p>The <code class="code">subject</code> can be any text.</p>
<p>The anonymous <code class="code">string</code> argument is the main text of the mail.</p>
<p>The resulting message is always a correct MIME message.</p>
</div>
</div>
<div class="param_info"><code class="code">in_charset</code> : All passed texts (except the formal addresses) must
be encoded in <code class="code">in_charset</code>. Default: <code class="code">`Enc_iso88591</code>.
As another exception, setting <code class="code">content_type</code> explicitly prevents
the main text from being converted, and <code class="code">in_charset</code> does not
have a meaning for the main text.</div>
<div class="param_info"><code class="code">out_charset</code> : The encoded words in the generated header fields,
if necessary, and the main text are encoded in <code class="code">out_charset</code>.
Default: <code class="code">`Enc_iso88591</code>.
It is required that <code class="code">out_charset</code> is ASCII-compatible.
As a special rule, setting <code class="code">content_type</code> explicitly prevents
the main text from being converted to <code class="code">out_charset</code>.</div>
<div class="param_info"><code class="code">content_type</code> : The content type of the main text. The list is
the list of parameters attached
to the type, e.g. <code class="code">("text/plain", ["charset", mk_param "ISO-8859-1"])</code>
(see <a href="Netmime_string.html#VALmk_param"><code class="code">Netmime_string.mk_param</code></a>). When this argument is set,
the main text is no longer converted to <code class="code">out_charset</code>.
By default, when this argument is missing, the main text is
converted from <code class="code">in_charset</code> to <code class="code">out_charset</code>, and the
content type becomes <code class="code">"text/plain; charset=<out_charset>"</code>.</div>
<div class="param_info"><code class="code">container_type</code> : The content type of the container wrapping the
main text and the attachment into one entity
(only used if <code class="code">attachments</code> are present). This
defaults to <code class="code">("multipart/mixed", [])</code>. This must be either a
"multipart" or "message" type.</div>
<div class="param_info"><code class="code">attachments</code> : An optional list of attachments. Should be generated
with <code class="code">wrap_attachment</code>.</div>
<p><b>Character Set Conversion</b></p>
<p>The impact of <code class="code">in_charset</code> and <code class="code">out_charset</code> on the generated mail
is not very obvious. The charset arguments may have an effect on
the mail header and the mail body.</p>
<p>The mail header can only be composed of ASCII characters (7 bit).
To circumvent this restriction the MIME standard specifies a special
format, the so-called encoded words. These may only be used in some
places, and <code class="code">compose</code> knows where: In the subject, and the non-formal
part of mail addresses. The <code class="code">out_charset</code> is the character set
used in the generated mail. The <code class="code">in_charset</code> is the character set
the strings are encoded you pass to <code class="code">compose</code>. It is a good idea
to have <code class="code">in_charset = out_charset</code>, or at least choose <code class="code">out_charset</code>
as a superset of <code class="code">in_charset</code>, because this ensures that the character
set conversion succeeds.</p>
<p>If the mail header does not make use of the additional non-ASCII
characters, the encoded words will be avoided.</p>
<p>The mail body is only subject of character set conversion if
the <code class="code">content_type</code> is <b>not</b> passed to <code class="code">compose</code>. In this case,
the function sets it to <code class="code">text/plain</code>, and converts the message
from <code class="code">in_charset</code> to <code class="code">out_charset</code>.</p>
<p><b>Adding Attachments</b></p>
<p>To generate the attachments, call <a href="Netsendmail.html#VALwrap_attachment"><code class="code">Netsendmail.wrap_attachment</code></a>, e.g.</p>
<pre class="codepre"><code class="code"> compose ...
~attachments:[ wrap_attachment
~content_type:("application/octet-stream", [])
(new Netmime.file_mime_body "file.tar.gz") ]
</code></pre>
<p>There
are a number of kinds of attaching files, identified by <code class="code">container_type</code>.
The default is <code class="code">multipart/mixed</code>, meaning that the parts of the mail are
mixed messages and files. One can give a hint whether to display
the parts directly in the mailer program (so-called inline attachments),
or whether to suggest that the file is saved to disk ("real"
attachments). This hint is contained in the <code class="code">Content-disposition</code>
header, see <code class="code">wrap_attachment</code> how to set it.</p>
<p>For a discusion of the other <code class="code">container_type</code>s see the
<code class="code">Netsendmail.tutorial</code> at the end of this document.</p>
<pre><span id="VALwrap_attachment"><span class="keyword">val</span> wrap_attachment</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?content_id:string -><br> ?content_description:string -><br> ?content_location:string -><br> ?content_disposition:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> content_type:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> <a href="Netmime.mime_body-c.html">Netmime.mime_body</a> -> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a></code></pre><div class="info ">
<div class="info-desc">
<p>Generates a header for the <code class="code">mime_body</code>. The returned value
is intended to be used as input for the <code class="code">attachments</code> argument
of the <code class="code">compose</code> function:</p>
<pre class="codepre"><code class="code"> compose ...
~attachments:[ wrap_attachment
~content_type:("audio/wav", [])
(new file_mime_body "music.wav") ]
</code></pre>
<p>The header contains at least the <code class="code">Content-type</code> and the
<code class="code">Content-transfer-encoding</code> fields. The latter is currently
always <code class="code">"base64"</code>, but it is possible that the function is
changed in the future to also generate <code class="code">"quoted-printable"</code>
when applicable.</p>
</div>
</div>
<div class="param_info"><code class="code">in_charset</code> : The encoding of the <code class="code">content_description</code> argument.
Default: <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">out_charset</code> : The encoding of the generated <code class="code">Content-Description</code>
header. Default: <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">content_id</code> : Optionally sets the <code class="code">Content-ID</code> header field.
The passed string is the ID value without the embracing angle
brackets. The <code class="code">Content-ID</code> can be used to refer to the attachment
from other parts of the mail, e.g. in <code class="code">multipart/related</code> mails
HTML documents can include hyperlinks to attachments using the
URL syntax <code class="code">cid:ID</code> where <code class="code">ID</code> is the ID value.</div>
<div class="param_info"><code class="code">content_description</code> : The <code class="code">Content-Description</code> header</div>
<div class="param_info"><code class="code">content_location</code> : The <code class="code">Content-Location</code> header. This must be
a valid URL, only composed of 7 bit characters, and with escaped
unsafe characters</div>
<div class="param_info"><code class="code">content_disposition</code> : Optionally sets the <code class="code">Content-disposition</code>
header. Frequent values are<ul>
<li><code class="code"> ("inline", []) </code>: Indicates that the attachment is displayed
together with the main text</li>
<li><code class="code"> ("attachment", ["filename", Netmime_string.mk_param fn]) </code>: Indicates
that the attachment should be stored onto the disk. The
parameter <code class="code">fn</code> is the suggested file name. Note that <code class="code">fn</code>
should only consist of ASCII characters unless the <code class="code">charset</code>
argument of <code class="code">mk_param</code> is set to a different character encoding.</li>
</ul>
</div>
<div class="param_info"><code class="code">content_type</code> : Specifies the content type with main
type and list of parameters. Example:
<code class="code"> ("text/plain", ["charset", Netmime_string.mk_param "ISO-8859-1" ]) </code>
(see <a href="Netmime_string.html#VALmk_param"><code class="code">Netmime_string.mk_param</code></a>)</div>
<pre><span id="VALwrap_mail"><span class="keyword">val</span> wrap_mail</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?from_addr:string * string -><br> ?cc_addrs:(string * string) list -><br> ?bcc_addrs:(string * string) list -><br> to_addrs:(string * string) list -><br> subject:string -><br> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a> -> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a></code></pre><div class="info ">
<div class="info-desc">
<p>Sets the mail-related header fields in the input message, and
returns a message ready for delivery. Transfer- and delivery-related
header fields are removed from the message first, and the new fields
are set to the values passed to this function.</p>
<p>The arguments are like in <a href="Netsendmail.html#VALcompose"><code class="code">Netsendmail.compose</code></a>.</p>
<p>The input message should have at least a <code class="code">Content-type</code> header,
but this is not enforced.</p>
<p>Use this function as an alternative to <a href="Netsendmail.html#VALcompose"><code class="code">Netsendmail.compose</code></a>,
if the message is already available as <code class="code">complex_mime_message</code>,
e.g. to re-send a parsed mail message to a new destination.</p>
</div>
</div>
<p><b>Note: Resending Messages</b></p>
<p>Note that mails generated by <code class="code">wrap_mail</code> always appear as new mails,
not as forwarded or replied mails. In order to do the latter a different
way of processing the message is needed.</p>
<pre><span id="VALwrap_parts"><span class="keyword">val</span> wrap_parts</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?content_type:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> ?content_id:string -><br> ?content_description:string -><br> ?content_location:string -><br> ?content_disposition:string * (string * <a href="Netmime_string.html#TYPEs_param">Netmime_string.s_param</a>) list -><br> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a> list -> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a></code></pre><div class="info ">
<div class="info-desc">
<p>Generates an intermediate container for multipart attachments.
Use this if you want to bundle a set of attachments as a single
attachment.</p>
</div>
</div>
<div class="param_info"><code class="code">in_charset</code> : The encoding of the <code class="code">content_description</code> argument.
Default: <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">out_charset</code> : The encoding of the generated <code class="code">Content-Description</code>
header. Default: <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">content_type</code> : The <code class="code">Content-Type</code> header. Default: multipart/mixed</div>
<div class="param_info"><code class="code">content_id</code> : The <code class="code">Content-ID</code> header, without the angle brackets</div>
<div class="param_info"><code class="code">content_description</code> : The <code class="code">Content-Description</code> header</div>
<div class="param_info"><code class="code">content_location</code> : The <code class="code">Content-Location</code> header. This must be
a valid URL, only composed of 7 bit characters, and with escaped
unsafe characters</div>
<div class="param_info"><code class="code">content_disposition</code> : The <code class="code">Content-Disposition</code> header</div>
<p><b>Low-level</b></p>
<pre><span id="VALcreate_address_list_tokens"><span class="keyword">val</span> create_address_list_tokens</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> (string * string) list -> <a href="Netmime_string.html#TYPEs_token">Netmime_string.s_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the list of <code class="code">s_token</code>s representing email addresses as
structured value. The addresses are passed as list of pairs
<code class="code">(human_readable, formal)</code> as in the <code class="code">compose</code> function above.
The returned structured field value can be formatted and filled
into a mail header. For example, to set the "To" header to
<code class="code">"Stolpmann, Gerd" <gerd@gerd-stolpmann.de></code> use</p>
<pre class="codepre"><code class="code"> let sval = create_address_list_tokens ["Stolpmann, Gerd",
"gerd@gerd-stolpmann.de"] in
header # update_field "to" (format_field_value "to" sval)
</code></pre><p>This ensures that the field is correctly quoted, that appropriate
encodings are applied and that long values are folded into several
lines.</p>
</div>
</div>
<div class="param_info"><code class="code">in_charset</code> : The character encoding used for <code class="code">human_readable</code>.
Defaults to <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">out_charset</code> : The character encoding used in the generated
encoded word. This encoding must be ASCII-compatible. Defaults to
<code class="code">`Enc_iso88591</code>.</div>
<pre><span id="VALcreate_text_tokens"><span class="keyword">val</span> create_text_tokens</span> : <code class="type">?in_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -><br> ?out_charset:<a href="Netconversion.html#TYPEencoding">Netconversion.encoding</a> -> string -> <a href="Netmime_string.html#TYPEs_token">Netmime_string.s_token</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the list of <code class="code">s_token</code>s representing an informal text
as structured value. The text is passed as simple string.
The returned structured field value can be formatted and filled
into a mail header. For example, to set the "Subject" header to
<code class="code">"I have to say something"</code>, use</p>
<pre class="codepre"><code class="code"> let sval = create_text_tokens "I have to say something" in
header # update_field "subject" (format_field_value "subject" sval)
</code></pre><p>This ensures that the field is correctly quoted, that appropriate
encodings are applied and that long values are folded into several
lines.</p>
</div>
</div>
<div class="param_info"><code class="code">in_charset</code> : The character encoding used for the input string.
Defaults to <code class="code">`Enc_iso88591</code>.</div>
<div class="param_info"><code class="code">out_charset</code> : The character encoding used in the generated
encoded words. This encoding must be ASCII-compatible. Defaults to
<code class="code">`Enc_iso88591</code>.</div>
<pre><span id="VALformat_field_value"><span class="keyword">val</span> format_field_value</span> : <code class="type">string -> <a href="Netmime_string.html#TYPEs_token">Netmime_string.s_token</a> list -> string</code></pre><div class="info ">
<div class="info-desc">
<p>To put <code class="code">sval</code>, an <code class="code">s_token list</code>, into the header field <code class="code">name</code>,
call</p>
<p><code class="code"> header # update_field name (format_field_value name sval) </code></p>
<p>The field value is folded into several lines, if necessary.</p>
</div>
</div>
<h2 id="sending">Sending Messages</h2>
<pre><span id="VALsendmail"><span class="keyword">val</span> sendmail</span> : <code class="type">?mailer:string -> ?crlf:bool -> <a href="Netmime.html#TYPEcomplex_mime_message">Netmime.complex_mime_message</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Sends the passed message. The mailer program must be sendmail-compatible
(this can be assumed on all Unix systems, even if a non-sendmail
mailer is installed).</p>
<p>The mailer program is the command passed as <code class="code">mailer</code>, which is by
default a reasonable compile-time setting.</p>
<p>With <code class="code">crlf</code> one can determine the EOL convention for the message piped to
the mailer program: If <code class="code">crlf</code>, CR/LF is used, if <code class="code">not crlf</code>, only LF is
used. The default is <code class="code">false</code> for Unix systems.</p>
<p>See also <a href="Netsmtp.html#VALsendmail"><code class="code">Netsmtp.sendmail</code></a> for a way to send emails via SMTP.</p>
</div>
</div>
</body></html>
|
