X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=mime-en.sgml;h=50b57d0e5433fa289cb832ccd48c77ea91f14b46;hb=e3697d7a1aa5dd7b573c5ff3f320ed03fd6614bd;hp=c3afb70c47e125ae20615a64160f5023117a9423;hpb=db5c2befd853d8595ada21c4be08dfd3aab890cc;p=elisp%2Fflim.git diff --git a/mime-en.sgml b/mime-en.sgml index c3afb70..50b57d0 100644 --- a/mime-en.sgml +++ b/mime-en.sgml @@ -1,8 +1,8 @@ -FLIM 1.10 Manual about MIME Features +<title>FLIM 1.14 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> @@ -650,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> @@ -716,9 +747,10 @@ using <var>encoding</var>. <defun name="mime-decode-string"> - <args> string encoding + <args> string encoding <p> -<var>string</var> を <var>encoding</var> として復号した結果を返します。 +Decode <var>string</var> which is encoded in <var>encoding</var>, and +return the result. </defun> @@ -838,66 +870,82 @@ ENCODING must be string.") <h1> Network representation of header <node> encoded-word <p> -encoded-word は header で非 <dref>ASCII</dref> 文字を表現するための形 -式で、<concept>RFC 2047</concept> で定義されています。 +<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> -また、行儀の悪いことだと言えますが、encoded-word を用いずに非 -<dref>ASCII</dref> 文字を header に入れた記事も存在します。 +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 はこれらを符号化・復号化する機能を提供します。 +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>mime-field-encoding-method-alist</code>. </defun> +<defvar name="mime-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 <p> <define type="group" name="mime"> <p> -MIME 関連機能に関する group. +The group associated with functions related to MIME. <p> -<code>mail</code> と <code>news</code> に属する。 +It belongs to <code>mail</code> and <code>news</code>. </define> -<defvar name="mime-temp-directory"> -<p> -MIME 機能に関する実装が一時的に使用する file を作成する directory. -<p> -環境変数 <code>MIME_TMP_DIR</code>, <code>TM_TMP_DIR</code>, -<code>TMPDIR</code>, <code>TMP</code> もしくは <code>TEMP</code> が設定 -されていた場合、それを初期値として用いる。何も設定されていない場合、 -<code>"/tmp/"</code> を用いる。 -</defvar> - <h1> Appendix <node> Appendix @@ -1232,11 +1280,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> @@ -1253,50 +1301,52 @@ 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> <h2> CVS based development <node> CVS <p> -FLIM の file は CVS を使って管理されています。このため、以下の方法で最 -新の FLIM を入手することができます： +Files in FLIM are managed under CVS. Therefore you can obtain the +newest FLIM by the following method: <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> <p> -CVS を用いた開発に参加したい方は +If you would like to join CVS based development, please send mail to <ul> -<li> <mail>cvs@chamonix.jaist.ac.jp</mail> +<li> <mail>cvs@cvs.m17n.org</mail> </ul> <noindent> -まで、account 名と UNIX の passwd と同じ形式の crypt 化された password -を沿えて御連絡ください。 - +with your account name and your public key for ssh. +cvsroot is :ext:cvs@@cvs.m17n.org:/cvs/root. +<p> +If you cannot use ssh, you can join development via pserver. +In this case, please send UNIX /etc/passwd style crypted password. +Then cvsroot is :pserver:<accountname>@cvs.m17n.org:/cvs/root. <h2> History of FLIM <node> History