imap-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_status</refname>
  <refpurpose>Retourne les informations de statut sur une boîte aux lettres</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_status</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retourne les informations de statut sur la boîte aux lettres <parameter>mailbox</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <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>
       Les drapeaux valides sont :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>SA_MESSAGES</constant> - met la valeur de
          <varname>$status-&gt;messages</varname> au nombre de messages dans la boîte aux lettres.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SA_RECENT</constant> - met la valeur de <varname>$status-&gt;recent</varname>
          au nombre de messages récents dans la boîte aux lettres.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SA_UNSEEN</constant> - met la valeur de <varname>$status-&gt;unseen</varname>
          au nombre de messages non lus dans la boîte aux lettres.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SA_UIDNEXT</constant> - met la valeur de <varname>$status-&gt;uidnext</varname>
          à la prochaine valeur d'uid qui sera utilisée.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SA_UIDVALIDITY</constant> - met la valeur de 
          <varname>$status-&gt;uidvalidity</varname> à une constante, qui change lorsque l'uid de
          la boîte aux lettres n'est plus valide.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SA_ALL</constant> - fixe toutes les valeurs précédentes.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Cette fonction retourne un objet contenant les informations sur le
   statut, &return.falseforfailure;.
   L'objet a les propriétés suivantes : <literal>messages</literal>,
   <literal>recent</literal>, <literal>unseen</literal>,
   <literal>uidnext</literal>, et <literal>uidvalidity</literal>.
  </para>
  <para>
   <literal>flags</literal> est également défini, qui contient un masque
   contenant une des constantes ci-dessus.
  </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_status</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
      or die("Connexion impossible : " . imap_last_error());

$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
  echo "Messages :   " . $status->messages    . "<br />\n";
  echo "Récent :     " . $status->recent      . "<br />\n";
  echo "Non lu :     " . $status->unseen      . "<br />\n";
  echo "Prochain UID:    " . $status->uidnext     . "<br />\n";
  echo "Validité de l'UID:" . $status->uidvalidity . "<br />\n";
} else {
  echo "imap_status a échoué : " . imap_last_error() . "\n";
}

imap_close($mbox);
?>
]]>
    </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
-->