mailparse-msg-parse-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f7ee3294054f619f354d22aca3c5cb7c92b69962 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.mailparse-msg-parse-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mailparse_msg_parse_file</refname>
  <refpurpose>ファイルをパースする</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>mailparse_msg_parse_file</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   ファイルをパースします。
   ディスク上にあるメールファイルをパースするための最良の方法です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       メッセージを保持するファイルへのパス。
       このファイルがオープンされ、ストリームとしてパーサに流し込まれます。
      </para>
      <note>
       <para>
        <parameter>filename</parameter> が保持するメッセージは、
        改行コード(<literal>CRLF</literal>) で終わることが想定されています。
        そうでない場合、最後の行がパースされません。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   構造を表す <literal>MIME</literal> リソース、あるいはエラー時に
   &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数が作成したリソースが必要なくなった際は、
    メモリリークを避けるため
    <function>mailparse_msg_free</function> をコールすることを推奨します。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mailparse_msg_free</function></member>
    <member><function>mailparse_msg_create</function></member>
   </simplelist>
  </para>
 </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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->