Files
doc-fr/reference/imap/functions/imap-mail-move.xml
T
George Peter Banyard 7ae1350205 Sync IMAP docs with EN
2022-02-05 18:31:43 +00:00

137 lines
4.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 91a4618df8c82d4e84bbb8a9ed430b840cd7da65 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-mail-move" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_mail_move</refname>
<refpurpose>Déplace des messages dans une boîte aux lettres</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_mail_move</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>message_nums</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>imap_mail_move</function> déplace les messages spécifiés
par <parameter>message_nums</parameter> dans la boîte aux lettres
<parameter>mailbox</parameter>.
À noter que les messages sont en réalité <emphasis>copiées</emphasis> à la
boîte au lettres <parameter>mailbox</parameter>, et les messages originaux
sont marquées pour être supprimés. Ceci implique que les messages dans
<parameter>mailbox</parameter> sont assignées des nouveaux UIDs.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>message_nums</parameter></term>
<listitem>
<para>
<parameter>message_nums</parameter> est un intervalle, et pas seulement une
liste de messages (comme décrit dans la <link
xlink:href="&url.rfc;2060">RFC2060</link>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mailbox</parameter></term>
<listitem>
<para>
Le nom de la boîte aux lettres, voir la documentation de la fonction
<function>imap_open</function> pour plus de détails
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<parameter>flags</parameter> est un champ de bits et peut contenir une
seule valeur :
<itemizedlist>
<listitem>
<simpara>
<constant>CP_UID</constant> - La séquence de nombres contient des UID
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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="notes">
&reftitle.notes;
<note>
<para>
<function>imap_mail_move</function> va marquer l'email original avec un
marqueur de suppression, pour effectivement le supprimer, un appel à
<function>imap_expunge</function> est nécessaire.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_mail_copy</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
-->