1 <!doctype sinfo system>
3 <title>FLIM 1.9 Manual about MIME Features
4 <author>MORIOKA Tomohiko <mail>morioka@jaist.ac.jp</mail>
14 This file documents MIME features of FLIM, a Internet message
15 parsing/encoding library for GNU Emacs.
22 FLIM is a library to provide basic features about message
23 representation or encoding.
26 <h1> How to use MIME features
29 Please eval following to use MIME features provided by FLIM:
36 <h1> Message and Entity
39 According to <dref>RFC 2045</dref>, `The term ``entity'', refers
40 specifically to the MIME-defined header fields and contents of either
41 a message or one of the parts in the body of a multipart entity.' In
42 this document, the term <concept>entity</concept> indicates all of
43 header fields and body.
45 The definition of RFC 2045 indicates that a MIME message is a tree.
46 An message is a tree, each node is an entity, like following figure.
47 Namely MIME extends message to tree structure.
49 FLIM uses <concept>mime-entity</concept> structure to represent
50 information of entity. In this document, it is called simply
54 <h2> Functions to create mime-entity
55 <node> Entity creation
57 <defun name="mime-open-entity">
60 Open an entity and return it.
62 <var>type</var> is representation-type. <cf node="mm-backend">
64 <var>location</var> is location of entity. Specification of it is
65 depended on representation-type.
68 <defun name="mime-parse-buffer">
71 Parse <var>buffer</var> as message, and set the result to buffer local
72 variable <code>mime-message-structure</code> of <var>buffer</var> as
75 If <var>buffer</var> is omitted, current buffer is used.
77 <var>type</var> is representation-type of created mime-entity. <cf
78 node="mm-backend"> Default value is <var>buffer</var>.
82 <h2> Features about message tree
83 <node> Entity hierarchy
85 MIME message
\e$B$O
\e(B entity
\e$B$rC10L$H$9$kLZ9=B$$K$J$C$F$$$^$9!#
\e(B
87 \e$B$3$NLZ$K$*$$$F:,$H$J$k@a$O
\e(B message
\e$BA4BN$rI=$9
\e(B entity
\e$B$G$9!#$3$3$G$O!"
\e(B
88 \e$B$3$l$r
\e(B <concept>root-entity</concept>
\e$B$b$7$/$O
\e(B
89 <concept>message</concept>
\e$B$H8F$S$^$9!#
\e(B
91 root-entity
\e$B0J30$N
\e(B entity
\e$B$O?F$r;}$A$^$9!#$^$?!"
\e(Bentity
\e$B$O;R6!$r;}$D$+
\e(B
92 \e$B$bCN$l$^$;$s!#$3$N?F;R4X78$r9M$($k$3$H$G
\e(B entity
\e$B$NAjBP4X78$r07$&$3$H$,
\e(B
95 \e$B0lJ}!"
\e(Bentity
\e$B$N
\e(B message
\e$B$K$*$1$k0LCV$r9M$($k$3$H$b$G$-$^$9!#
\e(B
97 entity
\e$B$O$3$NLZ$K$*$1$k@a$H$J$j$^$9$,!"$3$NLZ$K$O?<$5$HF1$8?<$5$NCf$N
\e(B
98 \e$B=gHV$K=>$C$FHV9f$,IU$1$k$3$H$,$G$-$^$9!#B($A!"
\e(B
102 \e$B("
\e(B nil
\e$B("
\e(B
104 \e$B(#(!(!(!(!(!(!(!(!(!(+(!(!(!(!(!(!(!(!(!($
\e(B
105 \e$B(#(*($
\e(B
\e$B(#(*($
\e(B
\e$B(#(*($
\e(B
106 \e$B("#0("
\e(B
\e$B("#1("
\e(B
\e$B("#2("
\e(B
107 \e$B(&(((%
\e(B
\e$B(&(((%
\e(B
\e$B(&(((%
\e(B
108 \e$B("
\e(B
\e$B(#(!(!(!(!(+(!(!(!(!($
\e(B
\e$B("
\e(B
109 \e$B(#(!(*(!($(#(!(*(!($(#(!(*(!($(#(!(*(!($(#(!(*(!($
\e(B
110 \e$B("
\e(B
\e$B#0
\e(B.
\e$B#0("("
\e(B
\e$B#1
\e(B.
\e$B#0("("
\e(B
\e$B#1
\e(B.
\e$B#1("("
\e(B
\e$B#1
\e(B.
\e$B#2("("
\e(B
\e$B#2
\e(B.
\e$B#0("
\e(B
111 \e$B(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%(&(!(!(!(%
\e(B
115 <noindent>
\e$B$N$h$&$K?<$5
\e(B n
\e$B$N@a$K$OD9$5
\e(B n
\e$B$N@0?tNs$N@aHV9f$,?6$l$^$9!#$3$l
\e(B
116 \e$B$r
\e(B <concept>entity-number</concept>
\e$B$H8F$S$^$9!#
\e(Bentity-number
\e$B$O
\e(B S
\e$B<0$H
\e(B
117 \e$B$7$F$O
\e(B <code>(1 2 3)</code>
\e$B$N$h$&$J@0?t$N%j%9%H$H$7$FI=8=$5$l$^$9!#
\e(B
119 mime-entity
\e$B$G$O!"$3$l$HF1MM$N
\e(B <concept>node-id</concept>
\e$B$rMQ$$$^$9!#
\e(B
120 node-id
\e$B$O$A$g$&$I
\e(B entity-number
\e$B$r5U$K$7$?%j%9%H$G!"
\e(Bentity-number
121 1.2.3
\e$B$KBP1~$9$k
\e(B node-id
\e$B$O
\e(B <code>(3 2 1)</code>
\e$B$G$9!#
\e(B
123 \e$BA0=R$N$h$&$K!"
\e(BMIME message
\e$B$O
\e(B entity
\e$B$rC10L$H$7$?LZ9=B$$K$J$C$F$$$k$N$G!"
\e(B
124 \e$B$3$N:,$G$"$k
\e(B message
\e$BA4BN$b
\e(B mime-entity
\e$B$GI=8=$9$k$3$H$,$G$-!"
\e(Bbuffer
125 local
\e$BJQ?t
\e(B <code>mime-message-structure</code>
\e$B$K3JG<$9$k$3$H$K$7$^$9!#
\e(B
127 <code>mime-message-structure</code>
\e$B$r5/E@$K
\e(B entity-number
\e$B$d
\e(B node-id
128 \e$B$G<($5$l$k
\e(B entity
\e$B$r<h$j=P$9$3$H$,$G$-$^$9!#
\e(B
130 <defvar name="mime-message-structure">
132 Buffer local variable to store mime-entity structure of message.
135 <defun name="mime-entity-children">
138 Return list of entities included in the <var>entity</var>.
141 <defun name="mime-entity-parent">
142 <args> entity <opts> message
144 Return parent entity of the <var>entity</var>.
146 If <var>message</var> is specified, it is regarded as root instead of
147 <code>mime-message-structure</code>.
150 <defun name="mime-root-entity-p">
153 Return non-<code>nil</code> if <var>entity</var> is root entity
157 <defun name="mime-entity-node-id">
160 Return node-id of <var>entity</var>.
163 <defun name="mime-entity-number">
166 Return entity-number of <var>entity</var>.
169 <defun name="mime-find-entity-from-number">
170 <args> entity-number <opts> message
172 Return entity from <var>entity-number</var> in <var>message</var>.
174 If <var>message</var> is not specified,
175 <code>mime-message-structure</code> is used.
178 <defun name="mime-find-entity-from-node-id">
179 <args> entity-node-id <opts> message
181 Return entity from <var>entity-node-id</var> in <var>message</var>.
183 If <var>message</var> is not specified,
184 <code>mime-message-structure</code> is used.
188 <h2> Functions about attributes of mime-entity
189 <node> Entity Attributes
191 <defun name="mime-entity-content-type">
194 Return content-type of <var>entity</var>.
195 <cf node="mime-content-type">
198 <defun name="mime-entity-content-disposition">
201 Return content-disposition of <var>entity</var>. <cf
202 node="mime-content-disposition">
205 <defun name="mime-entity-filename">
208 Return file name of <var>entity</var>.
211 <defun name="mime-entity-encoding">
212 <args> entity <opts> default-encoding
214 Return content-transfer-encoding of <var>entity</var>.
215 <cf node="Content-Transfer-Encoding">
217 If the <var>entity</var> does not have Content-Transfer-Encoding
218 field, this function returns <var>default-encoding</var>. If it is
219 nil, <code>"7bit"</code> is used as default value.
222 <defun name="mime-entity-cooked-p">
225 Return non-nil if contents of <var>entity</var> has been already
230 <h2> Information of entity header
233 <defun name="mime-fetch-field">
234 <args> field-name <opts> entity
236 Return field-body of <var>field-name</var> field in header of
239 The results is network representation.
241 If <var>entity</var> is omitted, <code>mime-message-structure</code>
242 is used as default value.
244 If <var>field-name</var> field is not found, this function returns
248 <defun name="mime-read-field">
249 <args> field-name <opts> entity
251 Parse <var>field-name</var> field in header of <var>entity</var>, and
254 Format of result is depended on kind of field. For non-structured
255 field, this function returns string. For structured field, it returns
256 list corresponding with structure of the field.
258 Strings in the result will be converted to internal representation of
261 If <var>entity</var> is omitted, <code>mime-message-structure</code>
262 is used as default value.
264 If <var>field-name</var> field is not found, this function returns
268 <defun name="mime-insert-decoded-header">
269 <args> entity <opts> invisible-fields visible-fields
271 Insert before point a decoded contents of header of <var>entity</var>.
273 <var>invisible-fields</var> is list of regexps to match field-name to
274 hide. <var>visible-fields</var> is list of regexps to match
277 If a field-name is matched with some elements of
278 <var>invisible-fields</var> and matched with none of
279 <var>visible-fields</var>, this function don't insert the field.
283 <h2> Contents of Entity
284 <node> Entity-content
286 <defun name="mime-entity-content">
289 Return content of <var>entity</var> as byte sequence.
292 <defun name="mime-write-entity-content">
293 <args> entity filename
295 Write content of <var>entity</var> into <var>filename</var>.
298 <defun name="mime-write-entity">
299 <args> entity filename
301 Write representation of <var>entity</var> into <var>filename</var>.
304 <defun name="mime-write-entity-body">
305 <args> entity filename
307 Write body of <var>entity</var> into <var>filename</var>.
311 <h2> Entity as buffer representation
314 <defun name="mime-entity-buffer">
317 Return buffer, which contains <var>entity</var>.
320 <defun name="mime-entity-point-min">
323 Return the start point of <var>entity</var> in the buffer which
324 contains <var>entity</var>.
327 <defun name="mime-entity-point-max">
330 Return the end point of <var>entity</var> in the buffer which
331 contains <var>entity</var>.
334 <defun name="mime-entity-header-start">
337 Return the start point of header of <var>entity</var> in the buffer
338 which contains <var>entity</var>.
341 <defun name="mime-entity-header-end">
344 Return the end point of header of <var>entity</var> in the buffer
345 which contains <var>entity</var>.
348 <defun name="mime-entity-body-start">
351 Return the start point of body of <var>entity</var> in the buffer
352 which contains <var>entity</var>.
355 <defun name="mime-entity-body-end">
358 Return the end point of body of <var>entity</var> in the buffer which
359 contains <var>entity</var>.
363 <h2> Entity representations and implementations
366 Entity is an abstraction. It is designed to use various data
367 representations for their purposes.
369 Each entity has <concept>representation-type</concept>. It must be
370 specified when an entity is created. <cf node="Entity Creation">
372 \e$BA0@a$^$G$K=R$Y$FMh$?
\e(B entity
\e$B$KBP$9$k=hM}$O!"
\e(Bentity
\e$B$KBP$7$F$=$N=hM}$r0M
\e(B
373 \e$BMj$9$k$3$H$K$h$C$F<B8=$5$l$F$$$^$9!#
\e(BEntity
\e$B$O<+J,$N
\e(B
374 representation-type
\e$B$rCN$C$F$*$j!"$=$N
\e(B representation-type
\e$B$K1~$8$F<B:]
\e(B
375 \e$B$N=hM}$r9T$&4X?t$r8F$S=P$7$^$9!#$3$N$h$&$J4X?t$r
\e(B <concept>entity
\e$B=hM}
\e(B
376 method</concept>
\e$B$H8F$S$^$9!#$^$?!"
\e(Brepresentation-type
\e$BKh$K$3$N$h$&$J4X
\e(B
377 \e$B?t$r$^$H$a$?$b$N$r
\e(B <concept>mm-backend</concept>
\e$B$H8F$S$^$9!#
\e(B
379 mm-backend
\e$B$O
\e(B representation-type
\e$B$NL>A0$N@hF,$K
\e(B <code>mm</code>
\e$B$H$$$&
\e(B
380 \e$B@\F,<-$rIU$1$?4X?tL>$+$i$J$k
\e(B module
\e$B$G!"$=$N
\e(B module
\e$BL>$OF1MM$K
\e(B
381 representation-type
\e$B$NL>A0$N@hF,$K
\e(B <code>mm</code>
\e$B$rIU$1$?$b$N$K$J$C$F
\e(B
382 \e$B$$$^$9!#$3$N
\e(B module
\e$B$O
\e(B representation-type
\e$B$N
\e(B entity
\e$B$,:G=i$K@8@.$5$l$k
\e(B
383 \e$B;~$K<+F0E*$K
\e(B require
\e$B$5$l$^$9!#
\e(B
386 <h3> Message-passing for entity
387 <node> Request for entity
389 <defun name="mime-entity-send">
390 <args> entity message <rest> args
392 <var>entity</var>
\e$B$K
\e(B <var>message</var>
\e$B$rAw$k!#
\e(B
394 <var>args</var>
\e$B$O
\e(B <var>message</var>
\e$B$N0z?t$G$"$k!#
\e(B
398 <h3> How to make mm-backend
399 <node> mm-backend module
401 \e$B!J$9$_$^$;$s!#$=$N$&$A=q$-$^$9
\e(B (^_^;
\e$B!K
\e(B
403 \e$B!J$H$j$"$($:!"
\e(Bmm*.el
\e$B$r;29M$K$7$F$/$@$5$$!K
\e(B
406 <h1> Information of Content-Type field
409 <concept>Content-Type field</concept> is a field to indicate kind of
410 contents or data format, such as <dref>media-type</dref> and MIME
411 charset. It is defined in <dref>RFC 2045</dref>.
415 Historically, Content-Type field was proposed in RFC 1049. In it,
416 Content-Type did not distinguish type and subtype, and there are no
417 mechanism to represent kind of character code like MIME charset.
421 FLIM provides parser for Content-Type field and structure
422 <concept>mime-content-type</concept> to store information of
426 <h2> Format of Content-Type field
427 <node> Content-Type field
429 Content-Type
\e$BMs$N7A<0$O0J2<$N$h$&$KDj5A$5$l$F$$$^$9!'
\e(B
432 ``Content-Type'' ``:'' <concept>type</concept> ``/''
433 <concept>subtype</concept> *( ``;'' <concept>parameter</concept> )
440 Content-Type: image/jpeg
449 Content-Type: text/plain; charset=iso-2022-jp
454 \e$B$J$I$N$h$&$KMQ$$$i$l$^$9!#
\e(B
456 \e$B$3$3$G!"
\e(B`type'
\e$B$H
\e(B `subtype'
\e$B$O
\e(B entity
\e$B$N7A<0$r<($9$b$N$G!"N><T$rAm>N$7
\e(B
457 \e$B$F!"
\e(B`media-type'
\e$B$H8F$V$3$H$K$7$^$9!#>e5-$NNc$K$*$1$k
\e(B `image/jpeg'
\e$B$d
\e(B
458 `text/plain'
\e$B$O
\e(B media-type
\e$B$N#1$D$G$9!#
\e(B
462 Content-Type
\e$BMs$N$J$$
\e(B entity
\e$B$O
\e(B
466 Content-Type: text/plain; charset=us-ascii
471 \e$B$H$7$F2r<a$5$l$k!#
\e(B<cf node="us-ascii">
475 <h2> mime-content-type structure
476 <node> mime-content-type
478 <define type="Structure" name="mime-content-type">
480 Content-Type
\e$BMs$N>pJs$r3JG<$9$k$?$a$N9=B$BN!#
\e(B
482 \e$B$3$N9=B$BN$r;2>H$9$k$K$O
\e(B <code>mime-content-type-
\e$BMWAGL>
\e(B</code>
\e$B$H$$$&L>
\e(B
483 \e$BA0$N;2>H4X?t$rMQ$$$k!#
\e(B
485 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'
\e(B
488 <dt>primary-type<dd>media-type
\e$B$N<g7?
\e(B (symbol).
490 <dt>subtype<dd>media-type
\e$B$NI{7?
\e(B (symbol).
492 <dt>parameters<dd>Content-Type
\e$BMs$N
\e(B parameter (
\e$BO"A[
\e(B list).
497 <defun name="make-mime-content-type">
500 <p>content-type
\e$B$N@8@.;R!#
\e(B
503 <defun name="mime-content-type-parameter">
504 <args> content-type parameter
506 <var>content-type</var>
\e$B$N
\e(B <var>parameter</var>
\e$B$NCM$rJV$9!#
\e(B
511 <node> Content-Type parser
513 <defun name="mime-parse-Content-Type">
516 <var>string</var>
\e$B$r
\e(B content-type
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
519 <defun name="mime-read-Content-Type">
521 \e$B8=:_$N
\e(B buffer
\e$B$N
\e(B Content-Type
\e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$rJV$9!#
\e(B
523 Content-Type
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B nil
\e$B$rJV$9!#
\e(B
527 <h2> Utility functions
528 <node> Content-Type utility
530 <defun name="mime-type/subtype-string">
531 <args> type <opts> subtype
533 Return type/subtype string from <var>type</var> and
538 <h1> Information of Content-Disposition field
539 <node> Content-Disposition
541 <concept>Content-Disposition
\e$BMs
\e(B</concept>
\e$B$O
\e(B entity
\e$B$NI=<($d
\e(B file
\e$BL>$J$I
\e(B
542 \e$B$NB0@-$K$J$I$K4X$9$k>pJs$r5-=R$9$k$?$a$N$b$N$G$9!#
\e(B
544 <rfc number="2183" type="Standards Track"
545 author="S. Dorner, K. Moore and R. Troost"
546 title="Communicating Presentation Information in
547 Internet Messages: The Content-Disposition Header"
550 FLIM
\e$B$O
\e(B Content-Disposition
\e$BMs$r9=J82r@O$9$k4X?t$H
\e(B Content-Disposition
551 \e$BMs$N2r@O7k2L$r3JG<$9$k9=B$BN
\e(B
552 <concept>mime-content-disposition</concept>
\e$B$rDs6!$7$^$9!#
\e(B
555 <h2> mime-content-disposition structure
556 <node> mime-content-disposition
558 <define type="Structure" name="mime-content-disposition">
560 Content-Disposition
\e$BMs$N2r@O7k2L$r<}$a$k$?$a$N9=B$BN!#
\e(B
562 \e$B$3$N9=B$BN$r;2>H$9$k$K$O
\e(B <code>mime-content-disposition-
\e$BMWAGL>
\e(B</code>
\e$B$H
\e(B
563 \e$B$$$&L>A0$N;2>H4X?t$rMQ$$$k!#
\e(B
565 \e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'
\e(B
568 <dt>disposition-type<dd>disposition-type (symbol).
570 <dt>parameters<dd>Content-Disposition
\e$BMs$N
\e(B parameter (
\e$BO"A[
\e(B list).
575 <defun name="mime-content-disposition-parameter">
576 <args> content-disposition parameter
578 <var>content-disposition</var>
\e$B$N
\e(B <var>parameter</var>
\e$B$NCM$rJV$9!#
\e(B
581 <defun name="mime-content-disposition-filename">
582 <args> content-disposition
584 <var>content-disposition</var>
\e$B$N
\e(B filename
\e$B$NCM$rJV$9!#
\e(B
588 <h2> Parser for Content-Disposition field
589 <node> Content-Disposition parser
591 <defun name="mime-parse-Content-Disposition">
594 <var>string</var>
\e$B$r
\e(B content-disposition
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
597 <defun name="mime-read-Content-Disposition">
599 \e$B8=:_$N
\e(B buffer
\e$B$N
\e(B Content-Disposition
\e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$rJV$9!#
\e(B
601 Content-Disposition
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B nil
\e$B$rJV$9!#
\e(B
606 <node> Content-Transfer-Encoding
608 <concept>Content-Transfer-Encoding
\e$BMs
\e(B</concept>
\e$B$O
\e(B entity
\e$B$NId9f2=K!$r5-
\e(B
609 \e$B=R$9$k$?$a$N$b$N$G$9!#
\e(B
611 FLIM
\e$B$G$O
\e(B Content-Transfer-Encoding
\e$BMs$r9=J82r@O$9$k4X?t$rDs6!$7$^$9!#$3
\e(B
612 \e$B$l$i$N4X?t$O
\e(B Content-Transfer-Encoding
\e$BMs$N>pJs$OJ8;zNs$GI=8=$7$^$9!#
\e(B
614 \e$B$^$?!"
\e(BContent-Transfer-Encoding
\e$B$K4p$E$$$FId9f2=!&I|9f2=$r9T$&4X?t$bDs
\e(B
619 <node> Content-Transfer-Encoding parser
621 <defun name="mime-parse-Content-Transfer-Encoding">
624 <var>string</var>
\e$B$r
\e(B content-transfer-encoding
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
627 <defun name="mime-read-Content-Transfer-Encoding">
628 <opts>default-encoding
630 \e$B8=:_$N
\e(B buffer
\e$B$N
\e(B Content-Transfer-Encoding
\e$BMs$rFI$_<h$j!"2r@O$7$?7k2L$r
\e(B
633 Content-Transfer-Encoding
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B
634 <var>default-encoding</var>
\e$B$rJV$9!#
\e(B
638 <h2> Region encoding/decoding
639 <node> Region encoder/decoder
641 <defun name="mime-encode-region">
642 <args> start end encoding
644 Encode region <var>start</var> to <var>end</var> of current buffer
645 using <var>encoding</var>.
648 <defun name="mime-decode-region">
649 <args> start end encoding
651 Decode region <var>start</var> to <var>end</var> of current buffer
652 using <var>encoding</var>.
655 <defvar name="mime-encoding-method-alist">
657 Alist of encoding vs. corresponding method to encode region.
659 Each element looks like <code>(STRING . FUNCTION)</code> or
660 <code>(STRING . nil)</code>. <var>string</var> is
661 content-transfer-encoding. <code>function</code> is region encoder
662 and <code>nil</code> means not to encode.
665 <defvar name="mime-decoding-method-alist">
667 Alist of encoding vs. corresponding method to decode region.
669 Each element looks like <code>(STRING . FUNCTION)</code> or
670 <code>(STRING . nil)</code>. <var>string</var> is
671 content-transfer-encoding. <code>function</code> is region decoder
672 and <code>nil</code> means not to decode.
676 <h2> String encoding/decoding
677 <node> String encoder/decoder
679 <defun name="mime-decode-string">
680 <args> string encoding
682 <var>string</var>
\e$B$r
\e(B <var>encoding</var>
\e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#
\e(B
685 <defvar name="mime-string-decoding-method-alist">
687 Alist of encoding vs. corresponding method to decode string.
689 Each element looks like <code>(STRING . FUNCTION)</code>.
690 STRING is content-transfer-encoding.
691 FUNCTION is string decoder.
695 <h2> File encoding/decoding
696 <node> File encoder/decoder
698 <defun name="mime-insert-encoded-file">
699 <args> filename encoding
701 Insert file <var>FILENAME</var> encoded by <var>ENCODING</var> format.
704 <defun name="mime-write-decoded-region">
705 <args> start end filename encoding
707 Decode and write current region encoded by <var>encoding</var> into
710 <var>start</var> and <var>end</var> are buffer positions.
713 <defvar name="mime-file-encoding-method-alist">
715 Alist of encoding vs. corresponding method to insert encoded file.
717 Each element looks like <code>(STRING . FUNCTION)</code>. STRING is
718 content-transfer-encoding. FUNCTION is function to insert encoded
722 <defvar name="mime-file-decoding-method-alist">
724 Alist of encoding vs. corresponding method to write decoded region to
727 Each element looks like <code>(STRING . FUNCTION)</code>. STRING is
728 content-transfer-encoding. FUNCTION is function to write decoded
733 <h1> Network representation of header
736 encoded-word
\e$B$O
\e(B header
\e$B$GHs
\e(B <dref>ASCII</dref>
\e$BJ8;z$rI=8=$9$k$?$a$N7A
\e(B
737 \e$B<0$G!"
\e(B<concept>RFC 2047</concept>
\e$B$GDj5A$5$l$F$$$^$9!#
\e(B
739 <rfc number="2047" type="Standards Track" author="K. Moore"
740 title="MIME (Multipurpose Internet Mail Extensions) Part
741 Three: Message Header Extensions for Non-ASCII Text"
742 date="November 1996" obsolete="1521,1522,1590">
744 \e$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"
\e(Bencoded-word
\e$B$rMQ$$$:$KHs
\e(B
745 <dref>ASCII</dref>
\e$BJ8;z$r
\e(B header
\e$B$KF~$l$?5-;v$bB8:_$7$^$9!#
\e(B
747 FLIM
\e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#
\e(B
750 <h2> Header encoding/decoding
751 <node> Header encoder/decoder
753 <defun name="eword-encode-header">
754 <opts> code-conversion separator
756 Decode MIME encoded-words in header fields.
758 If <var>code-conversion</var> is <code>nil</code>, it decodes only
759 encoded-words. If it is mime-charset, it decodes non-ASCII bit
760 patterns as the mime-charset. Otherwise it decodes non-ASCII bit
761 patterns as the default-mime-charset.
763 If <var>separator</var> is not nil, it is used as header separator.
766 <defun name="eword-encode-header">
767 <opts> code-conversion
769 Encode header fields to network representation, such as MIME
772 It refer variable <code>eword-field-encoding-method-alist</code>.
776 <h1> Various Customization
779 <define type="group" name="mime">
781 MIME
\e$B4XO"5!G=$K4X$9$k
\e(B group.
783 <code>mail</code>
\e$B$H
\e(B <code>news</code>
\e$B$KB0$9$k!#
\e(B
786 <defvar name="default-mime-charset">
788 \e$BE,@Z$J
\e(B <dref>MIME charset</dref>
\e$B$,8+$D$+$i$J$+$C$?>l9g$KMQ$$$i$l$k
\e(B
791 \e$BK\Mh$O
\e(B APEL
\e$B$NJQ?t$G$"$k!#
\e(B
794 <defvar name="mime-temp-directory">
796 MIME
\e$B5!G=$K4X$9$k<BAu$,0l;~E*$K;HMQ$9$k
\e(B file
\e$B$r:n@.$9$k
\e(B directory.
798 \e$B4D6-JQ?t
\e(B <code>MIME_TMP_DIR</code>, <code>TM_TMP_DIR</code>,
799 <code>TMPDIR</code>, <code>TMP</code>
\e$B$b$7$/$O
\e(B <code>TEMP</code>
\e$B$,@_Dj
\e(B
800 \e$B$5$l$F$$$?>l9g!"$=$l$r=i4|CM$H$7$FMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"
\e(B
801 <code>"/tmp/"</code>
\e$B$rMQ$$$k!#
\e(B
814 <concept>7bit</concept> means any integer between 0 .. 127.
816 Any data represented by 7bit integers is called <concept>7bit
819 Textual string consisted of Control characters between 0 .. 31 and
820 127, and space represented by 32, and graphic characters between 33
821 .. 236 are called <concept>7bit (textual) string</concept>.
823 Conventional Internet <a node="MTA">MTA</a> can translate 7bit data,
824 so it is no need to translate by <a
825 node="Quoted-Printable">Quoted-Printable</a> or <a
826 node="Base64">Base64</a> for 7bit data.
828 However if there are too long lines, it can not translate by 7bit MTA
829 even if it is 7bit data. <dref>RFC 821</dref> and <dref>RFC
830 2045</dref> require lines in 7bit data must be less than 998 bytes.
831 So if a ``7bit data'' has a line more than 999 bytes, it is regarded
832 as <dref>binary</dref>. For example, Postscript file should be
833 encoded by Quoted-Printable.
839 <concept>8bit</concept> means any integer between 0 .. 255.
841 Any data represented by 8bit integers is called <concept>8bit
844 Textual string consisted of Control characters between 0 .. 31, 127,
845 and 128 .. 159, and space represented by 32, and graphic characters
846 between 33 .. 236 and 160 .. 255 are called <concept>8bit (textual)
849 For example, <dref>iso-8859-1</dref> or <dref>euc-kr</dref> are
850 coded-character-set represented by 8bit textual string.
852 Traditional Internet <a node="MTA">MTA</a> can translate only
853 <dref>7bit</dref> data, so if a 8bit data will be translated such MTA,
854 it must be encoded by <dref>Quoted-Printable</dref> or
857 However 8bit MTA are increasing today.
859 However if there are too long lines, it can not translate by 8bit MTA
860 even if it is 8bit data. <dref>RFC 2045</dref> require lines in 8bit
861 data must be less than 998 bytes. So if a ``8bit data'' has a line
862 more than 999 bytes, it is regarded as <dref>binary</dref>, so it must
863 be encoded by Base64 or Quoted-Printable.
869 <concept>ASCII</concept> is a 94-character set contains primary latin
870 characters (A-Z, a-z), numbers and some characters. It is a standard
871 of the United States of America. It is a variant of <a node="ISO
874 <standard abbrev="ASCII" title-en="Coded Character Set -- 7-Bit
875 American Standard Code for Information Interchange"
876 number="ANSI X3.4" year="1986">
882 <concept>Base64</concept> is a transfer encoding method of
883 <dref>MIME</dref> defined in <dref>RFC 2045</dref>.
885 The encoding process represents 24-bit groups of input bits as output
886 strings of 4 encoded characters. Encoded characters represent integer
887 0 .. 63 or <concept>pad</concept>. Base64 data must be 4 * n bytes,
888 so pad is used to adjust size.
890 These 65 characters are subset of all versions of ISO 646, including
891 US-ASCII, and all versions of EBCDIC. So it is safe even if it is
892 translated by non-Internet gateways.
898 Any byte stream is called <concept>binary</concept>.
900 It does not require structureof lines. It differs from from <a
901 node="8bit">8bit</a>.
903 In addition, if line structured data contain too long line (more than
904 998 bytes), it is regarded as binary.
907 <h3> Coded character set, Character code
908 <node> coded character set
910 A set of unambiguous rules that establishes a character set and the
911 one-to-one relationship between the characters of the set and their
918 <concept>media-type</concept> specifies the nature of the data in the
919 body of <dref>MIME</dref> <dref>entity</dref>. It consists of
920 <concept>type</concept> and <concept>subtype</concept>. It is defined
921 in <dref>RFC 2046</dref>.
923 Currently there are following standard primary-types:
926 <li><concept>text</concept>
928 <li><concept>image</concept>
930 <li><concept>audio</concept>
932 <li><concept>video</concept>
934 <li><concept>application</concept>
936 <li><a node="multipart"><concept>multipart</concept></a>
938 <li><concept>message</concept>
942 And there are various subtypes, for example, application/octet-stream,
943 audio/basic, image/jpeg, <dref>multipart/mixed</dref>,
944 <dref>text/plain</dref>, video/mpeg...
947 You can refer registered media types at <a
948 href="ftp://ftp.isi.edu/in-notes/iana/assignments/media-types">MEDIA
951 In addition, you can use private type or subtype using
952 <concept>x-token</concept>, which as the prefix `x-'. However you can
953 not use them in public.
955 <cf node="Content-Type field">
961 In this document, it means mail defined in <dref>RFC 822</dref> and
962 news message defined in <dref>RFC 1036</dref>.
968 MIME stands for <concept>Multipurpose Internet Mail
969 Extensions</concept>, it is an extension for <dref>RFC 822</dref>.
971 According to RFC 2045:
973 STD 11, RFC 822, defines a message representation protocol specifying
974 considerable detail about US-ASCII message headers, and leaves the
975 message content, or message body, as flat US-ASCII text. This set of
976 documents, collectively called the Multipurpose Internet Mail
977 Extensions, or MIME, redefines the format of messages to allow for
980 <li>textual message bodies in character sets other than US-ASCII,
982 <li>an extensible set of different formats for non-textual message
985 <li>multi-part message bodies, and
987 <li>textual header information in character sets other than US-ASCII.
991 It is defined in <dref>RFC 2045</dref>, <dref>RFC 2046</dref>, <a
992 node="encoded-word">RFC 2047</a>, <dref>RFC 2048</dref> and <dref>RFC
999 <a node="coded character set">Coded character set</a> used in
1000 <dref>Content-Type field</dref> or charset parameter of <a
1001 node="encoded-word">encoded-word</a>.
1003 It is defined in <dref>RFC 2045</dref>.
1005 <dref>iso-2022-jp</dref> or <dref>euc-kr</dref> are kinds of it. (In
1006 this document, MIME charsets are written by small letters to
1007 distinguish <dref>graphic character set</dref>. For example, ISO
1008 8859-1 is a graphic character set, and iso-8859-1 is a MIME charset)
1014 <concept>Message Transfer Agent</concept>. It means mail transfer
1015 programs (ex. sendmail) and news servers.
1023 <concept>Message User Agent</concept>. It means mail readers and news
1029 <h3> Quoted-Printable
1030 <node> Quoted-Printable
1032 <concept>Quoted-Printable</concept> is a transfer encoding method of
1033 <dref>MIME</dref> defined in <dref>RFC 2045</dref>.
1035 If the data being encoded are mostly US-ASCII text, the encoded form
1036 of the data remains largely recognizable by humans.
1044 A RFC defines format of Internet mail message, mainly <concept>message
1049 news message is based on RFC 822, so <concept>Internet
1050 message</concept> may be more suitable than <concept>Internet
1054 <rfc number="822" type="STD 11" author="D. Crocker" title="Standard
1055 for the Format of ARPA Internet Text Messages"
1062 A RFC defines format of USENET message. It is a subset of <dref>RFC
1063 822</dref>. It is not Internet standard, but a lot of netnews
1064 excepting Usenet uses it.
1066 <rfc name="USENET" number="1036" author="M. Horton and R. Adams"
1067 title="Standard for Interchange of USENET Messages"
1068 date="December 1987" obsolete="850">
1074 <rfc number="2045" type="Standards Track" author="N. Freed and
1075 N. Borenstein" title="Multipurpose Internet Mail
1076 Extensions (MIME) Part One: Format of Internet Message
1077 Bodies" date="November 1996" obsolete="1521, 1522,
1084 <rfc number="2046" type="Standards Track" author="N. Freed and
1085 N. Borenstein" title="Multipurpose Internet Mail
1086 Extensions (MIME) Part Two: Media Types"
1087 date="November 1996" obsolete="1521, 1522, 1590">
1093 <rfc number="2048" type="Standards Track" author="N. Freed, J. Klensin
1094 and J. Postel" title="Multipurpose Internet Mail
1095 Extensions (MIME) Part Four: Registration Procedures"
1096 date="November 1996" obsolete="1521, 1522, 1590">
1102 <rfc number="2049" type="Standards Track" author="N. Freed and
1103 N. Borenstein" title="Multipurpose Internet Mail
1104 Extensions (MIME) Part Five: Conformance Criteria and
1105 Examples" date="November 1996" obsolete="1521, 1522,
1112 A textual data represented by only <dref>coded character set</dref>.
1113 It does not have information about font or typesetting.
1114 <cf node="text/plain">
1120 A <a node="MIME charset">MIME charset</a> for primary Latin script
1121 mainly written by English or other languages.
1123 It is a 7bit <dref>coded character set</dref> based on <dref>ISO
1124 2022</dref>, it contains only
1125 <dref>ASCII</dref> and <dref>code extension</dref> is not allowed.
1127 It is standard coded character set of Internet mail. If MIME charset
1128 is not specified, <concept>us-ascii</concept> is used as default.
1130 In addition, <concept>ASCII</concept> of <dref>RFC 822</dref> should
1131 be interpreted as us-ascii.
1134 <h2> How to report bugs
1137 If you write bug-reports and/or suggestions for improvement, please
1138 send them to the tm Mailing List:
1141 <li> Japanese <mail>bug-tm-ja@chamonix.jaist.ac.jp</mail>
1142 <li> English <mail>bug-tm-en@chamonix.jaist.ac.jp</mail>
1146 Notice that, we do not welcome bug reports about too old version.
1147 Bugs in old version might be fixed. So please try latest version at
1150 You should write <concept>good bug report</concept>. If you write
1151 only ``FLIM does not work'', we can not find such situations. At
1152 least, you should write name, type, variants and version of OS, emacs,
1153 APEL, FLIM, SEMI and MUA, and setting. In addition, if error occurs,
1154 to send backtrace is very important. <cf file="emacs" node="Bugs">
1156 Bug may not appear only your environment, but also in a lot of
1157 environment (otherwise it might not bug). Therefor if you send mail
1158 to author directly, we must write a lot of mails. So please send mail
1159 to address for tm bugs instead of author.
1162 Via the tm ML, you can report FLIM bugs, obtain the latest release of
1163 FLIM, and discuss future enhancements to FLIM. To join the tm ML,
1164 send empty e-mail to:
1167 <li> Japanese <mail>tm-ja-help@chamonix.jaist.ac.jp</mail>
1168 <li> English <mail>tm-en-help@chamonix.jaist.ac.jp</mail>
1172 <h2> CVS based development
1175 FLIM
\e$B$N
\e(B file
\e$B$O
\e(B CVS
\e$B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K!$G:G
\e(B
1176 \e$B?7$N
\e(B FLIM
\e$B$rF~<j$9$k$3$H$,$G$-$^$9!'
\e(B
1181 % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
1184 CVS password: [CR] # NULL string
1188 % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \
1189 checkout [-r TAG] flim
1193 CVS
\e$B$rMQ$$$?3+H/$K;22C$7$?$$J}$O
\e(B
1196 <li> <mail>cvs@chamonix.jaist.ac.jp</mail>
1200 \e$B$^$G!"
\e(Baccount
\e$BL>$H
\e(B UNIX
\e$B$N
\e(B passwd
\e$B$HF1$87A<0$N
\e(B crypt
\e$B2=$5$l$?
\e(B password
1201 \e$B$r1h$($F8fO"Mm$/$@$5$$!#
\e(B
1204 <h2> History of FLIM
1207 FLIM
\e$B$N
\e(B code
\e$B$N:G8E$NItJ,$O
\e(B
\e$B1]JB
\e(B
\e$B;LCR
\e(B
\e$B;a$,=q$$$?
\e(B <file>mime.el</file>
1208 \e$B$K5/8;$7$^$9!#$3$N>.$5$J
\e(B program
\e$B$O
\e(B Nemacs
\e$B$GF0:n$9$k
\e(B iso-2022-jp
\e$B$N
\e(B
1209 B-encoding
\e$B@lMQ$N
\e(B encoded-word
\e$B$NI|9f2=%W%m%0%i%`$G$7$?!#
\e(B
1211 \e$B$=$N8e!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$O
\e(B <file>mime.el</file>
\e$B$r85$K
\e(B
1212 <file>tiny-mime.el</file>
\e$B$H$$$&%W%m%0%i%`$r=q$-$^$9!#$3$l$O!"
\e(BNemacs
1213 \e$B$H
\e(B Mule
\e$B$GF0:n$9$k
\e(B encoded-word
\e$B$NId9f2=!&I|9f2=%W%m%0%i%`$G$7$?!#
\e(B
1214 <file>tiny-mime.el</file>
\e$B$O
\e(B B-encoding
\e$B$@$1$G$J$/
\e(B Q-encoding
\e$B$b
\e(B
1215 support
\e$B$7!"$^$?!"
\e(BMULE
\e$B$G07$&$3$H$,$G$-$k$5$^$6$^$J
\e(B <dref>MIME
1216 charset</dref>
\e$B$rF1;~$K;H$&$3$H$,$G$-$^$7$?!#$3$N;~!"
\e(BNemacs
\e$B$H
\e(B Mule
\e$B$N
\e(B
1217 \e$BAPJ}$r
\e(B support
\e$B$9$k$?$a$KMQ$$$i$l$?%F%/%K%C%/$O8e$K
\e(B emu package
\e$B$K$^$H
\e(B
1218 \e$B$a$i$l$^$9!#
\e(B
1220 \e$B$3$N:"!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$O
\e(B <file>tiny-mime.el</file>
\e$B$r$5$^$6$^$J
\e(B MUA
\e$B$G;H$&
\e(B
1221 \e$B$?$a$N@_Dj=8$bG[I[$7$F$$$^$7$?$,!"$=$l$i$O8e$K
\e(B
1222 <file>tiny-mime.el</file>
\e$B$H$H$b$K#1$D$N
\e(B package
\e$B$K$^$H$a$i$l!"
\e(Btm
\e$B$H$$
\e(B
1223 \e$B$&L>A0$GG[I[$5$l$^$9!#
\e(B
1225 \e$B<i2,
\e(B
\e$BCNI'
\e(B
\e$B$O$d$,$F!"
\e(BMIME message
\e$B$r1\Mw$9$k$?$a$N%W%m%0%i%`$G$"$k
\e(B
1226 <file>tm-body.el</file>
\e$B$r=q$-$^$9!#$3$l$O!"$9$0$K
\e(B
1227 <file>tm-view.el</file>
\e$B$H$$$&L>A0$KJQ$o$j$^$7$?$,!"$d$,$F!"$3$l$,
\e(B
1228 <file>tiny-mime.el</file>
\e$B$KBe$o$C$F!"
\e(Btm
\e$B$NCf3K$H$J$j$^$9!#
\e(B
1230 <file>tm-view.el</file>
\e$B$OEvA3!"
\e(BContent-Transfer-Encoding
\e$B$r07$&I,MW$,
\e(B
1231 \e$B$"$j$^$9!#$3$NL\E*$N$?$a$K!"
\e(BMEL
\e$B$,@0Hw$5$l$O$8$a$^$7$?!#
\e(BBase64
\e$B$K4X$7
\e(B
1232 \e$B$F$O
\e(B <file>tiny-mime.el</file>
\e$B$N
\e(B code
\e$B$,0\$5$l!"$^$?!"?7$?$K
\e(B
1233 Quoted-Printable
\e$B$N
\e(B code
\e$B$,DI2C$5$l$^$7$?!#$3$l$i$,
\e(B
1234 <file>mel-b.el</file>
\e$B$H
\e(B <file>mel-q.el</file>
\e$B$K$J$j$^$7$?!#
\e(B
1236 \e$B$^$?!"8e$K!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$K$h$C$F
\e(B uuencode
\e$BMQ$N
\e(B <file>mel-u.el</file>
\e$B$,
\e(B
1237 \e$BDI2C$5$l!"$=$N8e$K!">.NS
\e(B
\e$B=$J?
\e(B
\e$B;a$K$h$C$F
\e(B x-gzip64
\e$BMQ$N
\e(B
1238 <file>mel-g.el</file>
\e$B$,DI2C$5$l$^$7$?!#
\e(B
1240 tm
\e$B$G$O8e$K!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$K$h$C$F
\e(B <file>tiny-mime.el</file>
\e$B$N:F<BAu$,9T
\e(B
1241 \e$B$o$l!"$3$N2aDx$G!"
\e(BSTD 11
\e$B$N
\e(B parser
\e$B$,=q$+$l$^$7$?!#$3$l$O!"8=:_$N
\e(B
1242 <file>std11.el</file>
\e$B$KEv$?$j$^$9!#$^$?!"$3$N2aDx$G
\e(B
1243 <file>tiny-mime.el</file>
\e$B$OI|9f2=$r9T$&
\e(B <file>tm-ew-d.el</file>
\e$B$HId
\e(B
1244 \e$B9f2=$r9T$&
\e(B <file>tm-ew-e.el</file>
\e$B$KJ,$1$i$l$^$7$?!#$3$NN><T$,8=:_$N
\e(B
1245 <file>eword-decode.el</file>
\e$B$H
\e(B <file>eword-encode.el</file>
\e$B$N@hAD$K
\e(B
1246 \e$BEv$?$j$^$9!#
\e(B
1248 \e$B8e$K!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$i$K$h$C$F
\e(B tm
\e$B$NA4LL=q$-49$(:n6H$,9T$o$l!"$3$N2aDx$G!"
\e(B
1249 tm
\e$B$O
\e(B APEL, MEL, SEMI, EMH, RMAIL-MIME, Gnus-MIME
\e$B$J$I$KJ,$1$i$l$^$7$?!#
\e(B
1250 \e$B$3$N$&$A$N
\e(B MEL
\e$B$,
\e(B FLIM
\e$B$ND>@\$N@hAD$KEv$?$j$^$9!#
\e(B
1252 \e$B8e$K!"
\e(BAPEL
\e$B$+$i
\e(B <file>std11.el</file>
\e$B$,0\$5$l!"$^$?!"
\e(B
1253 <file>mailcap.el</file>, <file>eword-decode.el</file>
\e$B$*$h$S
\e(B
1254 <file>eword-encode.el</file>
\e$B$,
\e(B SEMI
\e$B$+$i0\$5$l!"
\e(Bpackage
\e$B$NL>A0$,
\e(B FLIM
1255 \e$B$H$J$j$^$9!#
\e(B
1257 \e$B$3$ND>A0$+$iEDCf
\e(B
\e$BE/
\e(B
\e$B;a$,$h$j
\e(B RFC
\e$B$KCi<B$J<BAu$r=q$-;O$a!"$3$l$O!"8=:_!"
\e(B
1258 FLIM
\e$B$N;^$G$"$k
\e(B ``FLIM-FLAM''
\e$B$H$J$C$F$$$^$9!#
\e(B
1262 <node> Concept Index
1268 <node> Function Index
1274 <node> Variable Index