archived-doc-ru/reference/imap/functions/imap-delete.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 673d373eda1740843eaef88e9665eb887f6f5752 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-delete" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_delete</refname>
  <refpurpose>Помечает сообщение для удаления</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>imap_delete</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>message_nums</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Помечает сообщения, перечисленные в <parameter>message_nums</parameter> для
   удаления. Помеченные сообщения будут оставаться в ящике пока не будет вызвана
   функция <function>imap_expunge</function>, либо
   <function>imap_close</function> с установленным параметром
   <constant>CL_EXPUNGE</constant>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_nums</parameter></term>
     <listitem>
      <para>
       Строка (&string;), состоящая из одного или нескольких сообщений
       в формате последовательности в стиле IMAP4 (<literal>"n"</literal>, <literal>"n:m"</literal> или их комбинация,
       разделённая запятыми).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Можно задать как <constant>FT_UID</constant>, тогда функция будет
       ожидать в параметре <parameter>message_nums</parameter> не номер сообщения,
       а <literal>UID</literal>.
      </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>flags</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>flags</parameter>.
       Ранее возникало предупреждение и функция возвращала логическое значение &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>imap_delete</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
    or die("Не удалось подключиться: " . imap_last_error());

$check = imap_mailboxmsginfo($mbox);
echo "Сообщения до отметки для удаления: " . $check->Nmsgs . "<br />\n";

imap_delete($mbox, 1);

$check = imap_mailboxmsginfo($mbox);
echo "Сообщения после отметки для удаления: " . $check->Nmsgs . "<br />\n";

imap_expunge($mbox);

$check = imap_mailboxmsginfo($mbox);
echo "Сообщения после удаления: " . $check->Nmsgs . "<br />\n";

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Ящики IMAP могут не сохранять флаги между соединениями, следовательно если
    вы действительно хотите удалить помеченные сообщения, то необходимо
    вызывать <function>imap_expunge</function> в том же соединении, в котором
    флаги устанавливались.
   </para>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_undelete</function></member>
    <member><function>imap_expunge</function></member>
    <member><function>imap_close</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
-->