imap-clearflag-full.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 673d373eda1740843eaef88e9665eb887f6f5752 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-clearflag-full" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_clearflag_full</refname>
  <refpurpose>Снимает с сообщения установленные флаги</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>imap_clearflag_full</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>sequence</parameter></methodparam>
   <methodparam><type>string</type><parameter>flag</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Эта функция оповещает хранилище, что необходимо снять заданный флаг
   <parameter>flag</parameter> для указанной последовательности
   сообщений <parameter>sequence</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>sequence</parameter></term>
     <listitem>
      <para>
       Последовательность номеров сообщений. Вы можете перечислить
       номера через запятую <literal>X,Y</literal>, или задать диапазон
       номеров с помощью двоеточия <literal>X:Y</literal>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flag</parameter></term>
     <listitem>
      <para>
       Флаги, которые можно удалить: "\\Seen", "\\Answered", "\\Flagged",
       "\\Deleted" и "\\Draft" (как определено в <link xlink:href="&url.rfc;2060">RFC2060</link>)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       <parameter>options</parameter> - битовая маска, которая может
       принимать единственное значение:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>ST_UID</constant> - аргумент sequence содержит список UID, а не
          последовательность номеров
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Выбрасывает исключение <classname>ValueError</classname>,
   если значение параметра <parameter>options</parameter> недопустимо.
  </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;
     <row>
      <entry>8.0.0</entry>
      <entry>
       Теперь выбрасывается исключение <classname>ValueError</classname>
       при недопустимых значениях параметра <parameter>options</parameter>.
       Ранее возникало предупреждение и функция возвращала логическое значение &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_setflag_full</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
-->