(write-entity): `write-region-as-CRLF' was renamed to
[elisp/flim.git] / mime-ja.sgml
index 19f2e37..c3cfb08 100644 (file)
@@ -1,8 +1,8 @@
 <!doctype sinfo system>
 <head>
-<title>FLIM 1.6 MIME \e$B5!G=@bL@=q\e(B
+<title>FLIM 1.9 MIME \e$B5!G=@bL@=q\e(B
 <author>\e$B<i2,\e(B \e$BCNI'\e(B <mail>morioka@jaist.ac.jp</mail>
-<date>1998/06/23
+<date>1998/07/01
 
 <toc>
 </head>
@@ -88,111 +88,69 @@ local \e$BJQ?t\e(B <code>mime-message-structure</code> \e$B$K3JG<$9$k$3$H$K$7$^$9!#
 \e$B07$&$3$H$,$G$-$^$9!#\e(B
 
 
-<h2> mime-entity \e$B9=B$BN\e(B
-<node> mime-entity
+<h2> Entity \e$B$N@8@.\e(B
+<node> Entity creation
 <p>
-<define type="Structure" name="mime-entity">
+<defun name="mime-open-entity">
+         <opts> type location
 <p>
-entity \e$B$K4X$9$k>pJs$r<}$a$k9=B$BN!#\e(B
+Open an entity and return it.
 <p>
-\e$B$3$N9=B$BN$r;2>H$9$k$K$O\e(B <code>mime-entity-\e$BMWAGL>\e(B</code> \e$B$H$$$&L>A0$N;2\e(B
-\e$B>H4X?t$rMQ$$$k!#\e(B
+<var>type</var> is representation-type. <cf node="mm-backend">
 <p>
-\e$B$3$N9=B$BN$NMWAG$O0J2<$NDL$j$G$"$k!'\e(B
-
-<vl>
-<dt>buffer<dd>entity \e$B$,B8:_$9$k\e(B buffer (buffer)
-</dd>
-<dt>header-start<dd>entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B header \e$B$N@hF,0LCV\e(B
-(point)
-</dd>
-<dt>header-end<dd>entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B header \e$B$NKvHx0LCV\e(B
-(point)
-</dd>
-<dt>body-start<dd>entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B body \e$B$N@hF,0LCV\e(B
-(point)
-</dd>
-<dt>body-end<dd>entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B body \e$B$NKvHx0LCV\e(B
-(point)
-</dd>
-<dt>node-id<dd>entity \e$B$N\e(B node-id (\e$B@0?t$N\e(B list)
-</dd>
-<dt>content-type<dd><dref>Content-Type</dref> \e$BMs$N>pJs\e(B
-(mime-content-type)
-</dd>
-<dt>content-disposition<dd><dref>Content-Disposition</dref> \e$BMs$N>pJs\e(B
-(mime-content-disposition)
-</dd>
-<dt>encoding<dd>entity \e$B$N\e(B <dref>Content-Transfer-Encoding</dref> (\e$BJ8;zNs\e(B)
-</dd>
-<dt>children<dd>entity \e$B$K4^$^$l$k\e(B entity \e$B$N\e(B list (mime-entity \e$B$N\e(B 
-list)
-</dd>
-</vl>
+<var>location</var> is location of entity.  Specification of it is
+depended on representation-type.
+</defun>
 
+<defun name="mime-parse-buffer">
+         <opts> buffer type
 <p>
-\e$B$^$?!"2a5n$H$N8_49@-$N$?$a!"0J2<$NMWAGL>$N;2>H4X?t$bMxMQ2DG=$G$"$k!#\e(B
-
-<vl>
-<dt>type/subtype<dd>entity \e$B$N\e(B type/subtype (\e$BJ8;zNs\e(B)
-</dd>
-<dt>media-type<dd>entity \e$B$N\e(B media-primary-type (symbol)
-</dd>
-<dt>media-subtype<dd>entity \e$B$N\e(B media-subtype (symbol)
-</dd>
-<dt>parameters<dd>entity \e$B$N\e(B Content-Type \e$BMs$N\e(B parameter (\e$BO"A[\e(B list)
-</dd>
-</vl>
-</define>
-
-<defun name="make-mime-entity">
-         <args> buffer header-start header-end body-start body-end
-         <opts> node-id content-type content-disposition encoding
-         children
+<var>buffer</var> \e$B$r\e(B message \e$B$H$7$F9=J82r@O$7!"$=$N7k2L$N\e(B mime-entity 
+\e$B$r\e(B <var>buffer</var> \e$B$N\e(B<code>mime-message-structure</code> \e$B$K3JG<$9$k!#\e(B
 <p>
-entity \e$B$N@8@.;R!#\e(B
+<var>buffer</var> \e$B$,>JN,$5$l$?>l9g!"8=:_$N\e(B buffer \e$B$r9=J82r@O$9$k!#\e(B
+<p>
+<var>type</var> \e$B$,;XDj$5$l$?>l9g!"$=$NCM$r@8@.$5$l$k\e(B mime-entity \e$B$NI=\e(B
+\e$B>]7?$H$7$FMQ$$$k!#>JN,$5$l$?>l9g$O\e(B <var>buffer</var> \e$B$H$J$k!#\e(B<cf
+node="mm-backend">
 </defun>
 
-<defun name="mime-entity-point-min">
-           <args> entity
+
+<h2> Entity \e$B3,AX\e(B
+<node> Entity hierarchy
 <p>
-entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B entity \e$B$N@hF,0LCV$rJV$9!#\e(B
-</defun>
+<defvar name="mime-message-structure">
+<p>
+\e$B8=:_$N\e(B buffer \e$B$K$*$1$k\e(B message \e$BA4BN$N\e(B mime-entity \e$B9=B$BN$r3JG<$9$k\e(B
+buffer local \e$BJQ?t!#\e(B
+</defvar>
 
-<defun name="mime-entity-point-max">
-           <args> entity
+<defun name="mime-entity-children">
+         <args> entity
 <p>
-entity \e$B$NB8:_$9$k\e(B buffer \e$B$K$*$1$k\e(B entity \e$B$NKvHx0LCV$rJV$9!#\e(B
+<var>entity</var> \e$B$K4^$^$l$k\e(B entity \e$B$N\e(B list \e$B$rJV$9!#\e(B
 </defun>
 
-
-<h2> Message \e$B$N2r@O4o\e(B
-<node> Message parser
+<defun name="mime-entity-parent">
+         <args> entity <opts> message
 <p>
-<defun name="mime-parse-message">
-         <opts> default-ctl default-encoding node-id
+<var>entity</var> \e$B$N?F$N\e(B entity \e$B$rJV$9!#\e(B
 <p>
-\e$B8=:_$N\e(B buffer \e$B$r9=J82r@O$7$?7k2L$rJV$9!#\e(B
+<var>message</var> \e$B$,;XDj$5$l$?>l9g!"$3$l$r:,$H8+Jo$9!#\e(B
 </defun>
 
-<defun name="mime-parse-buffer">
-         <opts> buffer
-<p>
-<var>buffer</var> \e$B$r9=J82r@O$7!"$=$N7k2L$r\e(B <var>buffer</var> \e$B$N\e(B
-<code>mime-message-structure</code> \e$B$K3JG<$9$k!#\e(B
+<defun name="mime-root-entity-p">
+         <args> entity
 <p>
-<var>buffer</var> \e$B$,>JN,$5$l$?>l9g!"8=:_$N\e(B buffer \e$B$r9=J82r@O$9$k!#\e(B
+<var>entity</var> \e$B$,:,!JB($A!"\e(Bmessage \e$BA4BN!K$G$"$k>l9g$K!"\e(B
+\e$BHs\e(B-<code>nil</code> \e$B$rJV$9!#\e(B
 </defun>
 
-
-<h2> Entity \e$B$N0LCV4X78$K4X$9$k5!G=\e(B
-<node> Entity as node in message
-<p>
-<defvar name="mime-message-structure">
+<defun name="mime-entity-node-id">
+         <args> entity
 <p>
-\e$B8=:_$N\e(B buffer \e$B$K$*$1$k\e(B message \e$BA4BN$N\e(B mime-entity \e$B9=B$BN$r3JG<$9$k\e(B
-buffer local \e$BJQ?t!#\e(B
-</defvar>
+<var>entity</var> \e$B$N\e(B node-id \e$B$rJV$9!#\e(B
+</defun>
 
 <defun name="mime-entity-number">
          <args> entity
@@ -218,19 +176,46 @@ If <var>message</var> is not specified,
 <code>mime-message-structure</code> is used.
 </defun>
 
-<defun name="mime-entity-parent">
-         <args> entity <opts> message
+
+<h2> Entity \e$B$NB0@-\e(B
+<node> Entity Attributes
 <p>
-<var>entity</var> \e$B$N?F$N\e(B entity \e$B$rJV$9!#\e(B
+<defun name="mime-entity-content-type">
+           <args> entity
 <p>
-<var>message</var> \e$B$,;XDj$5$l$?>l9g!"$3$l$r:,$H8+Jo$9!#\e(B
+<var>entity</var> \e$B$N\e(B content-type \e$B$rJV$9!#\e(B<cf
+node="mime-content-type">
 </defun>
 
-<defun name="mime-root-entity-p">
-         <args> entity
+<defun name="mime-entity-content-disposition">
+           <args> entity
 <p>
-<var>entity</var> \e$B$,:,!JB($A!"\e(Bmessage \e$BA4BN!K$G$"$k>l9g$K!"\e(B
-\e$BHs\e(B-<code>nil</code> \e$B$rJV$9!#\e(B
+<var>entity</var> \e$B$N\e(B content-disposition \e$B$rJV$9!#\e(B<cf
+node="mime-content-disposition">
+</defun>
+
+<defun name="mime-entity-filename">
+           <args> entity
+<p>
+<var>entity</var> \e$B$N\e(B file \e$BL>$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-encoding">
+           <args> entity <opts> default-encoding
+<p>
+<var>entity</var> \e$B$N\e(B content-transfer-encoding \e$B$rJV$9!#\e(B<cf
+node="Content-Transfer-Encoding">
+<p>
+\e$B$b$7!"\e(B<var>entity</var> \e$B$K\e(B Content-Transfer-Encoding \e$BMs$,B8:_$7$J$$>l\e(B
+\e$B9g$O!"\e(B<var>default-encoding</var> \e$B$rJV$9!#$3$l$,;XDj$5$l$J$$>l9g$O!"\e(B
+<code>"7bit"</code> \e$B$rMQ$$$k!#\e(B
+</defun>
+
+<defun name="mime-entity-cooked-p">
+           <args> entity
+<p>
+Return non-nil if contents of <var>entity</var> has been already
+code-converted.
 </defun>
 
 
@@ -247,7 +232,7 @@ If <var>message</var> is not specified,
 <var>entity</var> \e$B$,>JN,$5$l$?>l9g$O!"\e(B
 <code>mime-message-structure</code> \e$B$NCM$rMQ$$$k!#\e(B
 <p>
-<var>field-name</var> \e$BMs$,B8:_$7$J$$>l9g$O\e(B nil \e$B$rJV$9!#\e(B
+<var>field-name</var> \e$BMs$,B8:_$7$J$$>l9g$O\e(B <code>nil</code> \e$B$rJV$9!#\e(B
 </defun>
 
 <defun name="mime-read-field">
@@ -269,7 +254,6 @@ If <var>message</var> is not specified,
 
 <defun name="mime-insert-decoded-header">
            <args> entity <opts> invisible-fields visible-fields
-           code-conversion
 <p>
 \e$B8=:_0LCV$K\e(B <var>entity</var> \e$B$NI|9f$7$?\e(B header \e$B$rA^F~$9$k!#\e(B
 <p>
@@ -291,17 +275,121 @@ list \e$B$G!"$=$l$>$l!"I=<($7$?$/$J$$\e(B field \e$BL>$HI=<($7$?$$MsL>$rI=8=$7$?$b$
 <var>entity</var> \e$B$NFbMF$N\e(B byte \e$BNs$rJV$9!#\e(B
 </defun>
 
+<defun name="mime-write-entity-content">
+           <args> entity filename
+<p>
+Write content of <var>entity</var> into <var>filename</var>.
+</defun>
+
+<defun name="mime-write-entity">
+           <args> entity filename
+<p>
+Write representation of <var>entity</var> into <var>filename</var>.
+</defun>
 
-<h2> Entity \e$B$NB0@-\e(B
-<node> Entity Attributes
+<defun name="mime-write-entity-body">
+           <args> entity filename
 <p>
-<defun name="mime-entity-filename">
+Write body of <var>entity</var> into <var>filename</var>.
+</defun>
+
+
+<h2> Entity \e$B$N\e(B buffer \e$B$K$h$kI=8=\e(B
+<node> Entity buffer
+<p>
+<defun name="mime-entity-buffer">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-point-min">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(B<var>entity</var> \e$B$,@j$a$k\e(B
+\e$BNN0h$N@hF,0LCV$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-point-max">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(B<var>entity</var> \e$B$,@j$a$k\e(B
+\e$BNN0h$NKvHx0LCV$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-header-start">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(Bheader \e$B$,@j$a$kNN0h$N@hF,\e(B
+\e$B0LCV$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-header-end">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(Bheader \e$B$,@j$a$kNN0h$NKvHx\e(B
+\e$B0LCV$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-body-start">
+           <args> entity
+<p>
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(Bbody \e$B$,@j$a$kNN0h$N@hF,0L\e(B
+\e$BCV$rJV$9!#\e(B
+</defun>
+
+<defun name="mime-entity-body-end">
            <args> entity
 <p>
-Entity \e$B$N\e(B file \e$BL>$rJV$9!#\e(B
+<var>entity</var> \e$B$,B8:_$9$k\e(B buffer \e$B$K$*$1$k!"\e(Bbody \e$B$,@j$a$kNN0h$NKvHx0L\e(B
+\e$BCV$rJV$9!#\e(B
+</defun>
+
+
+<h2> Entity \e$B$NI=8=$H<B8=\e(B
+<node> mm-backend
+<p>
+Entity \e$B$OCj>]2=$5$l$?%G!<%?I=8=$G!"<B:]$N%G!<%?I=8=$H$7$F$OMQES$K1~$8$F\e(B
+\e$B$5$^$6$^$J$b$N$,MxMQ$G$-$k$h$&$K@_7W$5$l$F$$$^$9!#\e(B
+<p>
+\e$B$3$3$G!"\e(Bentity \e$B$,$I$&$$$&<oN`$NI=8=$r9T$C$F$$$k$+$r<($9$N$,\e(B
+<concept>representation-type</concept> \e$B$G!"\e(Bentity \e$B$r@8@.$9$k;~$K$O$3$l$r\e(B
+\e$B;XDj$7$^$9!#\e(B<cf node="Entity Creation">
+<p>
+\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
+\e$BMj$9$k$3$H$K$h$C$F<B8=$5$l$F$$$^$9!#\e(BEntity \e$B$O<+J,$N\e(B 
+representation-type \e$B$rCN$C$F$*$j!"$=$N\e(B representation-type \e$B$K1~$8$F<B:]\e(B
+\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
+method</concept> \e$B$H8F$S$^$9!#$^$?!"\e(Brepresentation-type \e$BKh$K$3$N$h$&$J4X\e(B
+\e$B?t$r$^$H$a$?$b$N$r\e(B <concept>mm-backend</concept> \e$B$H8F$S$^$9!#\e(B
+<p>
+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
+\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
+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
+\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
+\e$B;~$K<+F0E*$K\e(B require \e$B$5$l$^$9!#\e(B
+
+
+<h3> Entity \e$B$X$NJX$j\e(B
+<node> Request for entity
+<p>
+<defun name="mime-entity-send">
+             <args> entity message <rest> args
+<p>
+<var>entity</var> \e$B$K\e(B <var>message</var> \e$B$rAw$k!#\e(B
+<p>
+<var>args</var> \e$B$O\e(B <var>message</var> \e$B$N0z?t$G$"$k!#\e(B
 </defun>
 
 
+<h3> mm-backend \e$B$N:n$jJ}\e(B
+<node> mm-backend module
+<p>
+\e$B!J$9$_$^$;$s!#$=$N$&$A=q$-$^$9\e(B (^_^;\e$B!K\e(B
+<p>
+\e$B!J$H$j$"$($:!"\e(Bmm*.el \e$B$r;29M$K$7$F$/$@$5$$!K\e(B
+
+
 <h1> Content-Type \e$BMs$N>pJs\e(B
 <node> Content-Type
 <p>
@@ -770,21 +858,6 @@ data \e$B$O\e(B <a node="binary"><concept>binary</concept></a> \e$B$H8F$V$3$H$K$9\e(
 \e$B$"$k!#\e(B
 
 
-<h3> Base64
-<node> Base64
-<p>
-<dref>RFC 2045</dref> \e$B$GDj5A$5$l$F$$$k\e(B <dref>MIME</dref> \e$B$K$*$1$k\e(B <a
-node="binary">binary data</a> \e$B$N\e(B network \e$B$G$NJQ49K!$N#1$D!#\e(B
-<p>
-\e$B!X\e(B64 \e$B?J?t!Y$H$$$&0UL#$G!"\e(B3 byte \e$B$N\e(B data \e$B$r\e(B 0 \e$B$+$i\e(B 63 \e$B$N?t$rI=$9\e(B 
-<dref>ASCII</dref> 4 \e$BJ8;z$KJQ49$9$kJ}K!!#!J$b$7!"\e(B4 \e$BJ8;z$K$J$i$J$1$l$P\e(B 
-<concept>pad</concept> \e$B$H8F$P$l$k5M$aJ*$r$7$FD9$5$rD4@0$9$k!K\e(B
-<p>
-\e$B$3$N\e(B 65 \e$B<oN`$NJ8;z$O\e(B ASCII \e$B$H\e(B EBCDIC \e$B$N6&DLItJ,$+$iA*$P$l$F$*$j!"\e(B
-Internet \e$B0J30$N\e(B network \e$B$r7PM3$9$k>l9g$G$b0BA4$KE>Aw$G$-$k$h$&$K@_7W$5\e(B
-\e$B$l$F$$$k!#\e(B
-
-
 <h3> ASCII
 <node> ASCII
 <p>
@@ -797,10 +870,19 @@ A-Z, a-z \e$B$N\e(B Latin \e$BJ8;z$H?t;z!"4v$D$+$N5-9f$+$i$J$k!#\e(BISO 646 \e$B$N0l$
              number="ANSI X3.4" year="1986">
 
 
-<h3> Coded character set\e$B!JId9f2=J8;z=89g!K\e(B, Character code\e$B!JJ8;zId9f!K\e(B
-<node> Coded character set
+<h3> Base64
+<node> Base64
 <p>
-\e$BJ8;z$H\e(B byte \e$BNs$H#1BP#1$KBP1~IU$1$k[#Kf$G$J$$5,B'$N=89g!#\e(B
+<dref>RFC 2045</dref> \e$B$GDj5A$5$l$F$$$k\e(B <dref>MIME</dref> \e$B$K$*$1$k\e(B <a
+node="binary">binary data</a> \e$B$N\e(B network \e$B$G$NJQ49K!$N#1$D!#\e(B
+<p>
+\e$B!X\e(B64 \e$B?J?t!Y$H$$$&0UL#$G!"\e(B3 byte \e$B$N\e(B data \e$B$r\e(B 0 \e$B$+$i\e(B 63 \e$B$N?t$rI=$9\e(B 
+<dref>ASCII</dref> 4 \e$BJ8;z$KJQ49$9$kJ}K!!#!J$b$7!"\e(B4 \e$BJ8;z$K$J$i$J$1$l$P\e(B 
+<concept>pad</concept> \e$B$H8F$P$l$k5M$aJ*$r$7$FD9$5$rD4@0$9$k!K\e(B
+<p>
+\e$B$3$N\e(B 65 \e$B<oN`$NJ8;z$O\e(B ASCII \e$B$H\e(B EBCDIC \e$B$N6&DLItJ,$+$iA*$P$l$F$*$j!"\e(B
+Internet \e$B0J30$N\e(B network \e$B$r7PM3$9$k>l9g$G$b0BA4$KE>Aw$G$-$k$h$&$K@_7W$5\e(B
+\e$B$l$F$$$k!#\e(B
 
 
 <h3> binary
@@ -818,6 +900,12 @@ A-Z, a-z \e$B$N\e(B Latin \e$BJ8;z$H?t;z!"4v$D$+$N5-9f$+$i$J$k!#\e(BISO 646 \e$B$N0l$
 data \e$B$r;X$9$3$H$,$"$k!#\e(B
 
 
+<h3> Coded character set\e$B!JId9f2=J8;z=89g!K\e(B, Character code\e$B!JJ8;zId9f!K\e(B
+<node> Coded character set
+<p>
+\e$BJ8;z$H\e(B byte \e$BNs$H#1BP#1$KBP1~IU$1$k[#Kf$G$J$$5,B'$N=89g!#\e(B
+
+
 <h3> media-type
 <node> media-type
 <p>
@@ -825,7 +913,7 @@ data \e$B$r;X$9$3$H$,$"$k!#\e(B
 <concept>primary-type</concept> \e$B$H\e(B <concept>subtype</concept> \e$B$+$i$J$k!#\e(B
 <dref>RFC 2046</dref> \e$B$GDj5A$5$l$F$$$k!#\e(B
 <p>
-type \e$B$OI8=`$G$O\e(B
+primary-type \e$B$OI8=`$G$O\e(B
 
 <ul>
 <li><concept>text</concept>