mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 09:22:07 +01:00
151 lines
4.3 KiB
XML
151 lines
4.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: d845236a60b26f8ec552298676ce185cfbb794b6 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>
|
|
Retourne &true;.
|
|
</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="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
|
|
-->
|