X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=mime-en.texi;h=e04f744b35de72673cd912f3840d18a4ba44804e;hb=6260b782ec94886678bc08ecf41d7fa91fa6c9c5;hp=e8f47e2785c374a6e5dc17d546f398cc13ea2aee;hpb=72a53f122534362ff1e645c232ace7f8e6e251f9;p=elisp%2Fflim.git diff --git a/mime-en.texi b/mime-en.texi index e8f47e2..e04f744 100644 --- a/mime-en.texi +++ b/mime-en.texi @@ -1,19 +1,19 @@ \input texinfo.tex @c Generated automatically from mime-en.sgml by sinfo 3.7. @setfilename mime-en.info -@settitle{FLIM 1.10 Manual about MIME Features} +@settitle{FLIM 1.14 Reference Manual about MIME Features} @titlepage -@title FLIM 1.10 Manual about MIME Features +@title FLIM 1.14 Reference Manual about MIME Features @author MORIOKA Tomohiko -@subtitle 1998/07/01 +@subtitle 1999-01-27 @end titlepage @node Top, Introduction, (dir), (dir) -@top FLIM 1.10 Manual about MIME Features +@top FLIM 1.14 Reference Manual about MIME Features @ifinfo -This file documents MIME features of FLIM, a Internet message -parsing/encoding library for GNU Emacs. +This file documents MIME features of FLIM, a fundamental library to +process Internet Messages for GNU Emacsen. @end ifinfo @menu @@ -25,10 +25,10 @@ parsing/encoding library for GNU Emacs. * Content-Transfer-Encoding:: Encoding Method * encoded-word:: Network representation of header * custom:: Various Customization -* Appendix:: -* Concept Index:: -* Function Index:: -* Variable Index:: +* Appendix:: +* Concept Index:: +* Function Index:: +* Variable Index:: @end menu @node Introduction, How to use, Top, Top @@ -72,10 +72,12 @@ information of entity. In this document, it is called simply @menu * Entity creation:: Functions to create mime-entity * Entity hierarchy:: Features about message tree +* Entity Search:: Find Entity * Entity Attributes:: Functions about attributes of mime-entity * Entity-header:: Information of entity header * entity formatting:: Text presentation of entity * Entity-content:: Contents of Entity +* Entity-network-representation:: Network representation of Entity * Entity buffer:: Entity as buffer representation * mm-backend:: Entity representations and implementations @end menu @@ -103,13 +105,12 @@ mime-entity.@refill If @var{buffer} is omitted, current buffer is used.@refill @var{type} is representation-type of created -mime-entity. (cf. @ref{mm-backend}) - Default value is @var{buffer}. +mime-entity. (cf. @ref{mm-backend}) Default value is @var{buffer}. @end defun -@node Entity hierarchy, Entity Attributes, Entity creation, Entity +@node Entity hierarchy, Entity Search, Entity creation, Entity @section Features about message tree @cindex node-id @cindex entity-number @@ -198,6 +199,10 @@ Return entity-number of @var{entity}. @end defun + +@node Entity Search, Entity Attributes, Entity hierarchy, Entity +@section Find Entity + @defun mime-find-entity-from-number entity-number &optional message Return entity from @var{entity-number} in @var{message}.@refill @@ -216,8 +221,17 @@ used. @end defun +@defun mime-find-entity-from-content-id cid &optional message + +Return entity from @var{cid} in @var{message}.@refill + +If @var{message} is not specified, @code{mime-message-structure} is +used. +@end defun + + -@node Entity Attributes, Entity-header, Entity hierarchy, Entity +@node Entity Attributes, Entity-header, Entity Search, Entity @section Functions about attributes of mime-entity @defun mime-entity-content-type entity @@ -339,7 +353,7 @@ It is originally variable of APEL. -@node Entity-content, Entity buffer, entity formatting, Entity +@node Entity-content, Entity-network-representation, entity formatting, Entity @section Contents of Entity @defun mime-entity-content entity @@ -348,12 +362,28 @@ Return content of @var{entity} as byte sequence. @end defun +@defun mime-insert-entity-content entity + +Insert content of @var{entity} at point. +@end defun + + @defun mime-write-entity-content entity filename Write content of @var{entity} into @var{filename}. @end defun + +@node Entity-network-representation, Entity buffer, Entity-content, Entity +@section Network representation of Entity + +@defun mime-insert-entity entity + +Insert header and body of @var{entity} at point. +@end defun + + @defun mime-write-entity entity filename Write representation of @var{entity} into @var{filename}. @@ -367,7 +397,7 @@ Write body of @var{entity} into @var{filename}. -@node Entity buffer, mm-backend, Entity-content, Entity +@node Entity buffer, mm-backend, Entity-network-representation, Entity @section Entity as buffer representation @defun mime-entity-buffer entity @@ -927,10 +957,11 @@ ENCODING must be string.") @chapter Network representation of header @cindex RFC 2047 @cindex Standards Track +@cindex encoded-word @cindex RFC 2047 -encoded-word $B$O(B header $B$GHs(B ASCII (@ref{ASCII}) $BJ8;z$rI=8=$9$k$?$a$N7A<0(B -$B$G!"(B@strong{RFC 2047} $B$GDj5A$5$l$F$$$^$9!#(B@refill +@strong{RFC 2047} defines the @strong{encoded-word} which is a format to +represent non-ASCII (@ref{ASCII}) characters in a header.@refill @noindent @@ -941,10 +972,14 @@ Message Header Extensions for Non-ASCII Text'', November 1996, Standards Track (obsolete RFC 1521,1522,1590). @end quotation -$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"(Bencoded-word $B$rMQ$$$:$KHs(B ASCII -(@ref{ASCII}) $BJ8;z$r(B header $B$KF~$l$?5-;v$bB8:_$7$^$9!#(B@refill +The encoded-word is the only valid format to represent non-ASCII +(@ref{ASCII}) characters in a header, but there are also invalid styles. +Such kinds of evil messages represent non-ASCII (@ref{ASCII}) characters +in headers without encoded-words (it is called "raw" non-ASCII +(@ref{ASCII}) characters).@refill -FLIM $B$O$3$l$i$rId9f2=!&I|9f2=$9$k5!G=$rDs6!$7$^$9!#(B +FLIM provides encoding/decoding features of both encoded-word and +invalid "raw" non-ASCII (@ref{ASCII}) characters. @menu @@ -973,32 +1008,39 @@ If @var{separator} is not @code{nil}, it is used as header separator. Encode header fields to network representation, such as MIME encoded-word.@refill -It refer variable @code{eword-field-encoding-method-alist}. +Each field is encoded as corresponding method specified by variable +@code{mime-field-encoding-method-alist}. @end defun +@defvar mime-field-encoding-method-alist -@node custom, Appendix, encoded-word, Top -@chapter Various Customization +Association list to specify field encoding method. Each element looks +like (FIELD . METHOD).@refill -@deffn{group} mime +If METHOD is @code{mime}, the FIELD will be encoded into MIME format +(encoded-word).@refill -MIME $B4XO"5!G=$K4X$9$k(B group.@refill +If METHOD is @code{nil}, the FIELD will not be encoded.@refill -@code{mail} $B$H(B @code{news} $B$KB0$9$k!#(B -@end deffn +If METHOD is a MIME charset, the FIELD will be encoded as the charset +when it must be convert into network-code.@refill +Otherwise the FIELD will be encoded as variable +@code{default-mime-charset} when it must be convert into network-code. +@end defvar -@defvar mime-temp-directory -MIME $B5!G=$K4X$9$kl9g!"$=$l$r=i4|CM$H$7$F(B -$BMQ$$$k!#2?$b@_Dj$5$l$F$$$J$$>l9g!"(B@code{"/tmp/"} $B$rMQ$$$k!#(B -@end defvar +@node custom, Appendix, encoded-word, Top +@chapter Various Customization +@deffn{group} mime + +The group associated with functions related to MIME.@refill + +It belongs to @code{mail} and @code{news}. +@end deffn @node Appendix, Concept Index, custom, Top @@ -1444,13 +1486,13 @@ interpreted as us-ascii. @cindex good bug report If you write bug-reports and/or suggestions for improvement, please -send them to the tm Mailing List: +send them to the EMACS-MIME Mailing List: @itemize @bullet @item - Japanese + English @item - English + Japanese @end itemize @@ -1467,17 +1509,17 @@ is very important. (cf. @ref{(emacs)Bugs}) @refill Bug may not appear only your environment, but also in a lot of environment (otherwise it might not bug). Therefor if you send mail to author directly, we must write a lot of mails. So please send mail -to address for tm bugs instead of author. +to address for EMACS-MIME Mailing List instead of author. -Via the tm ML, you can report FLIM bugs, obtain the latest release of -FLIM, and discuss future enhancements to FLIM. To join the tm ML, -send empty e-mail to: +Via the EMACS-MIME ML, you can report FLIM bugs, obtain the latest +release of FLIM, and discuss future enhancements to FLIM. To join the +EMACS-MIME ML, send an empty e-mail to: @itemize @bullet @item - Japanese + English @item - English + Japanese @end itemize @@ -1485,40 +1527,39 @@ send empty e-mail to: @node CVS, History, Bug report, Appendix @section CVS based development -FLIM $B$N(B file $B$O(B CVS $B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K!$G:G(B -$B?7$N(B FLIM $B$rF~ + @end itemize @noindent -$B$^$G!"(Baccount $BL>$H(B UNIX $B$N(B passwd $B$HF1$87A<0$N(B crypt $B2=$5$l$?(B password -$B$r1h$($F8fO"Mm$/$@$5$$!#(B +with your account name and your public key for ssh. +cvsroot is :ext:cvs@@cvs.m17n.org:/cvs/root. @node History, , CVS, Appendix @section History of FLIM -FLIM $B$N(B code $B$N:G8E$NItJ,$O(B $B1]JB(B $B;LCR(B $B;a$,=q$$$?(B @file{mime.el}$B$K5/8;$7(B +FLIM $B$N(B code $B$N:G8E$NItJ,$O(B $B1]JB(B $B;LCR(B $B;a$,=q$$$?(B @file{mime.el} $B$K5/8;$7(B $B$^$9!#$3$N>.$5$J(B program $B$O(B Nemacs $B$GF0:n$9$k(B iso-2022-jp $B$N(B B-encoding $B@lMQ$N(B encoded-word $B$NI|9f2=%W%m%0%i%`$G$7$?!#(B@refill @@ -1562,7 +1603,7 @@ tm $B$G$O8e$K!"A0$,(B FLIM$B$H$J$j$^$9!#(B@refill +package $B$NL>A0$,(B FLIM $B$H$J$j$^$9!#(B@refill $B$3$ND>A0$+$iEDCf(B $BE/(B $B;a$,$h$j(B RFC $B$KCi