1
0
mirror of https://github.com/php/doc-ru.git synced 2026-03-29 11:12:08 +02:00
Files
archived-doc-ru/reference/mailparse/functions/mailparse-msg-extract-part-file.xml
Sergey Panteleev daef8df962 Обнуление тега Reviewed (#364)
[skip-lint]
[skip-spellcheck]
2021-11-16 13:03:53 +03:00

107 lines
3.7 KiB
XML
Raw 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: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mailparse-msg-extract-part-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_extract_part_file</refname>
<refpurpose>Извлечь/декодировать секцию с сообщением из файла</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_msg_extract_part_file</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>mixed</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
<para>
Извлечь/декодировать секцию с сообщением из указанного файла.
</para>
<para>
Контент сообщения будет декодирован в соответствии с кодировкой пересылки.
Поддерживаются следующие кодировки: base64, quoted-printable и uuencoded.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс, созданный <function>mailparse_msg_create</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Имя файла или корректный потоковый ресурс.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
<para>
Если задано, то в эту функцию будет передано извлечённое сообщение.
Если &null;, то извлечённое сообщение будет просто возвращено.
</para>
<para>
Если не задано, то контент будет направлен на стандартный вывод (stdout).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Если <parameter>callbackfunc</parameter> не &null;, то вернёт &true; в случае успешного выполнения.
</para>
<para>
Если <parameter>callbackfunc</parameter> задана как &null;, вернёт извлечённую
секцию сообщения в виде строки.
</para>
<para>
Вернёт &false; в случае возникновения ошибки.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_extract_part</function></member>
<member><function>mailparse_msg_extract_whole_part_file</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
-->