Files
doc-fr/reference/imap/functions/imap-append.xml
George Peter Banyard 15d22ea7e2 Apply commit 34892f82742329af7e7b4b22be6ad21418fd9768
[PHP 8.1] Use an IMAP\Connection instance instead of a resource
2021-09-28 19:52:16 +01:00

155 lines
4.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-append" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_append</refname>
<refpurpose>Ajoute un message dans une boîte aux lettres</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_append</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>folder</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>internal_date</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Ajoute un <parameter>message</parameter> au <parameter>folder</parameter> spécifié.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>folder</parameter></term>
<listitem>
<para>
Le nom de la boîte aux lettres, voir la documentation sur la fonction
<function>imap_open</function> pour plus d'informations
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
Le message à ajouter, sous la forme d'une &string;
</para>
<para>
Lors des échanges avec le serveur Cyrus IMAP, vous devrez utiliser
"\r\n" comme terminaison de ligne, à la place de "\n" ou
l'opération échouera.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Si fourni, le paramètre <parameter>options</parameter> sera également
écrit dans la boîte <parameter>folder</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>internal_date</parameter></term>
<listitem>
<para>
Si ce paramètre est défini, il mettra les INTERNALDATE sur le message joint.
Le paramètre doit être une chaîne de date qui est conforme
aux spécifications du rfc2060 pour une valeur date_time.
</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;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> et <parameter>internal_date</parameter> sont désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>imap_append</function></title>
<programlisting role="php">
<![CDATA[
<?php
$imap = imap_open("{imap.example.org}INBOX.Drafts", "username", "password");
$check = imap_check($imap);
echo "Msg Count before append: ". $check->Nmsgs . "\n";
imap_append($imap, "{imap.example.org}INBOX.Drafts"
, "From: me@example.com\r\n"
. "To: you@example.com\r\n"
. "Subject: test\r\n"
. "\r\n"
. "Ceci est un message de test. Ignorez le.\r\n"
);
$check = imap_check($imap);
echo "Nombre de messages après ajout : ". $check->Nmsgs . "\n";
imap_close($imap);
?>
]]>
</programlisting>
</example>
</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
-->