1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
archived-doc-ja/reference/mailparse/functions/mailparse-msg-parse-file.xml
2026-02-24 23:42:11 +09:00

92 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 01bd007b034e7b37d019c4ec3d5fca2f8955518f Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mailparse-msg-parse-file">
<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>
<simpara>
ファイルをパースします。
ディスク上にあるメールファイルをパースするための最良の方法です。
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<simpara>
メッセージを保持するファイルへのパス。
このファイルがオープンされ、ストリームとしてパーサーに流し込まれます。
</simpara>
<note>
<simpara>
<parameter>filename</parameter> が保持するメッセージは、
改行コード(<literal>CRLF</literal>) で終わることが想定されています。
そうでない場合、最後の行がパースされません。
</simpara>
</note>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
構造を表す <literal>MIME</literal> リソース、あるいはエラー時に
&false; を返します。
</simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
この関数が作成したリソースが必要なくなった際は、
メモリリークを避けるため
<function>mailparse_msg_free</function> をコールすることを推奨します。
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>mailparse_msg_free</function></member>
<member><function>mailparse_msg_create</function></member>
</simplelist>
</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
-->