X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=mime-en.sgml;h=4e8dcade58a9c9d2fa446e4e0e2fc19b8de13374;hb=57a3177465e8d977a8b2423f4343eefd3adf3d00;hp=25235859a0308027408a18224e38ce0851bb3ff1;hpb=2705bffeacccea18de17e2aeeacf03b7bc2e3ca9;p=elisp%2Fflim.git diff --git a/mime-en.sgml b/mime-en.sgml index 2523585..4e8dcad 100644 --- a/mime-en.sgml +++ b/mime-en.sgml @@ -1,8 +1,8 @@ -FLIM 1.10 Manual about MIME Features +<title>FLIM 1.12 Reference Manual about MIME Features <author>MORIOKA Tomohiko <mail>morioka@jaist.ac.jp</mail> -<date>1998/07/01 +<date>1999-01-27 <toc> </head> @@ -11,8 +11,8 @@ <abstract> <p> -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. </abstract> @@ -165,6 +165,10 @@ Return node-id of <var>entity</var>. Return entity-number of <var>entity</var>. </defun> + +<h2> Find Entity +<node> Entity Search +<p> <defun name="mime-find-entity-from-number"> <args> entity-number <opts> message <p> @@ -183,6 +187,15 @@ If <var>message</var> is not specified, <code>mime-message-structure</code> is used. </defun> +<defun name="mime-find-entity-from-content-id"> + <args> cid <opts> message +<p> +Return entity from <var>cid</var> in <var>message</var>. +<p> +If <var>message</var> is not specified, +<code>mime-message-structure</code> is used. +</defun> + <h2> Functions about attributes of mime-entity <node> Entity Attributes @@ -299,9 +312,9 @@ used as default value. <defvar name="default-mime-charset"> <p> -Symbol to indicate default value of <dref>MIME-charset</dref>. +Symbol to indicate default value of <dref>MIME charset</dref>. <p> -It is used when MIME-charset is not specified. +It is used when MIME charset is not specified. <p> It is originally variable of APEL. </defvar> @@ -316,12 +329,28 @@ It is originally variable of APEL. Return content of <var>entity</var> as byte sequence. </defun> +<defun name="mime-insert-entity-content"> + <args> entity +<p> +Insert content of <var>entity</var> at point. +</defun> + <defun name="mime-write-entity-content"> <args> entity filename <p> Write content of <var>entity</var> into <var>filename</var>. </defun> + +<h2> Network representation of Entity +<node> Entity-network-representation +<p> +<defun name="mime-insert-entity"> + <args> entity +<p> +Insert header and body of <var>entity</var> at point. +</defun> + <defun name="mime-write-entity"> <args> entity filename <p> @@ -563,15 +592,16 @@ Return value of <var>parameter</var> of <var>content-type</var>. <node> Content-Type parser <p> <defun name="mime-parse-Content-Type"> - <args> string + <args> string <p> -Parse <var>string</var> as field-body of Content-Type field. +Parse <var>string</var> as a field-body of Content-Type field, and +return the result as <dref>mime-content-type</dref> structure. </defun> <defun name="mime-read-Content-Type"> <p> -Read field-body of Content-Type field from current-buffer, -and return parsed it. +Parse Content-Type field of the current buffer, and return the result +as <dref>mime-content-type</dref> structure. <p> Return <code>nil</code> if Content-Type field is not found. </defun> @@ -581,7 +611,7 @@ Return <code>nil</code> if Content-Type field is not found. <node> Content-Type utility <p> <defun name="mime-type/subtype-string"> - <args> type <opts> subtype + <args> type <opts> subtype <p> Return type/subtype string from <var>type</var> and <var>subtype</var>. @@ -596,10 +626,10 @@ specify presentation of an entity or attributes of an entity, such as file name. <rfc number="2183" type="Standards Track" - author="S. Dorner, K. Moore and R. Troost" - title="Communicating Presentation Information in - Internet Messages: The Content-Disposition Header" - date="August 1997"> + author="S. Dorner, K. Moore and R. Troost" + title="Communicating Presentation Information in Internet + Messages: The Content-Disposition Header" date="August + 1997"> <p> FLIM provides parser for Content-Disposition field and structure <concept>mime-content-disposition</concept> to store information of @@ -649,14 +679,16 @@ Return filename of <var>content-disposition</var>. <args> string <p> Parse <var>string</var> as field-body of Content-Disposition field, -and return the result. +and return the result as <dref>mime-content-disposition</dref> +structure. </defun> <defun name="mime-read-Content-Disposition"> <p> -Read field-body of Content-Disposition field from current-buffer, +Parse Content-Disposition field of the current buffer, and return the +result as <dref>mime-content-disposition</dref> structure. <p> -Return nil if Content-Disposition field is not found. +Return <code>nil</code> if Content-Disposition field is not found. </defun> @@ -678,19 +710,21 @@ Content-Transfer-Encoding. <node> Content-Transfer-Encoding parser <p> <defun name="mime-parse-Content-Transfer-Encoding"> - <args> string + <args> string <p> -<var>string</var> $B$r(B content-transfer-encoding $B$H$7$F2r@O$7$?7k2L$rJV$9!#(B +Parse <var>string</var> as a field-body of Content-Transfer-Encoding +field, and return the result. </defun> <defun name="mime-read-Content-Transfer-Encoding"> - <opts>default-encoding + <opts>default-encoding <p> -$B8=:_$N(B buffer $B$N(B Content-Transfer-Encoding $BMs$rFI$_<h$j!"2r@O$7$?7k2L$r(B -$BJV$9!#(B +Parse Content-Transfer-Encoding field of the current buffer, and +return the result. <p> -Content-Transfer-Encoding $BMs$,B8:_$7$J$$>l9g$O(B -<var>default-encoding</var> $B$rJV$9!#(B +Return <var>default-encoding</var> if Content-Transfer-Encoding field +is not found. If it is not specified, <code>nil</code> is used as the +default value. </defun> @@ -713,9 +747,10 @@ using <var>encoding</var>. <defun name="mime-decode-string"> - <args> string encoding + <args> string encoding <p> -<var>string</var> $B$r(B <var>encoding</var> $B$H$7$FI|9f$7$?7k2L$rJV$7$^$9!#(B +Decode <var>string</var> which is encoded in <var>encoding</var>, and +return the result. </defun> @@ -835,45 +870,71 @@ ENCODING must be string.") <h1> Network representation of header <node> encoded-word <p> -encoded-word $B$O(B header $B$GHs(B <dref>ASCII</dref> $BJ8;z$rI=8=$9$k$?$a$N7A(B -$B<0$G!"(B<concept>RFC 2047</concept> $B$GDj5A$5$l$F$$$^$9!#(B +<concept>RFC 2047</concept> defines the +<concept>encoded-word</concept> which is a format to represent +non-<dref>ASCII</dref> characters in a header. <p> <rfc number="2047" type="Standards Track" author="K. Moore" title="MIME (Multipurpose Internet Mail Extensions) Part Three: Message Header Extensions for Non-ASCII Text" date="November 1996" obsolete="1521,1522,1590"> <p> -$B$^$?!"9T57$N0-$$$3$H$@$H8@$($^$9$,!"(Bencoded-word $B$rMQ$$$:$KHs(B -<dref>ASCII</dref> $BJ8;z$r(B header $B$KF~$l$?5-;v$bB8:_$7$^$9!#(B +The encoded-word is the only valid format to represent +non-<dref>ASCII</dref> characters in a header, but there are also +invalid styles. Such kinds of evil messages represent +non-<dref>ASCII</dref> characters in headers without encoded-words (it +is called "raw" non-<dref>ASCII</dref> characters). <p> -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-<dref>ASCII</dref> characters. <h2> Header encoding/decoding <node> Header encoder/decoder <p> -<defun name="eword-encode-header"> - <opts> code-conversion separator +<defun name="eword-decode-header"> + <opts> code-conversion separator <p> Decode MIME encoded-words in header fields. <p> -If <var>code-conversion</var> is <code>nil</code>, it decodes only -encoded-words. If it is mime-charset, it decodes non-ASCII bit -patterns as the mime-charset. Otherwise it decodes non-ASCII bit -patterns as the default-mime-charset. +If <var>code-conversion</var> is <code>nil</code>, only encoded-words +are decoded. If <var>code-conversion</var> is a <dref>MIME +charset</dref>, non-ASCII bit patterns are decoded as the MIME +charset. Otherwise non-ASCII bit patterns are decoded as the +<code>default-mime-charset</code>. <cf node="entity formatting"> <p> -If <var>separator</var> is not nil, it is used as header separator. +If <var>separator</var> is not <code>nil</code>, it is used as header +separator. </defun> <defun name="eword-encode-header"> - <opts> code-conversion + <opts> code-conversion <p> Encode header fields to network representation, such as MIME encoded-word. <p> -It refer variable <code>eword-field-encoding-method-alist</code>. +Each field is encoded as corresponding method specified by variable +<code>eword-field-encoding-method-alist</code>. </defun> +<defvar name="eword-field-encoding-method-alist"> +<p> +Association list to specify field encoding method. Each element looks +like (FIELD . METHOD). +<p> +If METHOD is <code>mime</code>, the FIELD will be encoded into MIME +format (encoded-word). +<p> +If METHOD is <code>nil</code>, the FIELD will not be encoded. +<p> +If METHOD is a MIME charset, the FIELD will be encoded as the charset +when it must be convert into network-code. +<p> +Otherwise the FIELD will be encoded as variable +<code>default-mime-charset</code> when it must be convert into +network-code. +</defvar> + <h1> Various Customization <node> custom @@ -1229,11 +1290,11 @@ be interpreted as us-ascii. <node> Bug report <p> 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: <ul> -<li> Japanese <mail>bug-tm-ja@chamonix.jaist.ac.jp</mail> -<li> English <mail>bug-tm-en@chamonix.jaist.ac.jp</mail> +<li> English <mail>emacs-mime-en@m17n.org</mail> +<li> Japanese <mail>emacs-mime-ja@m17n.org</mail> </ul> <p> @@ -1250,16 +1311,16 @@ to send backtrace is very important. <cf file="emacs" node="Bugs"> 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. <p> -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: <ul> -<li> Japanese <mail>tm-ja-help@chamonix.jaist.ac.jp</mail> -<li> English <mail>tm-en-help@chamonix.jaist.ac.jp</mail> +<li> English <mail>emacs-mime-en-ctl@m17n.org</mail> +<li> Japanese <mail>emacs-mime-ja-ctl@m17n.org</mail> </ul> @@ -1272,14 +1333,13 @@ FLIM $B$N(B file $B$O(B CVS $B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K <verb> (0) cvs login - % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \ - login + % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login CVS password: [CR] # NULL string (1) checkout - % cvs -d :pserver:anonymous@chamonix.jaist.ac.jp:/hare/cvs/root \ + % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root \ checkout [-r TAG] flim </verb> @@ -1287,13 +1347,16 @@ FLIM $B$N(B file $B$O(B CVS $B$r;H$C$F4IM}$5$l$F$$$^$9!#$3$N$?$a!"0J2<$NJ}K CVS $B$rMQ$$$?3+H/$K;22C$7$?$$J}$O(B <ul> -<li> <mail>cvs@chamonix.jaist.ac.jp</mail> +<li> <mail>cvs@cvs.m17n.org</mail> </ul> <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 - +$B$^$G!"%"%+%&%s%HL>$H(B ssh $B$N8x3+80$rAw$C$F$/$@$5$$!#(Bssh $B7PM3$G$O!"(B +cvsroot $B$O(B :ext:cvs@cvs.m17n.org:/cvs/root $B$H$J$j$^$9!#(B +<p> +$B$I$&$7$F$b(B ssh $B$,;H$($J$$>l9g!"(Bpserver $B7PM3$G$b3+H/$K;22C$G$-$^$9!#(B +$B$3$N>l9g!"(BUNIX $B$N(B /etc/passwd $BMM<0$G0E9f2=$5$l$?%Q%9%o!<%I$rAw$C$F2<$5$$!#(B +$B$3$N>l9g(B cvsroot $B$O(B :pserver:<$B%"%+%&%s%HL>(B>@cvs.m17n.org:/cvs/root $B$H$J$j$^$9!#(B <h2> History of FLIM <node> History