imap-delete.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 673d373eda1740843eaef88e9665eb887f6f5752 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-delete" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_delete</refname>
  <refpurpose>Marque le fichier pour l'effacement, dans la boîte aux lettres courante</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</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>
   Marque les messages <parameter>message_nums</parameter> pour l'effacement.
   L'effacement réel n'interviendra que lors de l'appel de la fonction
   <function>imap_expunge</function> ou de <function>imap_close</function>
   avec le paramètre optionnel <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>
       Une &string; représentant un ou plusieurs messages dans un style de
       format d'une séquence IMAP4 (<literal>"n"</literal>,
       <literal>"n:m"</literal>, ou une combinaison de ceci,
       délimité par des virgules).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Vous pouvez le définir à <constant>FT_UID</constant>
       qui demande à la fonction de traiter l'argument
       <parameter>message_nums</parameter> comme un <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>
   Lance une exception <classname>ValueError</classname> si le paramètre <parameter>flags</parameter> est invalide.
  </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>
       Une exception <classname>ValueError</classname> est désormais lancée
       pour des valeurs de paramètre <parameter>flags</parameter> invalides. Auparavant,
       un avertissement était émis et la fonction retournait &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>imap_delete</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
    or die("Connexion impossible : " . imap_last_error());

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages avant effacement : " . $check->Nmsgs . "<br />\n";

imap_delete($mbox, 1);

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages après effacement : " . $check->Nmsgs . "<br />\n";

imap_expunge($mbox);

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages après imap_expunge : " . $check->Nmsgs . "<br />\n";

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Les boîtes aux lettres IMAP n'ont pas les flags de leurs messages de sauvegardés
    entre les connexions, aussi la fonction <function>imap_expunge</function> doit
    être appelée pendant la même connexion pour que les messages marquées
    pour effacement soient réellement purgés.
   </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
-->