git-svn-id: https://svn.php.net/repository/phpdoc/ru/trunk@341474 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrey Gromov
2016-12-27 09:55:59 +00:00
parent a55507b542
commit 8303a362b0
15 changed files with 1371 additions and 0 deletions

View File

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 94497636f2f6956ba6bf1017297d589009fbd040 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.libxml-set-external-entity-loader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>libxml_set_external_entity_loader</refname>
<refpurpose>Изменение загрузчика по умолчанию для внешних объектов</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>libxml_set_external_entity_loader</methodname>
<methodparam><type>callable</type><parameter>resolver_function</parameter></methodparam>
</methodsynopsis>
<para>
Изменение загрузчика по умолчанию для внешних объектов.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>resolver_function</parameter></term>
<listitem>
<para>
Функция обратного вызова (<type>callable</type>), принимающая три аргумента.
Две строки, публичный и системный идентификаторы и контекст (массив с четырьмя ключами).
Эта функция должна возвращать ресурс, строку, из которой этот ресурс можно открыть,
или &null;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>libxml_set_external_entity_loader</function></title>
<programlisting role="php">
<![CDATA[
<?php
$xml = <<<XML
<!DOCTYPE foo PUBLIC "-//FOO/BAR" "http://example.com/foobar">
<foo>bar</foo>
XML;
$dtd = <<<DTD
<!ELEMENT foo (#PCDATA)>
DTD;
libxml_set_external_entity_loader(
function ($public, $system, $context) use($dtd) {
var_dump($public);
var_dump($system);
var_dump($context);
$f = fopen("php://temp", "r+");
fwrite($f, $dtd);
rewind($f);
return $f;
}
);
$dd = new DOMDocument;
$r = $dd->loadXML($xml);
var_dump($dd->validate());
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(10) "-//FOO/BAR"
string(25) "http://example.com/foobar"
array(4) {
["directory"] => NULL
["intSubName"] => NULL
["extSubURI"] => NULL
["extSubSystem"] => NULL
}
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>libxml_disable_entity_loader</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
-->

View File

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-determine-best-xfer-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_determine_best_xfer_encoding</refname>
<refpurpose>Определить наилучший путь декодирования</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_determine_best_xfer_encoding</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Определяет наилучший путь декодирования контента, прочитанного из указанного файлового дескриптора.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fp</parameter></term>
<listitem>
<para>
Корректный указатель на файл, который должен быть перематываемым.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает одну из кодировок, поддерживаемую модулем <link linkend="ref.mbstring">mbstring</link>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>mailparse_determine_best_xfer_encoding</function></title>
<programlisting role="php">
<![CDATA[
<?php
$fp = fopen('somemail.eml', 'r');
echo 'Best encoding: ' . mailparse_determine_best_xfer_encoding($fp);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Best encoding: 7bit
]]>
</screen>
</example>
</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
-->

View File

@ -0,0 +1,59 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-create" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_create</refname>
<refpurpose>Создает почтовый MIME-ресурс</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>mailparse_msg_create</methodname>
<void/>
</methodsynopsis>
<para>
Создает почтовый <literal>MIME</literal>-ресурс.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает обработчик, который можно использовать для разбора сообщения.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_free</function></member>
<member><function>mailparse_msg_parse_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
-->

View File

@ -0,0 +1,108 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<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
-->

View File

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-extract-part" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_extract_part</refname>
<refpurpose>
Извлечь/декодировать секцию с сообщением
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mailparse_msg_extract_part</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>msgbody</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msgbody</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_extract_part_file</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
-->

View File

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-extract-whole-part-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_extract_whole_part_file</refname>
<refpurpose>Извлеч секцию сообщения вместе с загаловками без декодирования</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mailparse_msg_extract_whole_part_file</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>callbackfunc</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callbackfunc</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_extract_part</function></member>
<member><function>mailparse_msg_extract_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
-->

View File

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-free" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_free</refname>
<refpurpose>Высвободить MIME-ресурс</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mailparse_msg_free</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
<para>
Высвобождает <literal>MIME</literal>-ресурс.
</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> или
<function>mailparse_msg_parse_file</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mailparse_msg_create</function></member>
<member><function>mailparse_msg_parse_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
-->

View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-get-part-data" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_get_part_data</refname>
<refpurpose>Вернуть ассоциативный массив с информацией о сообщении</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_msg_get_part_data</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс.
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->

View File

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-get-part" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_get_part</refname>
<refpurpose>Возвращает указатель на заданную секцию в mime-сообщении</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>mailparse_msg_get_part</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>mimesection</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mimesection</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->

View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-get-structure" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_get_structure</refname>
<refpurpose>Получить массив имен mime-секций в заданном сообщении</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_msg_get_structure</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс.
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->

View File

@ -0,0 +1,78 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<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>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает <literal>MIME</literal>-ресурс, представляющий структуру, или
&false; в случае ошибки.
</para>
</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
-->

View File

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-msg-parse" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_msg_parse</refname>
<refpurpose>Инкрементально разбирает данные в буфер</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mailparse_msg_parse</methodname>
<methodparam><type>resource</type><parameter>mimemail</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Инкрементально разбирает данные в заданный MIME-ресурс.
</para>
<para>
Эта функция позволяет обрабатывать файл по частям, вместо того, чтобы
читать и обрабатывать сразу весь массив данных.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mimemail</parameter></term>
<listitem>
<para>
Корректный <literal>MIME</literal>-ресурс.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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
-->

View File

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-rfc822-parse-addresses" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mailparse_rfc822_parse_addresses</refname>
<refpurpose>Разобрать адреса в соответствии с RFC 822</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
</methodsynopsis>
<para>
Разбирает список получателей в соответствии с <link xlink:href="&url.rfc;822">RFC 822</link>.
Список получателей обычно находится в заголовоке <literal>To:</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>addresses</parameter></term>
<listitem>
<para>
Строка, содержащая адреса. Например:
<literal>Wez Furlong &lt;wez@example.com&gt;, doe@example.com</literal>
</para>
<note>
<para>
Эта строка не должна содержать название заголовка.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает ассоциативный массив для каждого получателя со следующими ключами:
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><literal>display</literal></entry>
<entry>
Имя получателя. Если эта часть адреса не задана, то будет использовано то же значение,
что и для <literal>address</literal>.
</entry>
</row>
<row>
<entry><literal>address</literal></entry>
<entry>Адрес email</entry>
</row>
<row>
<entry><literal>is_group</literal></entry>
<entry>&true; если получатель является группой рассылки и &false;, если нет.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>mailparse_rfc822_parse_addresses</function></title>
<programlisting role="php">
<![CDATA[
<?php
$to = 'Wez Furlong <wez@example.com>, doe@example.com';
var_dump(mailparse_rfc822_parse_addresses($to));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
[0]=>
array(3) {
["display"]=>
string(11) "Wez Furlong"
["address"]=>
string(15) "wez@example.com"
["is_group"]=>
bool(false)
}
[1]=>
array(3) {
["display"]=>
string(15) "doe@example.com"
["address"]=>
string(15) "doe@example.com"
["is_group"]=>
bool(false)
}
}
]]>
</screen>
</example>
</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
-->

View File

@ -0,0 +1,120 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-stream-encode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_stream_encode</refname>
<refpurpose>
Кодирует поток из файла источника и пишет в файл получатель.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mailparse_stream_encode</methodname>
<methodparam><type>resource</type><parameter>sourcefp</parameter></methodparam>
<methodparam><type>resource</type><parameter>destfp</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Кодирует с помощью <parameter>encoding</parameter>
поток из файла источника и пишет в файл получатель.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>sourcefp</parameter></term>
<listitem>
<para>
Корректный файловый дескриптор источника.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfp</parameter></term>
<listitem>
<para>
Корректный файловый дескриптор получателя.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Одна из кодировок, поддерживаемых модулем <link linkend="ref.mbstring">mbstring</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>mailparse_stream_encode</function></title>
<programlisting role="php">
<![CDATA[
<?php
// email.eml содержит: hello, this is some text=hello.
$fp = fopen('email.eml', 'r');
$dest = tmpfile();
mailparse_stream_encode($fp, $dest, "quoted-printable");
rewind($dest);
// Отображаем контент нового файла
fpassthru($dest);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
hello, this is some text=3Dhello.
]]>
</screen>
</example>
</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
-->

View File

@ -0,0 +1,140 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<!-- $Revision$ -->
<refentry xml:id="function.mailparse-uudecode-all" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mailparse_uudecode_all</refname>
<refpurpose>
Сканирует данные из указанного файла и извлекает все вложенные файлы, кодированные в uuencode
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_uudecode_all</methodname>
<methodparam><type>resource</type><parameter>fp</parameter></methodparam>
</methodsynopsis>
<para>
Сканирует данные из указанного файла и извлекает все вложенные файлы, кодированные
в uuencode, во временные файлы.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fp</parameter></term>
<listitem>
<para>
Файловый дескриптор.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает ассоциативный массив, содержащий информацию по извлеченным файлам.
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><literal>filename</literal></entry>
<entry>Путь к созданному временному файлу</entry>
</row>
<row>
<entry><literal>origfilename</literal></entry>
<entry>Оригинальное имя файла, только для кодированных uuencode</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Первый элемент будет содержать тело сообщения. Все последующие - информацию
по извлеченным вложениям.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>mailparse_uudecode_all</function></title>
<programlisting role="php">
<![CDATA[
<?php
$text = <<<EOD
To: fred@example.com
hello, this is some text hello.
blah blah blah.
begin 644 test.txt
/=&AI<R!I<R!A('1E<W0*
`
end
EOD;
$fp = tmpfile();
fwrite($fp, $text);
$data = mailparse_uudecode_all($fp);
echo "BODY\n";
readfile($data[0]["filename"]);
echo "UUE ({$data[1]['origfilename']})\n";
readfile($data[1]["filename"]);
// Очищаем
unlink($data[0]["filename"]);
unlink($data[1]["filename"]);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
BODY
To: fred@example.com
hello, this is some text hello.
blah blah blah.
UUE (test.txt)
this is a test
]]>
</screen>
</example>
</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
-->