cvs: peardoc /ja/core/mail mimedecode.xml

From: Date: Thu, 05 Dec 2002 23:35:06 +0000
Subject: cvs: peardoc /ja/core/mail mimedecode.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-97@lists.php.net to get a copy of this message
hirokawa Thu Dec 5 18:35:06 2002 EDT Added files: /peardoc/ja/core/mail mimedecode.xml Log: added mimedecode.xml in japanese manual.

Index: peardoc/ja/core/mail/mimedecode.xml +++ peardoc/ja/core/mail/mimedecode.xml <!-- $Id: mimedecode.xml,v 1.1 2002/12/05 23:35:06 hirokawa Exp $ --> <refentry id="core.mail.mimedecode"> <refnamediv> <refname>Mail_mimeDecode</refname> <refpurpose>MIMEメッセージを処理</refpurpose> </refnamediv> <refsect1 id="core.mail.mimedecode.desc"> <title>説明</title> <para> <classname>Mail_mimeDecode</classname> は、MIMEメッセージを処理する 関数です。この関数は、指定した入力をPHPのデータ構造体にデコードします。 </para> </refsect1> <refsect1 id="core.mail.mimedecode.mail_mimedecode"> <title>Mail_mimeDecode::Mail_mimeDecode()</title> <funcsynopsis> <funcprototype> <funcdef>Mail_mimeDecode <function>Mail_mimeDecode</function></funcdef> <paramdef> string <parameter>$input</parameter> </paramdef> <paramdef> string <parameter><optional>$crlf = "\r\n"</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> <refsect2 id="core.mail.mimepart.mail_mimedecode.description"> <title>説明</title> <para> <classname>Mail_mimeDecode</classname>の新規インスタンスを返す </para> </refsect2> <refsect2 id="core.mail.mimedecode.mail_mimedecode.parameter"> <title>パラメータ</title> <para> <itemizedlist> <listitem> <para> <parameter>string $input</parameter> - デコードするメッセージ。 </para> </listitem> <listitem> <para> <parameter>string $crlf</parameter> - 使用する行末記号を指 定します。通常は、<parameter>CRLF</parameter>または <parameter>LF</parameter>のみです。このオプションは、このクラス が動作するかどうかの違いを生むことがあります。 この引数で指定したものだけをemailで確実に使用することが強く推奨 されます。デフォルトは、<parameter>CRLF</parameter>です。 </para> </listitem> </itemizedlist> </para> </refsect2> </refsect1> <refsect1 id="core.mail.mimedecode.decode"> <title>Mail_mime::decode()</title> <funcsynopsis> <funcprototype> <funcdef>array <function>decode</function></funcdef> <paramdef>array <parameter>$args</parameter></paramdef> </funcprototype> </funcsynopsis> <refsect2 id="core.mail.mimedecode.decode.description"> <title>説明</title> <para> この関数は、デコード処理を小子内、メッセージデータを含む構造体を返 します。 </para> </refsect2> <refsect2 id="core.mail.mimedecode.decode.parameter"> <title>パラメータ</title> <para> <itemizedlist> <listitem> <para> <parameter>array $args</parameter> - <itemizedlist> <listitem> <para> <parameter>boolean $args['include_bodies']</parameter> - 返される構造体にbodyを含めるどうか。 </para> </listitem> <listitem> <para> <parameter>boolean $args['decode_bodies']</parameter> - 返されるbodyをデコードするかどうか。 </para> </listitem> <listitem> <para> <parameter>boolean $args['decode_headers']</parameter> - ヘッダをデコードするかどうか。 (<ulink url="http://www.faqs.org/rfcs/rfc2047.html">RFC2047 </ulink>). </para> </listitem> <listitem> <para> <parameter>string $args['input']</parameter> - 静的にコールされた場合のみ、 この入力をデコードするかどうかを指定するために使用されます。 </para> </listitem> <listitem> <para> <parameter>string $args['crlf']</parameter> - 静的にコールされた場合のみ、 行末を指定するために使用されます。 </para> </listitem> </itemizedlist> </para> </listitem> </itemizedlist> </para> </refsect2> <refsect2 id="core.mail.mimedecode.decode.return"> <title>返り値</title> <para> <itemizedlist> <listitem> <para> <parameter>array</parameter> - <itemizedlist> <listitem> <para> <parameter>array $return['headers']</parameter> - ヘッダの連想配列。配列のキーは、ヘッダ名(小文字に変換)、値は そのヘッダの値(大文字小文字はそのまま)です。(Recieved:のよう に)同じ名前で複数のヘッダがある場合、各ヘッダの値の数値添字 の配列となります。パラメータ <parameter>decode_headers</parameter> にtrueが指定された場合、 ヘッダはデコードされます。(RFC2047) </para> </listitem> <listitem> <para> <parameter>string $return['ctype_primary']</parameter> - content typeの最初の部分。 (すなわち、前向きスラッシュの前) 例えば、content typeが <parameter>multipart/mixed</parameter>の場合、ctype_primary は<parameter>"multipart"</parameter>となります。 </para> </listitem> <listitem> <para> <parameter>string $return['ctype_secondary']</parameter> - content typeの2番目部分。 例えば、content typeが<parameter>multipart/mixed</parameter> の場合、ctype_secondaryは <parameter>"mixed"</parameter>となります。 </para> </listitem> <listitem> <para> <parameter>array $return['ctype_parameter']</parameter> - content typeヘッダにパラメータがある場合(例えば、 <parameter>boundary="=_hudfhdsalfhds8fy8329hfj</parameter>")、 この連想配列に代入されます。キーは、パラメータ名(例: <parameter>boundary</parameter>)、一方、値はそのパラメータの 値(例 =<parameter>_hudfhdsalfhds8fy8329hfj</parameter>)とな ります。 </para> </listitem> <listitem> <para> <parameter>string $return['disposition']</parameter> - Content-Dispositionヘッダがある場合、その値がここに指定され ます。これは、通常、<parameter>"inline"</parameter>または <parameter>"attachment"</parameter>のどちらかです。 </para> </listitem> <listitem> <para> <parameter>array $return['d_parameters']</parameter> - Content-Dispositionに何らかのパラメータが指定された場合、こ こに連想配列が代入され、キーはパラメータ名、値はそのパラメー タの値となります。<parameter>"name"</parameter>と <parameter>"filename"</parameter>がよくある例です。 </para> </listitem> <listitem> <para> <parameter>array $return['body']</parameter> - (静的または通常の変数のどちらかの)このクラスのインスタンス生 成時に<parameter>include_bodies</parameter>パラメータが指定 され、かつ、bodyパートを有する場合に代入されます。 <parameter>multipart/*</parameter>を有するMIMEパートは、通常、 bodyを有さず、サブパートから構成されます。パラメータ <parameter>decode_bodies</parameter>に <parameter>true</parameter>が指定された場合、bodyはデコード されます。 </para> </listitem> <listitem> <para> <parameter>array $return['parts']</parameter> - あるMIMEパートがサブパートからなる場合、ここに記述したものと 同様なプロパティを有するオブジェクトからなる配列となります。 </para> </listitem> </itemizedlist> </para> </listitem> </itemizedlist> </para> </refsect2> </refsect1> <refsect1 id="core.mail.mimedecode.uudecode"> <title>Mail_mime::uudecode()</title> <funcsynopsis> <funcprototype> <funcdef>array <function>uudecode</function></funcdef> <paramdef>string <parameter>$input</parameter></paramdef> </funcprototype> </funcsynopsis> <refsect2 id="core.mail.mimedecode.uudecode.description"> <title>説明</title> <para> <function>uudecode</function>は、指定したメッセージのuuencodeされ た部分を探します。<parameter>UU</parameter>は、<emphasis> Unix-to-Unix</emphasis>プロトコルを意味します。実際、uuencodeは、 インターネット上で7ビットASCII文字によりファイルを伝送するプロトコ ルとして一般に使用されています。 </para> </refsect2> <refsect2 id="core.mail.mimedecode.uudecode.parameter"> <title>パラメータ</title> <para> <itemizedlist> <listitem> <para> <parameter>string $input</parameter> - デコードするメッセージ。 </para> </listitem> </itemizedlist> </para> </refsect2> <refsect2 id="core.mail.mimedecode.uudecode.return"> <title>返り値</title> <para> <itemizedlist> <listitem> <para> <parameter>array</parameter> - 連想配列の配列 <itemizedlist> <listitem> <para> <parameter>string $return[]['filename']</parameter> - uuencodeされたファイルの名前。 </para> </listitem> <listitem> <para> <parameter>string $return[]['fileperm']</parameter> - uuencodeされたファイルのファイル許可属性。UNIX形式、つまり、 <parameter>"0666"</parameter>または <parameter>"666"</parameter>です。 </para> </listitem> <listitem> <para> <parameter>string $return[]['filedata']</parameter> - uuencodeされたファイルのファイルの内容がデコードされたもの。 </para> </listitem> </itemizedlist> </para> </listitem> </itemizedlist> </para> </refsect2> <refsect2 id="core.mail.mimedecode.uudecode.note"> <title>注意</title> <para> <function>uudecode</function>は、static関数としてコールすることが できます。 </para> </refsect2> </refsect1> <refsect1 id="core.mail.mimedecode.getxml"> <title>Mail_mime::getXML()</title> <funcsynopsis> <funcprototype> <funcdef>string <function>getXML</function></funcdef> <paramdef>array <parameter>$decoded</parameter></paramdef> </funcprototype> </funcsynopsis> <refsect2 id="core.mail.mimedecode.getxml.description"> <title>説明</title> <para> <function>getXML</function>は、 <link linkend="core.mail.mimedecode.decode"><function>decode </function></link>から返された配列をXMLドキュメントに変換します。 このドキュメントのDTDは、Mail_MimeDecode-Packageまたは <ulink url="http://www.phpguru.org/xmail/">http://www.phpguru.org/xmail/ </ulink>から入手可能です。 </para> </refsect2> <refsect2 id="core.mail.mimedecode.getxml.parameter"> <title>パラメータ</title> <para> <itemizedlist> <listitem> <para> <parameter>array $decode</parameter> - <link linkend="core.mail.mimedecode.decode"> <function>decode</function></link>から返された配列。 </para> </listitem> </itemizedlist> </para> </refsect2> <refsect2 id="core.mail.mimedecode.getxml.return"> <title>返り値</title> <para> <itemizedlist> <listitem> <para> <parameter>string</parameter> - XMLドキュメント。 </para> </listitem> </itemizedlist> </para> </refsect2> <refsect2 id="core.mail.mimedecode.getxml.note"> <title>注意</title> <para> <function>getXML</function>はstatic関数としてコールすることができ ます。 </para> </refsect2> </refsect1> <refsect1 id="core.mail.mimedecode.example"> <title>例</title> <programlisting role="php"> <![CDATA[ <?php include 'Mail/mimeDecode.php'; ... $params['include_bodies'] = TRUE; $params['decode_bodies'] = TRUE; $params['decode_headers'] = TRUE; $decoder = new Mail_mimeDecode($input); $structure = $decoder->decode($params); ?> ]]> </programlisting> <para> この例は、decode関数を静的にコール(すなわち、オブジェクトを作成せ ずに関数を直接コール)した後、<link linkend="core.mail.mimedecode.getxml"> <function>getXML</function></link>関数に構造体を渡しています。 </para> <programlisting role="php"> <![CDATA[ <?php ... $params['include_bodies'] = TRUE; $params['decode_bodies'] = FALSE; $params['decode_headers'] = TRUE; $params['input'] = $input; $params['crlf'] = "\r\n"; $structure = Mail_mimeDecode::decode($params); $xml = Mail_mimeDecode::getXML($structure); ?> ]]> </programlisting> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
« previous php.pear.doc (#97) next »