2 @setfilename mime-en.info
3 @settitle{FLIM 1.10 Manual about MIME Features}
5 @title FLIM 1.10 Manual about MIME Features
6 @author MORIOKA Tomohiko <morioka@@jaist.ac.jp>
9 @node Top, Introduction, (dir), (dir)
10 @top FLIM 1.10 Manual about MIME Features
14 This file documents MIME features of FLIM, a Internet message
15 parsing/encoding library for GNU Emacs.
19 * Introduction:: What is FLIM?
20 * How to use:: How to use MIME features
21 * Entity:: Message and Entity
22 * Content-Type:: Information of Content-Type field
23 * Content-Disposition:: Information of Content-Disposition field
24 * Content-Transfer-Encoding:: Encoding Method
25 * encoded-word:: Network representation of header
26 * custom:: Various Customization
33 @node Introduction, How to use, Top, Top
34 @chapter What is FLIM?
36 FLIM is a library to provide basic features about message
37 representation or encoding.
40 @node How to use, Entity, Introduction, Top
41 @chapter How to use MIME features
43 Please eval following to use MIME features provided by FLIM:
51 @node Entity, Content-Type, How to use, Top
52 @chapter Message and Entity
56 According to RFC 2045 (@ref{RFC 2045}), `The term ``entity'', refers
57 specifically to the MIME-defined header fields and contents of either a
58 message or one of the parts in the body of a multipart entity.' In this
59 document, the term @strong{entity} indicates all of header fields and
62 The definition of RFC 2045 indicates that a MIME message is a tree, and
63 each node of the tree is an entity. Namely MIME extends message to tree
66 FLIM uses @strong{mime-entity} structure to represent
67 information of entity. In this document, it is called simply
72 * Entity creation:: Functions to create mime-entity
73 * Entity hierarchy:: Features about message tree
74 * Entity Attributes:: Functions about attributes of mime-entity
75 * Entity-header:: Information of entity header
76 * Entity-content:: Contents of Entity
77 * Entity buffer:: Entity as buffer representation
78 * mm-backend:: Entity representations and implementations
81 @node Entity creation, Entity hierarchy, Entity, Entity
82 @section Functions to create mime-entity
84 @defun mime-open-entity &optional type location
86 Open an entity and return it.@refill
88 @var{type} is representation-type. (cf. @ref{mm-backend}) @refill
90 @var{location} is location of entity. Specification of it is depended
91 on representation-type.
95 @defun mime-parse-buffer &optional buffer type
97 Parse @var{buffer} as message, and set the result to buffer local
98 variable @code{mime-message-structure} of @var{buffer} as
101 If @var{buffer} is omitted, current buffer is used.@refill
103 @var{type} is representation-type of created
104 mime-entity. (cf. @ref{mm-backend}) Default value is @var{buffer}.
109 @node Entity hierarchy, Entity Attributes, Entity creation, Entity
110 @section Features about message tree
112 @cindex entity-number
116 Structure of a MIME message is tree.@refill
118 In the tree, root node is the entity indicates all of the message. In
119 this document, it is called @strong{root-entity} or @strong{message}.
120 In FLIM, it is indicated by buffer local variable
121 @code{mime-message-structure}.@refill
123 Each entity except root-entity has a parent. An entity may have
124 children. We can indicate an entity by relative position from a base
125 entity, based on the parent-child relationship.@refill
127 In addition, we can indicate an entity by absolute position of the
130 Each entity, which is a node of the tree, can be numbered by
131 depth and left-to-right order of the depth.
137 +-------------------+-------------------+
141 | +---------+---------+ |
142 +--+--+ +--+--+ +--+--+ +--+--+ +--+--+
143 | 0.0 | | 1.0 | | 1.1 | | 1.2 | | 2.0 |
144 +-----+ +-----+ +-----+ +-----+ +-----+
147 Namely, if depth of a node is n, the node has a node-number, which is
148 consists of n integers. In this document, it is called
149 @strong{entity-number}. An entity-number is represented by list of
150 integer, like @code{(1 2 3)}.@refill
152 mime-entity has also @strong{node-id}. A node-id is represented by
153 reversed list of entity-number. For example, node-id corresponding with
154 1.2.3 is @code{(3 2 1)}.@refill
156 Each entity can be indicated by entity-number or node-id in
157 @code{mime-message-structure}.
159 @defvar mime-message-structure
161 Buffer local variable to store mime-entity structure of message.
165 @defun mime-entity-children entity
167 Return list of entities included in the @var{entity}.
171 @defun mime-entity-parent entity &optional message
173 Return parent entity of the @var{entity}.@refill
175 If @var{message} is specified, it is regarded as root instead of
176 @code{mime-message-structure}.
180 @defun mime-root-entity-p entity
182 Return non-@code{nil} if @var{entity} is root entity (message).
186 @defun mime-entity-node-id entity
188 Return node-id of @var{entity}.
192 @defun mime-entity-number entity
194 Return entity-number of @var{entity}.
198 @defun mime-find-entity-from-number entity-number &optional message
200 Return entity from @var{entity-number} in @var{message}.@refill
202 If @var{message} is not specified, @code{mime-message-structure} is
207 @defun mime-find-entity-from-node-id entity-node-id &optional message
209 Return entity from @var{entity-node-id} in @var{message}.@refill
211 If @var{message} is not specified, @code{mime-message-structure} is
217 @node Entity Attributes, Entity-header, Entity hierarchy, Entity
218 @section Functions about attributes of mime-entity
220 @defun mime-entity-content-type entity
222 Return content-type of @var{entity}. (cf. @ref{mime-content-type})
226 @defun mime-entity-content-disposition entity
228 Return content-disposition of
229 @var{entity}. (cf. @ref{mime-content-disposition})
233 @defun mime-entity-filename entity
235 Return file name of @var{entity}.
239 @defun mime-entity-encoding entity &optional default-encoding
241 Return content-transfer-encoding of @var{entity}.
242 (cf. @ref{Content-Transfer-Encoding}) @refill
244 If the @var{entity} does not have Content-Transfer-Encoding field, this
245 function returns @var{default-encoding}. If it is nil, @code{"7bit"} is
246 used as default value.
250 @defun mime-entity-cooked-p entity
252 Return non-nil if contents of @var{entity} has been already
258 @node Entity-header, Entity-content, Entity Attributes, Entity
259 @section Information of entity header
261 @defun mime-fetch-field field-name &optional entity
263 Return field-body of @var{field-name} field in header of
266 The results is network representation.@refill
268 If @var{entity} is omitted, @code{mime-message-structure} is used as
269 default value.@refill
271 If @var{field-name} field is not found, this function returns
276 @defun mime-read-field field-name &optional entity
278 Parse @var{field-name} field in header of @var{entity}, and return the
281 Format of result is depended on kind of field. For non-structured
282 field, this function returns string. For structured field, it returns
283 list corresponding with structure of the field.@refill
285 Strings in the result will be converted to internal representation of
288 If @var{entity} is omitted, @code{mime-message-structure} is used as
289 default value.@refill
291 If @var{field-name} field is not found, this function returns
296 @defun mime-insert-decoded-header entity &optional invisible-fields visible-fields
298 Insert before point a decoded contents of header of @var{entity}.@refill
300 @var{invisible-fields} is list of regexps to match field-name to hide.
301 @var{visible-fields} is list of regexps to match field-name to
304 If a field-name is matched with some elements of @var{invisible-fields}
305 and matched with none of @var{visible-fields}, this function don't
311 @node Entity-content, Entity buffer, Entity-header, Entity
312 @section Contents of Entity
314 @defun mime-entity-content entity
316 Return content of @var{entity} as byte sequence.
320 @defun mime-write-entity-content entity filename
322 Write content of @var{entity} into @var{filename}.
326 @defun mime-write-entity entity filename
328 Write representation of @var{entity} into @var{filename}.
332 @defun mime-write-entity-body entity filename
334 Write body of @var{entity} into @var{filename}.
339 @node Entity buffer, mm-backend, Entity-content, Entity
340 @section Entity as buffer representation
342 @defun mime-entity-buffer entity
344 Return buffer, which contains @var{entity}.
348 @defun mime-entity-point-min entity
350 Return the start point of @var{entity} in the buffer which contains
355 @defun mime-entity-point-max entity
357 Return the end point of @var{entity} in the buffer which contains
362 @defun mime-entity-header-start entity
364 Return the start point of header of @var{entity} in the buffer which
365 contains @var{entity}.
369 @defun mime-entity-header-end entity
371 Return the end point of header of @var{entity} in the buffer which
372 contains @var{entity}.
376 @defun mime-entity-body-start entity
378 Return the start point of body of @var{entity} in the buffer which
379 contains @var{entity}.
383 @defun mime-entity-body-end entity
385 Return the end point of body of @var{entity} in the buffer which
386 contains @var{entity}.
391 @node mm-backend, , Entity buffer, Entity
392 @section Entity representations and implementations
394 @cindex entity processing method
395 @cindex representation-type
397 Entity is an abstraction. It is designed to use various data
398 representations for their purposes.@refill
400 Each entity has @strong{representation-type}. It must be specified when
401 an entity is created. (cf. @ref{Entity Creation}) @refill
403 Functions about entity are implemented by request processing to the
404 entity. Each entity knows its representation-type. Each entity calls
405 processing function corresponding with the representation-type. Such
406 kind of function is called @strong{entity processing method}. A module,
407 consists of them corresponding with a representation-type, is called
408 @strong{mm-backend}.@refill
410 Module name of each mm-backend consists of the prefix @code{mm}
411 and its representation-type. The module is required automatically
412 when its entity is created at first.
416 * Request for entity:: Message-passing for entity
417 * mm-backend module:: Definition of mm-backend
420 @node Request for entity, mm-backend module, mm-backend, mm-backend
421 @subsection Message-passing for entity
423 @defun mime-entity-send entity message &rest args
425 Send @var{message} to @var{entity} with @var{args}, and return the
428 @var{args} is arguments of the @var{message}.
433 @node mm-backend module, , Request for entity, mm-backend
434 @subsection Definition of mm-backend
436 @defmac mm-define-backend type &optional parents
438 Define @var{type} as a mm-backend.@refill
440 If @var{PARENTS} is specified, @var{type} inherits parents. Each parent
441 must be representation-type.@refill
446 (mm-define-backend chao (generic))
451 @defmac mm-define-method name args &rest body
453 Define @var{name} as a method function of (nth 1 (car @var{args}))
456 @var{args} is like an argument list of lambda, but (car @var{args}) must
457 be specialized parameter. (car (car @var{args})) is name of variable
458 and (nth 1 (car @var{args})) is name of backend
459 (representation-type).@refill
464 (mm-define-method entity-cooked-p ((entity chao)) nil)
470 @node Content-Type, Content-Disposition, Entity, Top
471 @chapter Information of Content-Type field
472 @cindex mime-content-type
473 @cindex Content-Type field
475 @strong{Content-Type field} is a field to indicate kind of contents or
476 data format, such as media-type (@ref{media-type}) and MIME charset. It
477 is defined in RFC 2045 (@ref{RFC 2045}).
483 Historically, Content-Type field was proposed in RFC 1049. In it,
484 Content-Type did not distinguish type and subtype, and there are no
485 mechanism to represent kind of character code like MIME charset.
489 FLIM provides parser for Content-Type field and structure
490 @strong{mime-content-type} to store information of
495 * Content-Type field:: Format of Content-Type field
496 * mime-content-type:: mime-content-type structure
497 * Content-Type parser:: Parser
498 * Content-Type utility:: Utility functions
501 @node Content-Type field, mime-content-type, Content-Type, Content-Type
502 @section Format of Content-Type field
507 Format of Content-Type field is defined as follows:
510 ``Content-Type'' ``:'' @strong{type} ``/''
511 @strong{subtype} *( ``;'' @strong{parameter} )
518 Content-Type: image/jpeg
525 Content-Type: text/plain; charset=iso-2022-jp
529 `type' and `subtype' indicate format of an entity. In this document,
530 pair of them is called `media-type'. `image/jpeg' or `text/plain' is
537 If an entity does not have Content-Type field, it is regarded as
542 Content-Type: text/plain; charset=us-ascii
552 @node mime-content-type, Content-Type parser, Content-Type field, Content-Type
553 @section mime-content-type structure
555 @deffn{Structure} mime-content-type
557 Structure to store information of a Content-Type field.@refill
559 Applications should use reference functions
560 @code{mime-content-type-SLOT} to refer information of the
563 Slots of the structure are following:
567 primary type of media-type (symbol).
570 subtype of media-type (symbol).
573 parameters of Content-Type field (association-list).
579 @defun make-mime-content-type type subtype
582 Constructor of content-type.
586 @defun mime-content-type-parameter content-type parameter
588 Return value of @var{parameter} of @var{content-type}.
593 @node Content-Type parser, Content-Type utility, mime-content-type, Content-Type
596 @defun mime-parse-Content-Type string
598 Parse @var{string} as field-body of Content-Type field.
602 @defun mime-read-Content-Type
604 Read field-body of Content-Type field from current-buffer, and return
607 Return @code{nil} if Content-Type field is not found.
612 @node Content-Type utility, , Content-Type parser, Content-Type
613 @section Utility functions
615 @defun mime-type/subtype-string type &optional subtype
617 Return type/subtype string from @var{type} and @var{subtype}.
622 @node Content-Disposition, Content-Transfer-Encoding, Content-Type, Top
623 @chapter Information of Content-Disposition field
624 @cindex mime-content-disposition
626 @cindex Standards Track
627 @cindex Content-Disposition field
629 @strong{Content-Disposition field} is an optional field to
630 specify presentation of an entity or attributes of an entity, such as
637 S. Dorner, K. Moore and R. Troost, ``Communicating Presentation
638 Information in Internet Messages: The Content-Disposition Header'',
639 August 1997, Standards Track.
642 FLIM provides parser for Content-Disposition field and structure
643 @strong{mime-content-disposition} to store information of
644 Content-Disposition field.
648 * mime-content-disposition:: mime-content-disposition structure
649 * Content-Disposition parser:: Parser for Content-Disposition field
652 @node mime-content-disposition, Content-Disposition parser, Content-Disposition, Content-Disposition
653 @section mime-content-disposition structure
655 @deffn{Structure} mime-content-disposition
657 Structure to store information of a Content-Disposition field.@refill
659 Applications should use reference functions
660 @code{mime-content-disposition-SLOT} to refer information of the
663 Slots of the structure are following:
666 @item disposition-type
667 disposition-type (symbol).
670 parameters of Content-Disposition field
677 @defun mime-content-disposition-parameter content-disposition parameter
679 Return value of @var{parameter} of @var{content-disposition}.
683 @defun mime-content-disposition-filename content-disposition
685 Return filename of @var{content-disposition}.
690 @node Content-Disposition parser, , mime-content-disposition, Content-Disposition
691 @section Parser for Content-Disposition field
693 @defun mime-parse-Content-Disposition string
695 Parse @var{string} as field-body of Content-Disposition field, and
700 @defun mime-read-Content-Disposition
702 Read field-body of Content-Disposition field from current-buffer,@refill
704 Return nil if Content-Disposition field is not found.
709 @node Content-Transfer-Encoding, encoded-word, Content-Disposition, Top
710 @chapter Encoding Method
711 @cindex Content-Transfer-Encoding field
713 @strong{Content-Transfer-Encoding field} is a header field to indicate
714 body encoding of a entity.@refill
716 FLIM provides parser functions for Content-Transfer-Encoding field.
717 They represent information of Content-Transfer-Encoding field as
720 In addition, FLIM provides encoder/decoder functions by
721 Content-Transfer-Encoding.
725 * Content-Transfer-Encoding parser:: Parser
726 * encoder/decoder:: Encoder/decoder
727 * Encoding information:: Other utilities
728 * mel-backend:: How to write encoder/decoder module
729 * generic function for mel-backend:: How to add encoding/decoding service
732 @node Content-Transfer-Encoding parser, encoder/decoder, Content-Transfer-Encoding, Content-Transfer-Encoding
735 @defun mime-parse-Content-Transfer-Encoding string
737 @var{string}
\e$B$r
\e(B content-transfer-encoding
\e$B$H$7$F2r@O$7$?7k2L$rJV$9!#
\e(B
741 @defun mime-read-Content-Transfer-Encoding &optional default-encoding
743 \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
744 \e$BJV$9!#
\e(B@refill
746 Content-Transfer-Encoding
\e$BMs$,B8:_$7$J$$>l9g$O
\e(B@var{default-encoding}
\e$B$r
\e(B
752 @node encoder/decoder, Encoding information, Content-Transfer-Encoding parser, Content-Transfer-Encoding
753 @section Encoder/decoder
755 @defun mime-encode-region start end encoding
757 Encode region @var{start} to @var{end} of current buffer using
762 @defun mime-decode-region start end encoding
764 Decode region @var{start} to @var{end} of current buffer using
770 @defun mime-decode-string string encoding
772 @var{string}
\e$B$r
\e(B @var{encoding}
\e$B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#
\e(B
777 @defun mime-insert-encoded-file filename encoding
779 Insert file @var{FILENAME} encoded by @var{ENCODING} format.
783 @defun mime-write-decoded-region start end filename encoding
785 Decode and write current region encoded by @var{encoding} into
786 @var{filename}.@refill
788 @var{start} and @var{end} are buffer positions.
793 @node Encoding information, mel-backend, encoder/decoder, Content-Transfer-Encoding
794 @section Other utilities
796 @defun mime-encoding-list &optional SERVICE
798 Return list of Content-Transfer-Encoding.@refill
800 If @var{service} is specified, it returns available list of
801 Content-Transfer-Encoding for it.
805 @defun mime-encoding-alist &optional SERVICE
807 Return table of Content-Transfer-Encoding for completion.@refill
809 If @var{service} is specified, it returns available list of
810 Content-Transfer-Encoding for it.
815 @node mel-backend, generic function for mel-backend, Encoding information, Content-Transfer-Encoding
816 @section How to write encoder/decoder module
818 @defmac mel-define-method name args &rest body
820 Define @var{name} as a method function of (nth 1 (car (last
821 @var{args}))) backend.@refill
823 @var{args} is like an argument list of lambda, but (car (last
824 @var{args})) must be specialized parameter. (car (car (last
825 @var{args}))) is name of variable and (nth 1 (car (last @var{args}))) is
826 name of backend (encoding).@refill
831 (mel-define-method mime-write-decoded-region (start end filename
833 "Decode and write current region encoded by base64 into FILENAME.
834 START and END are buffer positions."
836 (list (region-beginning) (region-end)
837 (read-file-name "Write decoded region to file: ")))
838 (let ((str (buffer-substring start end)))
840 (insert (decode-base64-string str))
841 (write-region-as-binary (point-min) (point-max) filename)
847 @defmac mel-define-method-function spec function
849 Set @var{spec}'s function definition to @var{function}.@refill
851 First element of @var{spec} is service.@refill
853 Rest of @var{args} is like an argument list of lambda, but (car (last
854 @var{args})) must be specialized parameter. (car (car (last
855 @var{args}))) is name of variable and (nth 1 (car (last @var{args}))) is
856 name of backend (encoding).@refill
861 (mel-define-method-function (mime-encode-string string (nil "base64"))
862 'encode-base64-string)
868 @node generic function for mel-backend, , mel-backend, Content-Transfer-Encoding
869 @section How to add encoding/decoding service
871 @defmac mel-define-service name &optional args doc-string
873 Define @var{name} as a service for Content-Transfer-Encodings.@refill
875 If @var{args} is specified, @var{name} is defined as a generic function
876 for the service.@refill
881 (mel-define-service encoded-text-encode-string (string encoding)
882 "Encode STRING as encoded-text using ENCODING.
883 ENCODING must be string.")
889 @node encoded-word, custom, Content-Transfer-Encoding, Top
890 @chapter Network representation of header
892 @cindex Standards Track
895 encoded-word
\e$B$O
\e(B header
\e$B$GHs
\e(B ASCII (@ref{ASCII})
\e$BJ8;z$rI=8=$9$k$?$a$N7A<0
\e(B
896 \e$B$G!"
\e(B@strong{RFC 2047}
\e$B$GDj5A$5$l$F$$$^$9!#
\e(B@refill
902 K. Moore, ``MIME (Multipurpose Internet Mail Extensions) Part Three:
903 Message Header Extensions for Non-ASCII Text'', November 1996, Standards
904 Track (obsolete RFC 1521,1522,1590).
907 \e$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"
\e(Bencoded-word
\e$B$rMQ$$$:$KHs
\e(B ASCII
908 (@ref{ASCII})
\e$BJ8;z$r
\e(B header
\e$B$KF~$l$?5-;v$bB8:_$7$^$9!#
\e(B@refill
910 FLIM
\e$B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#
\e(B
914 * Header encoder/decoder:: Header encoding/decoding
917 @node Header encoder/decoder, , encoded-word, encoded-word
918 @section Header encoding/decoding
920 @defun eword-encode-header &optional code-conversion separator
922 Decode MIME encoded-words in header fields.@refill
924 If @var{code-conversion} is @code{nil}, it decodes only encoded-words.
925 If it is mime-charset, it decodes non-ASCII bit patterns as the
926 mime-charset. Otherwise it decodes non-ASCII bit patterns as the
927 default-mime-charset.@refill
929 If @var{separator} is not nil, it is used as header separator.
933 @defun eword-encode-header &optional code-conversion
935 Encode header fields to network representation, such as MIME
938 It refer variable @code{eword-field-encoding-method-alist}.
943 @node custom, Appendix, encoded-word, Top
944 @chapter Various Customization
948 MIME
\e$B4XO"5!G=$K4X$9$k
\e(B group.@refill
950 @code{mail}
\e$B$H
\e(B @code{news}
\e$B$KB0$9$k!#
\e(B
954 @defvar default-mime-charset
956 \e$BE,@Z$J
\e(B MIME charset (@ref{MIME charset})
\e$B$,8+$D$+$i$J$+$C$?>l9g$KMQ$$$i
\e(B
957 \e$B$l$k
\e(BMIME charset.@refill
959 \e$BK\Mh$O
\e(B APEL
\e$B$NJQ?t$G$"$k!#
\e(B
963 @defvar mime-temp-directory
965 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
968 \e$B4D6-JQ?t
\e(B @code{MIME_TMP_DIR}, @code{TM_TMP_DIR}, @code{TMPDIR},
969 @code{TMP}
\e$B$b$7$/$O
\e(B @code{TEMP}
\e$B$,@_Dj$5$l$F$$$?>l9g!"$=$l$r=i4|CM$H$7$F
\e(B
970 \e$BMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"
\e(B@code{"/tmp/"}
\e$B$rMQ$$$k!#
\e(B
975 @node Appendix, Concept Index, custom, Top
981 * Bug report:: How to report bugs
982 * CVS:: CVS based development
983 * History:: History of FLIM
986 @node Glossary, Bug report, Appendix, Appendix
996 * coded character set:: Coded character set, Character code
1003 * Quoted-Printable::
1014 @node 7bit, 8bit, Glossary, Glossary
1016 @cindex 7bit (textual) string
1020 @strong{7bit} means any integer between 0 .. 127.@refill
1022 Any data represented by 7bit integers is called @strong{7bit data}.@refill
1024 Textual string consisted of Control characters between 0 .. 31 and 127,
1025 and space represented by 32, and graphic characters between 33 .. 236
1026 are called @strong{7bit (textual) string}.@refill
1028 Conventional Internet MTA (@ref{MTA}) can translate 7bit data, so it is
1029 no need to translate by Quoted-Printable (@ref{Quoted-Printable}) or
1030 Base64 (@ref{Base64}) for 7bit data.@refill
1032 However if there are too long lines, it can not translate by 7bit MTA
1033 even if it is 7bit data. RFC 821 (@ref{RFC 821}) and RFC 2045 (@ref{RFC 2045}) require lines in 7bit data must be less than 998 bytes. So if a
1034 ``7bit data'' has a line more than 999 bytes, it is regarded as binary
1035 (@ref{binary}). For example, Postscript file should be encoded by
1039 @node 8bit, ASCII, 7bit, Glossary
1041 @cindex 8bit (textual) string
1045 @strong{8bit} means any integer between 0 .. 255.@refill
1047 Any data represented by 8bit integers is called @strong{8bit data}.@refill
1049 Textual string consisted of Control characters between 0 .. 31, 127, and
1050 128 .. 159, and space represented by 32, and graphic characters between
1051 33 .. 236 and 160 .. 255 are called @strong{8bit (textual) string}.@refill
1053 For example, iso-8859-1 (@ref{iso-8859-1}) or euc-kr (@ref{euc-kr}) are
1054 coded-character-set represented by 8bit textual string.@refill
1056 Traditional Internet MTA (@ref{MTA}) can translate only 7bit
1057 (@ref{7bit}) data, so if a 8bit data will be translated such MTA, it
1058 must be encoded by Quoted-Printable (@ref{Quoted-Printable}) or Base64
1059 (@ref{Base64}).@refill
1061 However 8bit MTA are increasing today.@refill
1063 However if there are too long lines, it can not translate by 8bit MTA
1064 even if it is 8bit data. RFC 2045 (@ref{RFC 2045}) require lines in
1065 8bit data must be less than 998 bytes. So if a ``8bit data'' has a line
1066 more than 999 bytes, it is regarded as binary (@ref{binary}), so it must
1067 be encoded by Base64 or Quoted-Printable.
1070 @node ASCII, Base64, 8bit, Glossary
1072 @cindex ANSI X3.4:1986
1076 @strong{ASCII} is a 94-character set contains primary latin characters
1077 (A-Z, a-z), numbers and some characters. It is a standard of the United
1078 States of America. It is a variant of ISO 646 (@ref{ISO 646}).
1084 ``Coded Character Set -- 7-Bit American Standard Code for Information
1085 Interchange'', ANSI X3.4:1986.
1090 @node Base64, binary, ASCII, Glossary
1095 @strong{Base64} is a transfer encoding method of MIME (@ref{MIME})
1096 defined in RFC 2045 (@ref{RFC 2045}).@refill
1098 The encoding process represents 24-bit groups of input bits as output
1099 strings of 4 encoded characters. Encoded characters represent integer 0
1100 .. 63 or @strong{pad}. Base64 data must be 4 * n bytes, so pad is used
1101 to adjust size.@refill
1103 These 65 characters are subset of all versions of ISO 646, including
1104 US-ASCII, and all versions of EBCDIC. So it is safe even if it is
1105 translated by non-Internet gateways.
1108 @node binary, coded character set, Base64, Glossary
1112 Any byte stream is called @strong{binary}.@refill
1114 It does not require structureof lines. It differs from from 8bit
1115 (@ref{8bit}).@refill
1117 In addition, if line structured data contain too long line (more than
1118 998 bytes), it is regarded as binary.
1121 @node coded character set, media-type, binary, Glossary
1122 @subsection Coded character set, Character code
1124 A set of unambiguous rules that establishes a character set and the
1125 one-to-one relationship between the characters of the set and their
1129 @node media-type, message, coded character set, Glossary
1130 @subsection media-type
1143 @strong{media-type} specifies the nature of the data in the body of MIME
1144 (@ref{MIME}) entity (@ref{entity}). It consists of @strong{type} and
1145 @strong{subtype}. It is defined in RFC 2046 (@ref{RFC 2046}).@refill
1147 Currently there are following standard primary-types:
1159 @strong{application}
1161 @strong{multipart} (@ref{multipart})
1167 And there are various subtypes, for example, application/octet-stream,
1168 audio/basic, image/jpeg, multipart/mixed (@ref{multipart/mixed}),
1169 text/plain (@ref{text/plain}), video/mpeg... @refill
1171 You can refer registered media types at MEDIA TYPES
1172 (ftp://ftp.isi.edu/in-notes/iana/assignments/media-types).@refill
1174 In addition, you can use private type or subtype using @strong{x-token},
1175 which as the prefix `x-'. However you can not use them in
1178 (cf. @ref{Content-Type field})
1182 @node message, MIME, media-type, Glossary
1185 In this document, it means mail defined in RFC 822 (@ref{RFC 822}) and
1186 news message defined in RFC 1036 (@ref{RFC 1036}).
1189 @node MIME, MIME charset, message, Glossary
1191 @cindex Multipurpose Internet Mail Extensions
1193 MIME stands for @strong{Multipurpose Internet Mail Extensions}, it is an
1194 extension for RFC 822 (@ref{RFC 822}).@refill
1196 According to RFC 2045:@refill
1198 STD 11, RFC 822, defines a message representation protocol specifying
1199 considerable detail about US-ASCII message headers, and leaves the
1200 message content, or message body, as flat US-ASCII text. This set of
1201 documents, collectively called the Multipurpose Internet Mail
1202 Extensions, or MIME, redefines the format of messages to allow for
1206 textual message bodies in character sets other than US-ASCII,
1208 an extensible set of different formats for non-textual message
1211 multi-part message bodies, and
1213 textual header information in character sets other than US-ASCII.
1217 It is defined in RFC 2045 (@ref{RFC 2045}), RFC 2046 (@ref{RFC 2046}),
1218 RFC 2047 (@ref{encoded-word}), RFC 2048 (@ref{RFC 2048}) and RFC 2049
1222 @node MIME charset, MTA, MIME, Glossary
1223 @subsection MIME charset
1225 Coded character set (@ref{coded character set}) used in Content-Type
1226 field (@ref{Content-Type field}) or charset parameter of encoded-word
1227 (@ref{encoded-word}).@refill
1229 It is defined in RFC 2045 (@ref{RFC 2045}).@refill
1231 iso-2022-jp (@ref{iso-2022-jp}) or euc-kr (@ref{euc-kr}) are kinds of
1232 it. (In this document, MIME charsets are written by small letters to
1233 distinguish graphic character set (@ref{graphic character set}). For
1234 example, ISO 8859-1 is a graphic character set, and iso-8859-1 is a MIME
1238 @node MTA, MUA, MIME charset, Glossary
1240 @cindex Message Transfer Agent
1242 @strong{Message Transfer Agent}. It means mail transfer programs
1243 (ex. sendmail) and news servers.@refill
1249 @node MUA, Quoted-Printable, MTA, Glossary
1251 @cindex Message User Agent
1253 @strong{Message User Agent}. It means mail readers and news
1260 @node Quoted-Printable, RFC 822, MUA, Glossary
1261 @subsection Quoted-Printable
1262 @cindex Quoted-Printable
1264 @strong{Quoted-Printable} is a transfer encoding method of MIME
1265 (@ref{MIME}) defined in RFC 2045 (@ref{RFC 2045}).@refill
1267 If the data being encoded are mostly US-ASCII text, the encoded form of
1268 the data remains largely recognizable by humans.@refill
1274 @node RFC 822, RFC 1036, Quoted-Printable, Glossary
1278 @cindex Internet mail
1279 @cindex Internet message
1280 @cindex message header
1282 A RFC defines format of Internet mail message, mainly @strong{message header}.
1288 news message is based on RFC 822, so @strong{Internet message} may be
1289 more suitable than @strong{Internet mail} .
1297 D. Crocker, ``Standard for the Format of ARPA Internet Text Messages'',
1298 August 1982, STD 11.
1303 @node RFC 1036, RFC 2045, RFC 822, Glossary
1304 @subsection RFC 1036
1308 A RFC defines format of USENET message. It is a subset of RFC 822
1309 (@ref{RFC 822}). It is not Internet standard, but a lot of netnews
1310 excepting Usenet uses it.
1316 M. Horton and R. Adams, ``Standard for Interchange of USENET Messages'',
1317 December 1987, (obsolete RFC 850).
1322 @node RFC 2045, RFC 2046, RFC 1036, Glossary
1323 @subsection RFC 2045
1325 @cindex Standards Track
1331 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1332 (MIME) Part One: Format of Internet Message Bodies'', November 1996,
1333 Standards Track (obsolete RFC 1521, 1522, 1590).
1338 @node RFC 2046, RFC 2048, RFC 2045, Glossary
1339 @subsection RFC 2046
1341 @cindex Standards Track
1347 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1348 (MIME) Part Two: Media Types'', November 1996, Standards Track (obsolete
1349 RFC 1521, 1522, 1590).
1354 @node RFC 2048, RFC 2049, RFC 2046, Glossary
1355 @subsection RFC 2048
1357 @cindex Standards Track
1363 N. Freed, J. Klensin and J. Postel, ``Multipurpose Internet Mail
1364 Extensions (MIME) Part Four: Registration Procedures'', November 1996,
1365 Standards Track (obsolete RFC 1521, 1522, 1590).
1370 @node RFC 2049, plain text, RFC 2048, Glossary
1371 @subsection RFC 2049
1373 @cindex Standards Track
1379 N. Freed and N. Borenstein, ``Multipurpose Internet Mail Extensions
1380 (MIME) Part Five: Conformance Criteria and Examples'', November 1996,
1381 Standards Track (obsolete RFC 1521, 1522, 1590).
1386 @node plain text, us-ascii, RFC 2049, Glossary
1387 @subsection plain text
1389 A textual data represented by only coded character set (@ref{coded character set}). It does not have information about font or
1390 typesetting. (cf. @ref{text/plain})
1394 @node us-ascii, , plain text, Glossary
1395 @subsection us-ascii
1399 A MIME charset (@ref{MIME charset}) for primary Latin script mainly
1400 written by English or other languages.@refill
1402 It is a 7bit coded character set (@ref{coded character set}) based on
1403 ISO 2022 (@ref{ISO 2022}), it contains only ASCII (@ref{ASCII}) and code
1404 extension (@ref{code extension}) is not allowed.@refill
1406 It is standard coded character set of Internet mail. If MIME charset is
1407 not specified, @strong{us-ascii} is used as default.@refill
1409 In addition, @strong{ASCII} of RFC 822 (@ref{RFC 822}) should be
1410 interpreted as us-ascii.
1413 @node Bug report, CVS, Glossary, Appendix
1414 @section How to report bugs
1415 @cindex good bug report
1417 If you write bug-reports and/or suggestions for improvement, please
1418 send them to the tm Mailing List:
1422 Japanese <bug-tm-ja@@chamonix.jaist.ac.jp>
1424 English <bug-tm-en@@chamonix.jaist.ac.jp>
1428 Notice that, we do not welcome bug reports about too old version. Bugs
1429 in old version might be fixed. So please try latest version at
1432 You should write @strong{good bug report}. If you write only ``FLIM
1433 does not work'', we can not find such situations. At least, you should
1434 write name, type, variants and version of OS, emacs, APEL, FLIM, SEMI
1435 and MUA, and setting. In addition, if error occurs, to send backtrace
1436 is very important. (cf. @ref{(emacs)Bugs}) @refill
1438 Bug may not appear only your environment, but also in a lot of
1439 environment (otherwise it might not bug). Therefor if you send mail
1440 to author directly, we must write a lot of mails. So please send mail
1441 to address for tm bugs instead of author.
1443 Via the tm ML, you can report FLIM bugs, obtain the latest release of
1444 FLIM, and discuss future enhancements to FLIM. To join the tm ML,
1445 send empty e-mail to:
1449 Japanese <tm-ja-help@@chamonix.jaist.ac.jp>
1451 English <tm-en-help@@chamonix.jaist.ac.jp>
1456 @node CVS, History, Bug report, Appendix
1457 @section CVS based development
1459 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
1460 \e$B?7$N
\e(B FLIM
\e$B$rF~<j$9$k$3$H$,$G$-$^$9!'
\e(B
1465 % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1468 CVS password: [CR] # NULL string
1472 % cvs -d :pserver:anonymous@@chamonix.jaist.ac.jp:/hare/cvs/root \
1473 checkout [-r TAG] flim
1477 CVS
\e$B$rMQ$$$?3+H/$K;22C$7$?$$J}$O
\e(B
1481 <cvs@@chamonix.jaist.ac.jp>
1485 \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
1486 \e$B$r1h$($F8fO"Mm$/$@$5$$!#
\e(B
1489 @node History, , CVS, Appendix
1490 @section History of FLIM
1492 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}
\e$B$K5/8;$7
\e(B
1493 \e$B$^$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 B-encoding
1494 \e$B@lMQ$N
\e(B encoded-word
\e$B$NI|9f2=%W%m%0%i%`$G$7$?!#
\e(B@refill
1496 \e$B$=$N8e!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$O
\e(B @file{mime.el}
\e$B$r85$K
\e(B@file{tiny-mime.el}
\e$B$H$$$&%W%m
\e(B
1497 \e$B%0%i%`$r=q$-$^$9!#$3$l$O!"
\e(BNemacs
\e$B$H
\e(B Mule
\e$B$GF0:n$9$k
\e(B encoded-word
\e$B$NId9f
\e(B
1498 \e$B2=!&I|9f2=%W%m%0%i%`$G$7$?!#
\e(B@file{tiny-mime.el}
\e$B$O
\e(B B-encoding
\e$B$@$1$G$J$/
\e(B
1499 Q-encoding
\e$B$b
\e(Bsupport
\e$B$7!"$^$?!"
\e(BMULE
\e$B$G07$&$3$H$,$G$-$k$5$^$6$^$J
\e(B MIME
1500 charset (@ref{MIME charset})
\e$B$rF1;~$K;H$&$3$H$,$G$-$^$7$?!#$3$N;~!"
\e(B
1501 Nemacs
\e$B$H
\e(B Mule
\e$B$NAPJ}$r
\e(B support
\e$B$9$k$?$a$KMQ$$$i$l$?%F%/%K%C%/$O8e$K
\e(B emu
1502 package
\e$B$K$^$H$a$i$l$^$9!#
\e(B@refill
1504 \e$B$3$N:"!"<i2,
\e(B
\e$BCNI'
\e(B
\e$B$O
\e(B @file{tiny-mime.el}
\e$B$r$5$^$6$^$J
\e(B MUA
\e$B$G;H$&$?$a$N@_
\e(B
1505 \e$BDj=8$bG[I[$7$F$$$^$7$?$,!"$=$l$i$O8e$K
\e(B@file{tiny-mime.el}
\e$B$H$H$b$K#1$D$N
\e(B
1506 package
\e$B$K$^$H$a$i$l!"
\e(Btm
\e$B$H$$$&L>A0$GG[I[$5$l$^$9!#
\e(B@refill
1508 \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
1509 @file{tm-body.el}
\e$B$r=q$-$^$9!#$3$l$O!"$9$0$K
\e(B@file{tm-view.el}
\e$B$H$$$&L>A0
\e(B
1510 \e$B$KJQ$o$j$^$7$?$,!"$d$,$F!"$3$l$,
\e(B@file{tiny-mime.el}
\e$B$KBe$o$C$F!"
\e(Btm
\e$B$NCf
\e(B
1511 \e$B3K$H$J$j$^$9!#
\e(B@refill
1513 @file{tm-view.el}
\e$B$OEvA3!"
\e(BContent-Transfer-Encoding
\e$B$r07$&I,MW$,$"$j$^$9!#
\e(B
1514 \e$B$3$NL\E*$N$?$a$K!"
\e(BMEL
\e$B$,@0Hw$5$l$O$8$a$^$7$?!#
\e(BBase64
\e$B$K4X$7$F$O
\e(B
1515 @file{tiny-mime.el}
\e$B$N
\e(B code
\e$B$,0\$5$l!"$^$?!"?7$?$K
\e(BQuoted-Printable
\e$B$N
\e(B
1516 code
\e$B$,DI2C$5$l$^$7$?!#$3$l$i$,
\e(B@file{mel-b.el}
\e$B$H
\e(B @file{mel-q.el}
\e$B$K$J$j
\e(B
1517 \e$B$^$7$?!#
\e(B@refill
1519 \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}
\e$B$,DI2C$5$l!"
\e(B
1520 \e$B$=$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@file{mel-g.el}
\e$B$,DI2C$5$l$^
\e(B
1521 \e$B$7$?!#
\e(B@refill
1523 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}
\e$B$N:F<BAu$,9T$o$l!"$3
\e(B
1524 \e$B$N2aDx$G!"
\e(BSTD 11
\e$B$N
\e(B parser
\e$B$,=q$+$l$^$7$?!#$3$l$O!"8=:_$N
\e(B
1525 @file{std11.el}
\e$B$KEv$?$j$^$9!#$^$?!"$3$N2aDx$G
\e(B @file{tiny-mime.el}
\e$B$OI|
\e(B
1526 \e$B9f2=$r9T$&
\e(B @file{tm-ew-d.el}
\e$B$HId9f2=$r9T$&
\e(B @file{tm-ew-e.el}
\e$B$KJ,$1$i$l
\e(B
1527 \e$B$^$7$?!#$3$NN><T$,8=:_$N
\e(B @file{eword-decode.el}
\e$B$H
\e(B
1528 @file{eword-encode.el}
\e$B$N@hAD$KEv$?$j$^$9!#
\e(B@refill
1530 \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(Btm
1531 \e$B$O
\e(B APEL, MEL, SEMI, EMH, RMAIL-MIME, Gnus-MIME
\e$B$J$I$KJ,$1$i$l$^$7$?!#$3
\e(B
1532 \e$B$N$&$A$N
\e(B MEL
\e$B$,
\e(B FLIM
\e$B$ND>@\$N@hAD$KEv$?$j$^$9!#
\e(B@refill
1534 \e$B8e$K!"
\e(BAPEL
\e$B$+$i
\e(B @file{std11.el}
\e$B$,0\$5$l!"$^$?!"
\e(B@file{mailcap.el},
1535 @file{eword-decode.el}
\e$B$*$h$S
\e(B @file{eword-encode.el}
\e$B$,
\e(B SEMI
\e$B$+$i0\$5$l!"
\e(B
1536 package
\e$B$NL>A0$,
\e(B FLIM
\e$B$H$J$j$^$9!#
\e(B@refill
1538 \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
1539 FLIM
\e$B$N;^$G$"$k
\e(B ``FLIM-FLAM''
\e$B$H$J$C$F$$$^$9!#
\e(B
1542 @node Concept Index, Function Index, Appendix, Top
1543 @chapter Concept Index
1547 @node Function Index, Variable Index, Concept Index, Top
1548 @chapter Function Index
1552 @node Variable Index, , Function Index, Top
1553 @chapter Variable Index