mirror of
https://github.com/php/doc-ru.git
synced 2025-08-11 02:43:11 +00:00
226 lines
7.9 KiB
XML
226 lines
7.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="function.imap-fetchstructure" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>imap_fetchstructure</refname>
|
||
<refpurpose>Читает структуру указанного сообщения</refpurpose>
|
||
</refnamediv>
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_fetchstructure</methodname>
|
||
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
|
||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Извлекает информацию о структуре указанного сообщения.
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
&imap.imap-parameter.imap;
|
||
<varlistentry>
|
||
<term><parameter>message_num</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Номер сообщения
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>flags</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Если задано как <constant>FT_UID</constant>, то в
|
||
<parameter>message_num</parameter> должны быть <literal>UID</literal> сообщений,
|
||
а не их номера.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
Возвращает объект со свойствами, перечисленными в таблице ниже&return.falseforfailure;.
|
||
</para>
|
||
<para>
|
||
<table>
|
||
<title>
|
||
Объект, возвращаемый <function>imap_fetchstructure</function>
|
||
</title>
|
||
<tgroup cols="2">
|
||
<tbody>
|
||
<row>
|
||
<entry>type</entry>
|
||
<entry>Первичный тип тела</entry>
|
||
</row>
|
||
<row>
|
||
<entry>encoding</entry>
|
||
<entry>Кодировка тела</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifsubtype</entry>
|
||
<entry>&true;, если есть строка подтипа</entry>
|
||
</row>
|
||
<row>
|
||
<entry>subtype</entry>
|
||
<entry><acronym>MIME</acronym>-подтип</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifdescription</entry>
|
||
<entry>&true;, если есть строка описания</entry>
|
||
</row>
|
||
<row>
|
||
<entry>description</entry>
|
||
<entry>Контент строки описания</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifid</entry>
|
||
<entry>&true;, если есть строка идентификатор</entry>
|
||
</row>
|
||
<row>
|
||
<entry>id</entry>
|
||
<entry>Строка идентификатор</entry>
|
||
</row>
|
||
<row>
|
||
<entry>lines</entry>
|
||
<entry>Количество строк</entry>
|
||
</row>
|
||
<row>
|
||
<entry>bytes</entry>
|
||
<entry>Количество байт</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifdisposition</entry>
|
||
<entry>&true;, если есть строка расположения</entry>
|
||
</row>
|
||
<row>
|
||
<entry>disposition</entry>
|
||
<entry>Строка расположения</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifdparameters</entry>
|
||
<entry>&true;, если есть массив <varname>dparameters</varname></entry>
|
||
</row>
|
||
<row>
|
||
<entry>dparameters</entry>
|
||
<entry>Массив объектов, каждый из которых имеет свойства
|
||
<literal>"attribute"</literal> и <literal>"value"</literal>, соответствующие
|
||
параметрам <literal>Content-disposition</literal> заголовка
|
||
<acronym>MIME</acronym>.</entry>
|
||
</row>
|
||
<row>
|
||
<entry>ifparameters</entry>
|
||
<entry>&true;, если есть массив параметров</entry>
|
||
</row>
|
||
<row>
|
||
<entry>parameters</entry>
|
||
<entry>Массив объектов, каждый из которых имеет свойства
|
||
<literal>"attribute"</literal> и <literal>"value"</literal>.</entry>
|
||
</row>
|
||
<row>
|
||
<entry>parts</entry>
|
||
<entry>Массив объектов идентичных по структуре с верхнеуровневым объектом,
|
||
каждый из которых соответствует <acronym>MIME</acronym> части тела.</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</table>
|
||
</para>
|
||
<para>
|
||
<table>
|
||
<title>Первичный тип тела (значения могут отличаться в зависимости от используемой
|
||
библиотеки, так что рекомендуется использовать константы)</title>
|
||
<tgroup cols="3">
|
||
<thead>
|
||
<row><entry>Значение</entry><entry>Тип</entry><entry>Константа</entry></row>
|
||
</thead>
|
||
<tbody>
|
||
<row><entry>0</entry><entry>text</entry><entry>TYPETEXT</entry></row>
|
||
<row><entry>1</entry><entry>multipart</entry><entry>TYPEMULTIPART</entry></row>
|
||
<row><entry>2</entry><entry>message</entry><entry>TYPEMESSAGE</entry></row>
|
||
<row><entry>3</entry><entry>application</entry><entry>TYPEAPPLICATION</entry></row>
|
||
<row><entry>4</entry><entry>audio</entry><entry>TYPEAUDIO</entry></row>
|
||
<row><entry>5</entry><entry>image</entry><entry>TYPEIMAGE</entry></row>
|
||
<row><entry>6</entry><entry>video</entry><entry>TYPEVIDEO</entry></row>
|
||
<row><entry>7</entry><entry>model</entry><entry>TYPEMODEL</entry></row>
|
||
<row><entry>8</entry><entry>other</entry><entry>TYPEOTHER</entry></row>
|
||
</tbody>
|
||
</tgroup>
|
||
</table>
|
||
</para>
|
||
<para>
|
||
<table>
|
||
<title>Кодировка (значения могут отличаться в зависимости от используемой
|
||
библиотеки, так что рекомендуется использовать константы)</title>
|
||
<tgroup cols="3">
|
||
<thead>
|
||
<row><entry>Значение</entry><entry>Тип</entry><entry>Константа</entry></row>
|
||
</thead>
|
||
<tbody>
|
||
<row><entry>0</entry><entry>7bit</entry><entry>ENC7BIT</entry></row>
|
||
<row><entry>1</entry><entry>8bit</entry><entry>ENC8BIT</entry></row>
|
||
<row><entry>2</entry><entry>Binary</entry><entry>ENCBINARY</entry></row>
|
||
<row><entry>3</entry><entry>Base64</entry><entry>ENCBASE64</entry></row>
|
||
<row><entry>4</entry><entry>Quoted-Printable</entry><entry>ENCQUOTEDPRINTABLE</entry></row>
|
||
<row><entry>5</entry><entry>other</entry><entry>ENCOTHER</entry></row>
|
||
</tbody>
|
||
</tgroup>
|
||
</table>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="changelog">
|
||
&reftitle.changelog;
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
&imap.changelog.imap-param;
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>imap_fetchbody</function></member>
|
||
<member><function>imap_bodystruct</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
|
||
-->
|