Files
php-doc-ru/reference/mailparse/functions/mailparse-msg-parse-file.xml
2024-03-26 17:53:34 +03:00

95 lines
2.9 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f7ee3294054f619f354d22aca3c5cb7c92b69962 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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
-->