Update imap-getmailboxes.xml

This commit is contained in:
Mikhail Alferov
2024-04-01 14:13:49 +03:00
committed by GitHub
parent 85a997b794
commit 246df19bd6

View File

@ -4,7 +4,7 @@
<refentry xml:id="function.imap-getmailboxes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_getmailboxes</refname>
<refpurpose>Читает список почтовых ящиков, возвращая подробную информацию по каждому из них</refpurpose>
<refpurpose>Читает список почтовых ящиков и возвращает подробную информацию по каждому из них</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -15,7 +15,7 @@
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
Получает информацию о почтовых ящиков.
Функция получает информацию о почтовых ящиках.
</para>
</refsect1>
<refsect1 role="parameters">
@ -27,7 +27,9 @@
<term><parameter>reference</parameter></term>
<listitem>
<para>
<parameter>reference</parameter> обычно должен быть только спецификацией сервера, как описано в <function>imap_open</function>
Обычно значение параметра <parameter>reference</parameter>
должно содержать только спецификацию сервера,
как описывает страница функции <function>imap_open</function>.
</para>
&imap.mailboxname.insecure;
</listitem>
@ -44,59 +46,59 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает массив объектов, содержащих информацию о ящиках.
Каждый объект имеет свойства: <parameter>name</parameter>, содержащее
Функция возвращает массив объектов, которые содержат информацию о почтовых ящиках.
Каждый объект содержит свойства: <parameter>name</parameter>, которое указывает
полное имя ящика; <parameter>delimiter</parameter>,
содержащее разделитель для той части иерархии, в которой
которое содержит разделитель для той части иерархии, в которой
содержится ящик; и <parameter>attributes</parameter>.
Параметр <parameter>Attributes</parameter> является битовой маской,
следующих допустимых констант:
Параметр <parameter>Attributes</parameter> битовая маска
из следующих констант:
<itemizedlist>
<listitem>
<para>
<constant>LATT_NOINFERIORS</constant> - этот ящик не имеет и не может иметь
потомков (содержать вложенные ящики). Вызов функции
<constant>LATT_NOINFERIORS</constant> — Ящик не содержит и не может содержать
«потомков», то есть содержать вложенные ящики. Вызов функции
<function>imap_createmailbox</function> не будет работать для этого ящика.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_NOSELECT</constant> - это только контейнер, а не почтовый ящик.
Вы не можете его открыть.
<constant>LATT_NOSELECT</constant> — Это только контейнер, а не почтовый ящик.
Его нельзя открыть.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_MARKED</constant> - Этот ящик помечен. Означает, что в нем могут
быть новые письма, появившиеся с момента последней проверки. Работает не со всеми
<constant>LATT_MARKED</constant> Этот ящик помечен. Означает, что в ящике могут
быть новые письма, которые появились с момента последней проверки. Работает не со всеми
серверами IMAP.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_UNMARKED</constant> - Этот ящик не помечен, т.е. в нем нет
новых писем. Если один из флагов <constant>MARKED</constant> или
<constant>UNMARKED</constant> выставлен - можете считать, что сервер поддерживает
<constant>LATT_UNMARKED</constant> Этот ящик не помечен, то есть в ящике нет
новых писем. Если выставлен флаг <constant>MARKED</constant> или
<constant>UNMARKED</constant> считается, что сервер поддерживает
этот функционал.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_REFERRAL</constant> - Этот контейнер имеет направления (referral) на удалённый почтовый ящик.
<constant>LATT_REFERRAL</constant> Этот контейнер имеет направления (referral) на удалённый почтовый ящик.
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASCHILDREN</constant> - Этот почтовый ящик имеет выбираемые подчинённые (inferiors).
<constant>LATT_HASCHILDREN</constant> У этого почтового ящика есть выбираемые подчинённые (inferiors).
</para>
</listitem>
<listitem>
<para>
<constant>LATT_HASNOCHILDREN</constant> - Этот почтовый ящик не имеет выбираемые подчинённые (inferiors).
<constant>LATT_HASNOCHILDREN</constant> У этого почтового ящика нет выбираемых подчинённых (inferiors).
</para>
</listitem>
</itemizedlist>
Функция возвращает &false; в случае возникновения ошибки.
Функция возвращает &false;, если возникла ошибка.
</para>
</refsect1>
@ -121,12 +123,16 @@
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>imap_getmailboxes</function></title>
<title>
Пример использования функции <function>imap_getmailboxes</function>
</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . imap_last_error());
or die("Не удалось подключиться: " . imap_last_error())
;
$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
@ -141,6 +147,7 @@ if (is_array($list)) {
}
imap_close($mbox);
?>
]]>
</programlisting>