-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmime-en.html
2364 lines (2039 loc) · 144 KB
/
mime-en.html
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
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>FLIM-LB 1.14 Reference Manual about MIME Features</title>
<meta name="description" content="FLIM-LB 1.14 Reference Manual about MIME Features">
<meta name="keywords" content="FLIM-LB 1.14 Reference Manual about MIME Features">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="#Top" rel="start" title="Top">
<link href="#Concept-Index" rel="index" title="Concept Index">
<link href="dir.html#Top" rel="up" title="(dir)">
<link href="#Introduction" rel="next" title="Introduction">
<link href="dir.html#Top" rel="prev" title="(dir)">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter-printindex {text-decoration: none}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
pre.display-preformatted {font-family: inherit}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
td.printindex-index-entry {vertical-align: top}
td.printindex-index-section {vertical-align: top; padding-left: 1em}
th.entries-header-printindex {text-align:left}
th.sections-header-printindex {text-align:left; padding-left: 1em}
ul.mark-bullet {list-style-type: disc}
-->
</style>
<link rel="stylesheet" type="text/css" href="janix-texinfo.css">
</head>
<body lang="en">
<div class="top-level-extent" id="Top">
<div class="nav-panel">
<p>
Next: <a href="#Introduction" accesskey="n" rel="next">What is FLIM-LB?</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h1 class="top" id="FLIM_002dLB-1_002e14-Reference-Manual-about-MIME-Features"><span>FLIM-LB 1.14 Reference Manual about MIME Features<a class="copiable-link" href="#FLIM_002dLB-1_002e14-Reference-Manual-about-MIME-Features"> ¶</a></span></h1>
<p>This file documents MIME features of FLIM-LB, a fundamental library to
process Internet Messages for GNU Emacsen.
</p>
<ul class="mini-toc">
<li><a href="#Introduction" accesskey="1">What is FLIM-LB?</a></li>
<li><a href="#How-to-use" accesskey="2">How to use MIME features</a></li>
<li><a href="#Entity" accesskey="3">Message and Entity</a></li>
<li><a href="#Content_002dType" accesskey="4">Information of Content-Type field</a></li>
<li><a href="#Content_002dDisposition" accesskey="5">Information of Content-Disposition field</a></li>
<li><a href="#Content_002dTransfer_002dEncoding" accesskey="6">Encoding Method</a></li>
<li><a href="#encoded_002dword" accesskey="7">Network representation of header</a></li>
<li><a href="#custom" accesskey="8">Various Customization</a></li>
<li><a href="#Appendix" accesskey="9">Appendix</a></li>
<li><a href="#Concept-Index">Concept Index</a></li>
<li><a href="#Function-Index">Function Index</a></li>
<li><a href="#Variable-Index">Variable Index</a></li>
</ul>
<hr>
<div class="chapter-level-extent" id="Introduction">
<div class="nav-panel">
<p>
Next: <a href="#How-to-use" accesskey="n" rel="next">How to use MIME features</a>, Previous: <a href="#Top" accesskey="p" rel="prev">FLIM-LB 1.14 Reference Manual about MIME Features</a>, Up: <a href="#Top" accesskey="u" rel="up">FLIM-LB 1.14 Reference Manual about MIME Features</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="What-is-FLIM_002dLB_003f"><span>1 What is FLIM-LB?<a class="copiable-link" href="#What-is-FLIM_002dLB_003f"> ¶</a></span></h2>
<p>FLIM is a library to provide basic features about message
representation or encoding. FLIM-LB is a variant of FLIM, which
features supports to latest Emacs.
</p>
<hr>
</div>
<div class="chapter-level-extent" id="How-to-use">
<div class="nav-panel">
<p>
Next: <a href="#Entity" accesskey="n" rel="next">Message and Entity</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">What is FLIM-LB?</a>, Up: <a href="#Top" accesskey="u" rel="up">FLIM-LB 1.14 Reference Manual about MIME Features</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="How-to-use-MIME-features"><span>2 How to use MIME features<a class="copiable-link" href="#How-to-use-MIME-features"> ¶</a></span></h2>
<p>Please eval following to use MIME features provided by FLIM:
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(require 'mime)
</pre></div>
<hr>
</div>
<div class="chapter-level-extent" id="Entity">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dType" accesskey="n" rel="next">Information of Content-Type field</a>, Previous: <a href="#How-to-use" accesskey="p" rel="prev">How to use MIME features</a>, Up: <a href="#Top" accesskey="u" rel="up">FLIM-LB 1.14 Reference Manual about MIME Features</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Message-and-Entity"><span>3 Message and Entity<a class="copiable-link" href="#Message-and-Entity"> ¶</a></span></h2>
<a class="index-entry-id" id="index-mime_002dentity"></a>
<a class="index-entry-id" id="index-entity"></a>
<p>According to RFC 2045 (<a class="ref" href="#RFC-2045">RFC 2045</a>), ‘The term “entity”, refers
specifically to the MIME-defined header fields and contents of either a
message or one of the parts in the body of a multipart entity.’ In this
document, the term <strong class="strong">entity</strong> indicates all of header fields and
body.
</p>
<p>The definition of RFC 2045 indicates that a MIME message is a tree, and
each node of the tree is an entity. Namely MIME extends message to tree
structure.
</p>
<p>FLIM uses <strong class="strong">mime-entity</strong> structure to represent
information of entity. In this document, it is called simply
‘mime-entity’.
</p>
<ul class="mini-toc">
<li><a href="#Entity-creation" accesskey="1">Functions to create mime-entity</a></li>
<li><a href="#Entity-hierarchy" accesskey="2">Features about message tree</a></li>
<li><a href="#Entity-Search" accesskey="3">Find Entity</a></li>
<li><a href="#Entity-Attributes" accesskey="4">Functions about attributes of mime-entity</a></li>
<li><a href="#Entity_002dheader" accesskey="5">Information of entity header</a></li>
<li><a href="#entity-formatting" accesskey="6">Text presentation of entity</a></li>
<li><a href="#Entity_002dcontent" accesskey="7">Contents of Entity</a></li>
<li><a href="#Entity_002dnetwork_002drepresentation" accesskey="8">Network representation of Entity</a></li>
<li><a href="#Entity-buffer" accesskey="9">Entity as buffer representation</a></li>
<li><a href="#mm_002dbackend">Entity representations and implementations</a></li>
</ul>
<hr>
<div class="section-level-extent" id="Entity-creation">
<div class="nav-panel">
<p>
Next: <a href="#Entity-hierarchy" accesskey="n" rel="next">Features about message tree</a>, Previous: <a href="#Entity" accesskey="p" rel="prev">Message and Entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Functions-to-create-mime_002dentity"><span>3.1 Functions to create mime-entity<a class="copiable-link" href="#Functions-to-create-mime_002dentity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dopen_002dentity"><span class="category-def">Function: </span><span><strong class="def-name">mime-open-entity</strong> <var class="def-var-arguments">&optional type location</var><a class="copiable-link" href="#index-mime_002dopen_002dentity"> ¶</a></span></dt>
<dd>
<p>Open an entity and return it.
</p>
<p><var class="var">type</var> is representation-type. (cf. <a class="ref" href="#mm_002dbackend">Entity representations and implementations</a>)
</p>
<p><var class="var">location</var> is location of entity. Specification of it is depended
on representation-type.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dparse_002dbuffer"><span class="category-def">Function: </span><span><strong class="def-name">mime-parse-buffer</strong> <var class="def-var-arguments">&optional buffer type</var><a class="copiable-link" href="#index-mime_002dparse_002dbuffer"> ¶</a></span></dt>
<dd>
<p>Parse <var class="var">buffer</var> as message, and set the result to buffer local
variable <code class="code">mime-message-structure</code> of <var class="var">buffer</var> as
mime-entity.
</p>
<p>If <var class="var">buffer</var> is omitted, current buffer is used.
</p>
<p><var class="var">type</var> is representation-type of created
mime-entity. (cf. <a class="ref" href="#mm_002dbackend">Entity representations and implementations</a>) Default value is <var class="var">buffer</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity-hierarchy">
<div class="nav-panel">
<p>
Next: <a href="#Entity-Search" accesskey="n" rel="next">Find Entity</a>, Previous: <a href="#Entity-creation" accesskey="p" rel="prev">Functions to create mime-entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Features-about-message-tree"><span>3.2 Features about message tree<a class="copiable-link" href="#Features-about-message-tree"> ¶</a></span></h3>
<a class="index-entry-id" id="index-node_002did"></a>
<a class="index-entry-id" id="index-entity_002dnumber"></a>
<a class="index-entry-id" id="index-message"></a>
<a class="index-entry-id" id="index-root_002dentity"></a>
<p>Structure of a MIME message is tree.
</p>
<p>In the tree, root node is the entity indicates all of the message. In
this document, it is called <strong class="strong">root-entity</strong> or <strong class="strong">message</strong>.
In FLIM, it is indicated by buffer local variable
<code class="code">mime-message-structure</code>.
</p>
<p>Each entity except root-entity has a parent. An entity may have
children. We can indicate an entity by relative position from a base
entity, based on the parent-child relationship.
</p>
<p>In addition, we can indicate an entity by absolute position of the
message.
</p>
<p>Each entity, which is a node of the tree, can be numbered by
depth and left-to-right order of the depth.
</p><div class="example">
<pre class="example-preformatted">
+-------+
| nil |
+---+---+
+-------------------+-------------------+
+-+-+ +-+-+ +-+-+
| 0 | | 1 | | 2 |
+-+-+ +-+-+ +-+-+
| +---------+---------+ |
+--+--+ +--+--+ +--+--+ +--+--+ +--+--+
| 0.0 | | 1.0 | | 1.1 | | 1.2 | | 2.0 |
+-----+ +-----+ +-----+ +-----+ +-----+
</pre></div>
<p>Namely, if depth of a node is n, the node has a node-number, which is
consists of n integers. In this document, it is called
<strong class="strong">entity-number</strong>. An entity-number is represented by list of
integer, like <code class="code">(1 2 3)</code>.
</p>
<p>mime-entity has also <strong class="strong">node-id</strong>. A node-id is represented by
reversed list of entity-number. For example, node-id corresponding with
1.2.3 is <code class="code">(3 2 1)</code>.
</p>
<p>Each entity can be indicated by entity-number or node-id in
<code class="code">mime-message-structure</code>.
</p>
<dl class="first-defvr first-defvar-alias-first-defvr">
<dt class="defvr defvar-alias-defvr" id="index-mime_002dmessage_002dstructure"><span class="category-def">Variable: </span><span><strong class="def-name">mime-message-structure</strong><a class="copiable-link" href="#index-mime_002dmessage_002dstructure"> ¶</a></span></dt>
<dd>
<p>Buffer local variable to store mime-entity structure of message.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dchildren"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-children</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dchildren"> ¶</a></span></dt>
<dd>
<p>Return list of entities included in the <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dparent"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-parent</strong> <var class="def-var-arguments">entity &optional message</var><a class="copiable-link" href="#index-mime_002dentity_002dparent"> ¶</a></span></dt>
<dd>
<p>Return parent entity of the <var class="var">entity</var>.
</p>
<p>If <var class="var">message</var> is specified, it is regarded as root instead of
<code class="code">mime-message-structure</code>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002droot_002dentity_002dp"><span class="category-def">Function: </span><span><strong class="def-name">mime-root-entity-p</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002droot_002dentity_002dp"> ¶</a></span></dt>
<dd>
<p>Return non-<code class="code">nil</code> if <var class="var">entity</var> is root entity (message).
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dnode_002did"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-node-id</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dnode_002did"> ¶</a></span></dt>
<dd>
<p>Return node-id of <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dnumber"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-number</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dnumber"> ¶</a></span></dt>
<dd>
<p>Return entity-number of <var class="var">entity</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity-Search">
<div class="nav-panel">
<p>
Next: <a href="#Entity-Attributes" accesskey="n" rel="next">Functions about attributes of mime-entity</a>, Previous: <a href="#Entity-hierarchy" accesskey="p" rel="prev">Features about message tree</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Find-Entity"><span>3.3 Find Entity<a class="copiable-link" href="#Find-Entity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dfind_002dentity_002dfrom_002dnumber"><span class="category-def">Function: </span><span><strong class="def-name">mime-find-entity-from-number</strong> <var class="def-var-arguments">entity-number &optional message</var><a class="copiable-link" href="#index-mime_002dfind_002dentity_002dfrom_002dnumber"> ¶</a></span></dt>
<dd>
<p>Return entity from <var class="var">entity-number</var> in <var class="var">message</var>.
</p>
<p>If <var class="var">message</var> is not specified, <code class="code">mime-message-structure</code> is
used.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dfind_002dentity_002dfrom_002dnode_002did"><span class="category-def">Function: </span><span><strong class="def-name">mime-find-entity-from-node-id</strong> <var class="def-var-arguments">entity-node-id &optional message</var><a class="copiable-link" href="#index-mime_002dfind_002dentity_002dfrom_002dnode_002did"> ¶</a></span></dt>
<dd>
<p>Return entity from <var class="var">entity-node-id</var> in <var class="var">message</var>.
</p>
<p>If <var class="var">message</var> is not specified, <code class="code">mime-message-structure</code> is
used.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dfind_002dentity_002dfrom_002dcontent_002did"><span class="category-def">Function: </span><span><strong class="def-name">mime-find-entity-from-content-id</strong> <var class="def-var-arguments">cid &optional message</var><a class="copiable-link" href="#index-mime_002dfind_002dentity_002dfrom_002dcontent_002did"> ¶</a></span></dt>
<dd>
<p>Return entity from <var class="var">cid</var> in <var class="var">message</var>.
</p>
<p>If <var class="var">message</var> is not specified, <code class="code">mime-message-structure</code> is
used.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity-Attributes">
<div class="nav-panel">
<p>
Next: <a href="#Entity_002dheader" accesskey="n" rel="next">Information of entity header</a>, Previous: <a href="#Entity-Search" accesskey="p" rel="prev">Find Entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Functions-about-attributes-of-mime_002dentity"><span>3.4 Functions about attributes of mime-entity<a class="copiable-link" href="#Functions-about-attributes-of-mime_002dentity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dcontent_002dtype"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-content-type</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dcontent_002dtype"> ¶</a></span></dt>
<dd>
<p>Return content-type of <var class="var">entity</var>. (cf. <a class="ref" href="#mime_002dcontent_002dtype">mime-content-type structure</a>)
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dcontent_002ddisposition"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-content-disposition</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dcontent_002ddisposition"> ¶</a></span></dt>
<dd>
<p>Return content-disposition of
<var class="var">entity</var>. (cf. <a class="ref" href="#mime_002dcontent_002ddisposition">mime-content-disposition structure</a>)
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dfilename"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-filename</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dfilename"> ¶</a></span></dt>
<dd>
<p>Return file name of <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dencoding"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-encoding</strong> <var class="def-var-arguments">entity &optional default-encoding</var><a class="copiable-link" href="#index-mime_002dentity_002dencoding"> ¶</a></span></dt>
<dd>
<p>Return content-transfer-encoding of <var class="var">entity</var>.
(cf. <a class="ref" href="#Content_002dTransfer_002dEncoding">Encoding Method</a>)
</p>
<p>If the <var class="var">entity</var> does not have Content-Transfer-Encoding field, this
function returns <var class="var">default-encoding</var>. If it is nil, <code class="code">"7bit"</code> is
used as default value.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dcooked_002dp"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-cooked-p</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dcooked_002dp"> ¶</a></span></dt>
<dd>
<p>Return non-nil if contents of <var class="var">entity</var> has been already
code-converted.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity_002dheader">
<div class="nav-panel">
<p>
Next: <a href="#entity-formatting" accesskey="n" rel="next">Text presentation of entity</a>, Previous: <a href="#Entity-Attributes" accesskey="p" rel="prev">Functions about attributes of mime-entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Information-of-entity-header"><span>3.5 Information of entity header<a class="copiable-link" href="#Information-of-entity-header"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dfetch_002dfield"><span class="category-def">Function: </span><span><strong class="def-name">mime-fetch-field</strong> <var class="def-var-arguments">field-name &optional entity</var><a class="copiable-link" href="#index-mime_002dfetch_002dfield"> ¶</a></span></dt>
<dd>
<p>Return field-body of <var class="var">field-name</var> field in header of
<var class="var">entity</var>.
</p>
<p>The results is network representation.
</p>
<p>If <var class="var">entity</var> is omitted, <code class="code">mime-message-structure</code> is used as
default value.
</p>
<p>If <var class="var">field-name</var> field is not found, this function returns
<code class="code">nil</code>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dread_002dfield"><span class="category-def">Function: </span><span><strong class="def-name">mime-read-field</strong> <var class="def-var-arguments">field-name &optional entity</var><a class="copiable-link" href="#index-mime_002dread_002dfield"> ¶</a></span></dt>
<dd>
<p>Parse <var class="var">field-name</var> field in header of <var class="var">entity</var>, and return the
result.
</p>
<p>Format of result is depended on kind of field. For non-structured
field, this function returns string. For structured field, it returns
list corresponding with structure of the field.
</p>
<p>Strings in the result will be converted to internal representation of
Emacs.
</p>
<p>If <var class="var">entity</var> is omitted, <code class="code">mime-message-structure</code> is used as
default value.
</p>
<p>If <var class="var">field-name</var> field is not found, this function returns
<code class="code">nil</code>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="entity-formatting">
<div class="nav-panel">
<p>
Next: <a href="#Entity_002dcontent" accesskey="n" rel="next">Contents of Entity</a>, Previous: <a href="#Entity_002dheader" accesskey="p" rel="prev">Information of entity header</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Text-presentation-of-entity"><span>3.6 Text presentation of entity<a class="copiable-link" href="#Text-presentation-of-entity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dinsert_002dheader"><span class="category-def">Function: </span><span><strong class="def-name">mime-insert-header</strong> <var class="def-var-arguments">entity &optional invisible-fields visible-fields</var><a class="copiable-link" href="#index-mime_002dinsert_002dheader"> ¶</a></span></dt>
<dd>
<p>Insert before point a decoded contents of header of <var class="var">entity</var>.
</p>
<p><var class="var">invisible-fields</var> is list of regexps to match field-name to hide.
<var class="var">visible-fields</var> is list of regexps to match field-name to
hide.
</p>
<p>If a field-name is matched with some elements of <var class="var">invisible-fields</var>
and matched with none of <var class="var">visible-fields</var>, this function don’t
insert the field.
</p>
<p>Each encoded-word (<a class="ref" href="#encoded_002dword">Network representation of header</a>) in the header is decoded. “Raw
non us-ascii characters” are also decoded as
<code class="code">default-mime-charset</code>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dinsert_002dtext_002dcontent"><span class="category-def">Function: </span><span><strong class="def-name">mime-insert-text-content</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dinsert_002dtext_002dcontent"> ¶</a></span></dt>
<dd>
<p>Insert before point a contents of <var class="var">entity</var> as text entity.
</p>
<p>Contents of the <var class="var">entity</var> are decoded as MIME charset (<a class="ref" href="#MIME-charset">MIME charset</a>). If the <var class="var">entity</var> does not have charset parameter of
Content-Type field, <code class="code">default-mime-charset</code> is used as default
value.
</p></dd></dl>
<dl class="first-defvr first-defvar-alias-first-defvr">
<dt class="defvr defvar-alias-defvr" id="index-default_002dmime_002dcharset"><span class="category-def">Variable: </span><span><strong class="def-name">default-mime-charset</strong><a class="copiable-link" href="#index-default_002dmime_002dcharset"> ¶</a></span></dt>
<dd>
<p>Symbol to indicate default value of MIME charset (<a class="ref" href="#MIME-charset">MIME charset</a>).
</p>
<p>It is used when MIME charset is not specified.
</p>
<p>It is originally variable of APEL.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity_002dcontent">
<div class="nav-panel">
<p>
Next: <a href="#Entity_002dnetwork_002drepresentation" accesskey="n" rel="next">Network representation of Entity</a>, Previous: <a href="#entity-formatting" accesskey="p" rel="prev">Text presentation of entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Contents-of-Entity"><span>3.7 Contents of Entity<a class="copiable-link" href="#Contents-of-Entity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dcontent"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-content</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dcontent"> ¶</a></span></dt>
<dd>
<p>Return content of <var class="var">entity</var> as byte sequence.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dinsert_002dentity_002dcontent"><span class="category-def">Function: </span><span><strong class="def-name">mime-insert-entity-content</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dinsert_002dentity_002dcontent"> ¶</a></span></dt>
<dd>
<p>Insert content of <var class="var">entity</var> at point.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dwrite_002dentity_002dcontent"><span class="category-def">Function: </span><span><strong class="def-name">mime-write-entity-content</strong> <var class="def-var-arguments">entity filename</var><a class="copiable-link" href="#index-mime_002dwrite_002dentity_002dcontent"> ¶</a></span></dt>
<dd>
<p>Write content of <var class="var">entity</var> into <var class="var">filename</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity_002dnetwork_002drepresentation">
<div class="nav-panel">
<p>
Next: <a href="#Entity-buffer" accesskey="n" rel="next">Entity as buffer representation</a>, Previous: <a href="#Entity_002dcontent" accesskey="p" rel="prev">Contents of Entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Network-representation-of-Entity"><span>3.8 Network representation of Entity<a class="copiable-link" href="#Network-representation-of-Entity"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dinsert_002dentity"><span class="category-def">Function: </span><span><strong class="def-name">mime-insert-entity</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dinsert_002dentity"> ¶</a></span></dt>
<dd>
<p>Insert header and body of <var class="var">entity</var> at point.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dwrite_002dentity"><span class="category-def">Function: </span><span><strong class="def-name">mime-write-entity</strong> <var class="def-var-arguments">entity filename</var><a class="copiable-link" href="#index-mime_002dwrite_002dentity"> ¶</a></span></dt>
<dd>
<p>Write representation of <var class="var">entity</var> into <var class="var">filename</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dwrite_002dentity_002dbody"><span class="category-def">Function: </span><span><strong class="def-name">mime-write-entity-body</strong> <var class="def-var-arguments">entity filename</var><a class="copiable-link" href="#index-mime_002dwrite_002dentity_002dbody"> ¶</a></span></dt>
<dd>
<p>Write body of <var class="var">entity</var> into <var class="var">filename</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Entity-buffer">
<div class="nav-panel">
<p>
Next: <a href="#mm_002dbackend" accesskey="n" rel="next">Entity representations and implementations</a>, Previous: <a href="#Entity_002dnetwork_002drepresentation" accesskey="p" rel="prev">Network representation of Entity</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Entity-as-buffer-representation"><span>3.9 Entity as buffer representation<a class="copiable-link" href="#Entity-as-buffer-representation"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dbuffer"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-buffer</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dbuffer"> ¶</a></span></dt>
<dd>
<p>Return buffer, which contains <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dpoint_002dmin"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-point-min</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dpoint_002dmin"> ¶</a></span></dt>
<dd>
<p>Return the start point of <var class="var">entity</var> in the buffer which contains
<var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dpoint_002dmax"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-point-max</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dpoint_002dmax"> ¶</a></span></dt>
<dd>
<p>Return the end point of <var class="var">entity</var> in the buffer which contains
<var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dheader_002dstart"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-header-start</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dheader_002dstart"> ¶</a></span></dt>
<dd>
<p>Return the start point of header of <var class="var">entity</var> in the buffer which
contains <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dheader_002dend"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-header-end</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dheader_002dend"> ¶</a></span></dt>
<dd>
<p>Return the end point of header of <var class="var">entity</var> in the buffer which
contains <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dbody_002dstart"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-body-start</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dbody_002dstart"> ¶</a></span></dt>
<dd>
<p>Return the start point of body of <var class="var">entity</var> in the buffer which
contains <var class="var">entity</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dbody_002dend"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-body-end</strong> <var class="def-var-arguments">entity</var><a class="copiable-link" href="#index-mime_002dentity_002dbody_002dend"> ¶</a></span></dt>
<dd>
<p>Return the end point of body of <var class="var">entity</var> in the buffer which
contains <var class="var">entity</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="mm_002dbackend">
<div class="nav-panel">
<p>
Previous: <a href="#Entity-buffer" accesskey="p" rel="prev">Entity as buffer representation</a>, Up: <a href="#Entity" accesskey="u" rel="up">Message and Entity</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Entity-representations-and-implementations"><span>3.10 Entity representations and implementations<a class="copiable-link" href="#Entity-representations-and-implementations"> ¶</a></span></h3>
<a class="index-entry-id" id="index-mm_002dbackend"></a>
<a class="index-entry-id" id="index-entity-processing-method"></a>
<a class="index-entry-id" id="index-representation_002dtype"></a>
<p>Entity is an abstraction. It is designed to use various data
representations for their purposes.
</p>
<p>Each entity has <strong class="strong">representation-type</strong>. It must be specified when
an entity is created. (cf. <a class="ref" href="#Entity-creation">Functions to create mime-entity</a>)
</p>
<p>Functions about entity are implemented by request processing to the
entity. Each entity knows its representation-type. Each entity calls
processing function corresponding with the representation-type. Such
kind of function is called <strong class="strong">entity processing method</strong>. A module,
consists of them corresponding with a representation-type, is called
<strong class="strong">mm-backend</strong>.
</p>
<p>Module name of each mm-backend consists of the prefix <code class="code">mm</code>
and its representation-type. The module is required automatically
when its entity is created at first.
</p>
<ul class="mini-toc">
<li><a href="#Request-for-entity" accesskey="1">Message-passing for entity</a></li>
<li><a href="#mm_002dbackend-module" accesskey="2">Definition of mm-backend</a></li>
</ul>
<hr>
<div class="subsection-level-extent" id="Request-for-entity">
<div class="nav-panel">
<p>
Next: <a href="#mm_002dbackend-module" accesskey="n" rel="next">Definition of mm-backend</a>, Previous: <a href="#mm_002dbackend" accesskey="p" rel="prev">Entity representations and implementations</a>, Up: <a href="#mm_002dbackend" accesskey="u" rel="up">Entity representations and implementations</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h4 class="subsection" id="Message_002dpassing-for-entity"><span>3.10.1 Message-passing for entity<a class="copiable-link" href="#Message_002dpassing-for-entity"> ¶</a></span></h4>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dentity_002dsend"><span class="category-def">Function: </span><span><strong class="def-name">mime-entity-send</strong> <var class="def-var-arguments">entity message &rest args</var><a class="copiable-link" href="#index-mime_002dentity_002dsend"> ¶</a></span></dt>
<dd>
<p>Send <var class="var">message</var> to <var class="var">entity</var> with <var class="var">args</var>, and return the
result.
</p>
<p><var class="var">args</var> is arguments of the <var class="var">message</var>.
</p></dd></dl>
<hr>
</div>
<div class="subsection-level-extent" id="mm_002dbackend-module">
<div class="nav-panel">
<p>
Previous: <a href="#Request-for-entity" accesskey="p" rel="prev">Message-passing for entity</a>, Up: <a href="#mm_002dbackend" accesskey="u" rel="up">Entity representations and implementations</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h4 class="subsection" id="Definition-of-mm_002dbackend"><span>3.10.2 Definition of mm-backend<a class="copiable-link" href="#Definition-of-mm_002dbackend"> ¶</a></span></h4>
<dl class="first-deffn first-defmac-alias-first-deffn">
<dt class="deffn defmac-alias-deffn" id="index-mm_002ddefine_002dbackend"><span class="category-def">Macro: </span><span><strong class="def-name">mm-define-backend</strong> <var class="def-var-arguments">type &optional parents</var><a class="copiable-link" href="#index-mm_002ddefine_002dbackend"> ¶</a></span></dt>
<dd>
<p>Define <var class="var">type</var> as a mm-backend.
</p>
<p>If <var class="var">PARENTS</var> is specified, <var class="var">type</var> inherits parents. Each parent
must be representation-type.
</p>
<p>Example:
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(mm-define-backend chao (generic))
</pre></div>
</dd></dl>
<dl class="first-deffn first-defmac-alias-first-deffn">
<dt class="deffn defmac-alias-deffn" id="index-mm_002ddefine_002dmethod"><span class="category-def">Macro: </span><span><strong class="def-name">mm-define-method</strong> <var class="def-var-arguments">name args &rest body</var><a class="copiable-link" href="#index-mm_002ddefine_002dmethod"> ¶</a></span></dt>
<dd>
<p>Define <var class="var">name</var> as a method function of (nth 1 (car <var class="var">args</var>))
backend.
</p>
<p><var class="var">args</var> is like an argument list of lambda, but (car <var class="var">args</var>) must
be specialized parameter. (car (car <var class="var">args</var>)) is name of variable
and (nth 1 (car <var class="var">args</var>)) is name of backend
(representation-type).
</p>
<p>Example:
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(mm-define-method entity-cooked-p ((entity chao)) nil)
</pre></div>
</dd></dl>
<hr>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Content_002dType">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dDisposition" accesskey="n" rel="next">Information of Content-Disposition field</a>, Previous: <a href="#Entity" accesskey="p" rel="prev">Message and Entity</a>, Up: <a href="#Top" accesskey="u" rel="up">FLIM-LB 1.14 Reference Manual about MIME Features</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Information-of-Content_002dType-field"><span>4 Information of Content-Type field<a class="copiable-link" href="#Information-of-Content_002dType-field"> ¶</a></span></h2>
<a class="index-entry-id" id="index-mime_002dcontent_002dtype"></a>
<a class="index-entry-id" id="index-Content_002dType-field"></a>
<p><strong class="strong">Content-Type field</strong> is a field to indicate kind of contents or
data format, such as media-type (<a class="ref" href="#media_002dtype">media-type</a>) and MIME charset. It
is defined in RFC 2045 (<a class="ref" href="#RFC-2045">RFC 2045</a>).
</p>
<p><strong class="strong">[Memo]</strong>
</p><blockquote class="quotation">
<p>Historically, Content-Type field was proposed in RFC 1049. In it,
Content-Type did not distinguish type and subtype, and there are no
mechanism to represent kind of character code like MIME charset.
</p></blockquote>
<p>FLIM provides parser for Content-Type field and structure
<strong class="strong">mime-content-type</strong> to store information of
Content-Type field.
</p>
<ul class="mini-toc">
<li><a href="#Content_002dType-field" accesskey="1">Format of Content-Type field</a></li>
<li><a href="#mime_002dcontent_002dtype" accesskey="2">mime-content-type structure</a></li>
<li><a href="#Content_002dType-parser" accesskey="3">Parser</a></li>
<li><a href="#Content_002dType-utility" accesskey="4">Utility functions</a></li>
</ul>
<hr>
<div class="section-level-extent" id="Content_002dType-field">
<div class="nav-panel">
<p>
Next: <a href="#mime_002dcontent_002dtype" accesskey="n" rel="next">mime-content-type structure</a>, Previous: <a href="#Content_002dType" accesskey="p" rel="prev">Information of Content-Type field</a>, Up: <a href="#Content_002dType" accesskey="u" rel="up">Information of Content-Type field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Format-of-Content_002dType-field"><span>4.1 Format of Content-Type field<a class="copiable-link" href="#Format-of-Content_002dType-field"> ¶</a></span></h3>
<a class="index-entry-id" id="index-parameter"></a>
<a class="index-entry-id" id="index-subtype"></a>
<a class="index-entry-id" id="index-type"></a>
<p>Format of Content-Type field is defined as follows:
</p>
<blockquote class="quotation">
<p>“Content-Type” “:” <strong class="strong">type</strong> “/”
<strong class="strong">subtype</strong> *( “;” <strong class="strong">parameter</strong> )
</p></blockquote>
<p>For example:
</p>
<blockquote class="quotation">
<div class="example">
<pre class="example-preformatted">Content-Type: image/jpeg
</pre></div>
</blockquote>
<blockquote class="quotation">
<div class="example">
<pre class="example-preformatted">Content-Type: text/plain; charset=iso-2022-jp
</pre></div>
</blockquote>
<p>‘type’ and ‘subtype’ indicate format of an entity. In this document,
pair of them is called ‘media-type’. ‘image/jpeg’ or ‘text/plain’ is
a media-type.
</p>
<p><strong class="strong">[Memo]</strong>
</p><blockquote class="quotation">
<p>If an entity does not have Content-Type field, it is regarded as
following:
</p>
<blockquote class="quotation">
<div class="example">
<pre class="example-preformatted">Content-Type: text/plain; charset=us-ascii
</pre></div>
</blockquote>
<p>(cf. <a class="ref" href="#us_002dascii">us-ascii</a>)
</p></blockquote>
<hr>
</div>
<div class="section-level-extent" id="mime_002dcontent_002dtype">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dType-parser" accesskey="n" rel="next">Parser</a>, Previous: <a href="#Content_002dType-field" accesskey="p" rel="prev">Format of Content-Type field</a>, Up: <a href="#Content_002dType" accesskey="u" rel="up">Information of Content-Type field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="mime_002dcontent_002dtype-structure"><span>4.2 mime-content-type structure<a class="copiable-link" href="#mime_002dcontent_002dtype-structure"> ¶</a></span></h3>
<dl class="first-deffn">
<dt class="deffn" id="index-mime_002dcontent_002dtype-1"><span class="category-def">Structure: </span><span><strong class="def-name">mime-content-type</strong><a class="copiable-link" href="#index-mime_002dcontent_002dtype-1"> ¶</a></span></dt>
<dd>
<p>Structure to store information of a Content-Type field.
</p>
<p>Applications should use reference functions
<code class="code">mime-content-type-SLOT</code> to refer information of the
structure.
</p>
<p>Slots of the structure are following:
</p>
<dl class="table">
<dt><var class="var">primary-type</var></dt>
<dd><p>primary type of media-type (symbol).
</p>
</dd>
<dt><var class="var">subtype</var></dt>
<dd><p>subtype of media-type (symbol).
</p>
</dd>
<dt><var class="var">parameters</var></dt>
<dd><p>parameters of Content-Type field (association-list).
</p>
</dd>
</dl>
</dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-make_002dmime_002dcontent_002dtype"><span class="category-def">Function: </span><span><strong class="def-name">make-mime-content-type</strong> <var class="def-var-arguments">type subtype</var><a class="copiable-link" href="#index-make_002dmime_002dcontent_002dtype"> ¶</a></span></dt>
<dd><p>&optional parameters
</p>
<p>Constructor of content-type.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dcontent_002dtype_002dparameter"><span class="category-def">Function: </span><span><strong class="def-name">mime-content-type-parameter</strong> <var class="def-var-arguments">content-type parameter</var><a class="copiable-link" href="#index-mime_002dcontent_002dtype_002dparameter"> ¶</a></span></dt>
<dd>
<p>Return value of <var class="var">parameter</var> of <var class="var">content-type</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Content_002dType-parser">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dType-utility" accesskey="n" rel="next">Utility functions</a>, Previous: <a href="#mime_002dcontent_002dtype" accesskey="p" rel="prev">mime-content-type structure</a>, Up: <a href="#Content_002dType" accesskey="u" rel="up">Information of Content-Type field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Parser"><span>4.3 Parser<a class="copiable-link" href="#Parser"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dparse_002dContent_002dType"><span class="category-def">Function: </span><span><strong class="def-name">mime-parse-Content-Type</strong> <var class="def-var-arguments">string</var><a class="copiable-link" href="#index-mime_002dparse_002dContent_002dType"> ¶</a></span></dt>
<dd>
<p>Parse <var class="var">string</var> as a field-body of Content-Type field, and return the
result as mime-content-type (<a class="ref" href="#mime_002dcontent_002dtype">mime-content-type structure</a>) structure.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dread_002dContent_002dType"><span class="category-def">Function: </span><span><strong class="def-name">mime-read-Content-Type</strong><a class="copiable-link" href="#index-mime_002dread_002dContent_002dType"> ¶</a></span></dt>
<dd>
<p>Parse Content-Type field of the current buffer, and return the result as
mime-content-type (<a class="ref" href="#mime_002dcontent_002dtype">mime-content-type structure</a>) structure.
</p>
<p>Return <code class="code">nil</code> if Content-Type field is not found.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Content_002dType-utility">
<div class="nav-panel">
<p>
Previous: <a href="#Content_002dType-parser" accesskey="p" rel="prev">Parser</a>, Up: <a href="#Content_002dType" accesskey="u" rel="up">Information of Content-Type field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Utility-functions"><span>4.4 Utility functions<a class="copiable-link" href="#Utility-functions"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dtype_002fsubtype_002dstring"><span class="category-def">Function: </span><span><strong class="def-name">mime-type/subtype-string</strong> <var class="def-var-arguments">type &optional subtype</var><a class="copiable-link" href="#index-mime_002dtype_002fsubtype_002dstring"> ¶</a></span></dt>
<dd>
<p>Return type/subtype string from <var class="var">type</var> and <var class="var">subtype</var>.
</p></dd></dl>
<hr>
</div>
</div>
<div class="chapter-level-extent" id="Content_002dDisposition">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dTransfer_002dEncoding" accesskey="n" rel="next">Encoding Method</a>, Previous: <a href="#Content_002dType" accesskey="p" rel="prev">Information of Content-Type field</a>, Up: <a href="#Top" accesskey="u" rel="up">FLIM-LB 1.14 Reference Manual about MIME Features</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h2 class="chapter" id="Information-of-Content_002dDisposition-field"><span>5 Information of Content-Disposition field<a class="copiable-link" href="#Information-of-Content_002dDisposition-field"> ¶</a></span></h2>
<a class="index-entry-id" id="index-mime_002dcontent_002ddisposition"></a>
<a class="index-entry-id" id="index-RFC-2183"></a>
<a class="index-entry-id" id="index-Standards-Track"></a>
<a class="index-entry-id" id="index-Content_002dDisposition-field"></a>
<p><strong class="strong">Content-Disposition field</strong> is an optional field to
specify presentation of an entity or attributes of an entity, such as
file name.
</p>
<p>[RFC 2183]
</p><blockquote class="quotation">
<p>S. Dorner, K. Moore and R. Troost, “Communicating Presentation
Information in Internet Messages: The Content-Disposition Header”,
August 1997, Standards Track.
</p></blockquote>
<p>FLIM provides parser for Content-Disposition field and structure
<strong class="strong">mime-content-disposition</strong> to store information of
Content-Disposition field.
</p>
<ul class="mini-toc">
<li><a href="#mime_002dcontent_002ddisposition" accesskey="1">mime-content-disposition structure</a></li>
<li><a href="#Content_002dDisposition-parser" accesskey="2">Parser for Content-Disposition field</a></li>
</ul>
<hr>
<div class="section-level-extent" id="mime_002dcontent_002ddisposition">
<div class="nav-panel">
<p>
Next: <a href="#Content_002dDisposition-parser" accesskey="n" rel="next">Parser for Content-Disposition field</a>, Previous: <a href="#Content_002dDisposition" accesskey="p" rel="prev">Information of Content-Disposition field</a>, Up: <a href="#Content_002dDisposition" accesskey="u" rel="up">Information of Content-Disposition field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="mime_002dcontent_002ddisposition-structure"><span>5.1 mime-content-disposition structure<a class="copiable-link" href="#mime_002dcontent_002ddisposition-structure"> ¶</a></span></h3>
<dl class="first-deffn">
<dt class="deffn" id="index-mime_002dcontent_002ddisposition-1"><span class="category-def">Structure: </span><span><strong class="def-name">mime-content-disposition</strong><a class="copiable-link" href="#index-mime_002dcontent_002ddisposition-1"> ¶</a></span></dt>
<dd>
<p>Structure to store information of a Content-Disposition field.
</p>
<p>Applications should use reference functions
<code class="code">mime-content-disposition-SLOT</code> to refer information of the
structure.
</p>
<p>Slots of the structure are following:
</p>
<dl class="table">
<dt><var class="var">disposition-type</var></dt>
<dd><p>disposition-type (symbol).
</p>
</dd>
<dt><var class="var">parameters</var></dt>
<dd><p>parameters of Content-Disposition field
(association-list).
</p>
</dd>
</dl>
</dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dcontent_002ddisposition_002dparameter"><span class="category-def">Function: </span><span><strong class="def-name">mime-content-disposition-parameter</strong> <var class="def-var-arguments">content-disposition parameter</var><a class="copiable-link" href="#index-mime_002dcontent_002ddisposition_002dparameter"> ¶</a></span></dt>
<dd>
<p>Return value of <var class="var">parameter</var> of <var class="var">content-disposition</var>.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dcontent_002ddisposition_002dfilename"><span class="category-def">Function: </span><span><strong class="def-name">mime-content-disposition-filename</strong> <var class="def-var-arguments">content-disposition</var><a class="copiable-link" href="#index-mime_002dcontent_002ddisposition_002dfilename"> ¶</a></span></dt>
<dd>
<p>Return filename of <var class="var">content-disposition</var>.
</p></dd></dl>
<hr>
</div>
<div class="section-level-extent" id="Content_002dDisposition-parser">
<div class="nav-panel">
<p>
Previous: <a href="#mime_002dcontent_002ddisposition" accesskey="p" rel="prev">mime-content-disposition structure</a>, Up: <a href="#Content_002dDisposition" accesskey="u" rel="up">Information of Content-Disposition field</a> [<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<h3 class="section" id="Parser-for-Content_002dDisposition-field"><span>5.2 Parser for Content-Disposition field<a class="copiable-link" href="#Parser-for-Content_002dDisposition-field"> ¶</a></span></h3>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dparse_002dContent_002dDisposition"><span class="category-def">Function: </span><span><strong class="def-name">mime-parse-Content-Disposition</strong> <var class="def-var-arguments">string</var><a class="copiable-link" href="#index-mime_002dparse_002dContent_002dDisposition"> ¶</a></span></dt>
<dd>
<p>Parse <var class="var">string</var> as field-body of Content-Disposition field, and
return the result as mime-content-disposition
(<a class="ref" href="#mime_002dcontent_002ddisposition">mime-content-disposition structure</a>) structure.
</p></dd></dl>
<dl class="first-deffn first-defun-alias-first-deffn">
<dt class="deffn defun-alias-deffn" id="index-mime_002dread_002dContent_002dDisposition"><span class="category-def">Function: </span><span><strong class="def-name">mime-read-Content-Disposition</strong><a class="copiable-link" href="#index-mime_002dread_002dContent_002dDisposition"> ¶</a></span></dt>
<dd>
<p>Parse Content-Disposition field of the current buffer, and return the
result as mime-content-disposition (<a class="ref" href="#mime_002dcontent_002ddisposition">mime-content-disposition structure</a>)
structure.
</p>
<p>Return <code class="code">nil</code> if Content-Disposition field is not found.
</p></dd></dl>
<hr>
</div>
</div>
<div class="chapter-level-extent" id="Content_002dTransfer_002dEncoding">
<div class="nav-panel">
<p>