imap-search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_search</refname>
  <refpurpose>Retourne un tableau de messages après recherche</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_search</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>criteria</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SE_FREE</constant></initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Effectue une recherche dans la boîte aux lettres courante, sur le flux
   <acronym>IMAP</acronym> courant.
  </para>
  <para>
   Par exemple, pour rechercher les messages non répondus, envoyés
   par maman, vous pouvez utiliser : "UNANSWERED FROM maman". Les recherches
   semblent insensibles à la casse. Cette liste de critères est
   issue du code d'un client C UW et peut être incomplète ou
   imprécise. (voir aussi la <link xlink:href="&url.rfc;1176">RFC1176</link>, et
   en particulier, la section "tag SEARCH search_criteria").
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>criteria</parameter></term>
     <listitem>
      <para>
       Une &string;, délimitée par des espaces, dans laquelle les mots-clés
       suivants sont acceptés. Tous les arguments à plusieurs mots (e.g. 
       <literal>FROM "joey smith"</literal>) doivent être placés entre guillemets.
       Les résultats devront correspondre à toutes les entrées
       <parameter>criteria</parameter>.
       <itemizedlist>
        <listitem>
         <simpara>
          ALL - retourne tous les messages qui vérifient le reste du critère.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ANSWERED - tous les messages avec le flag \\ANSWERED
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BCC "string" - tous les messages avec la chaîne "string" dans le
          champ Bcc
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BEFORE "date" - tous les messages avec Date : avant "date"
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BODY "string" - tous les messages avec "string" dans le corps
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          CC "string" - tous les messages avec "string" dans le champ Cc
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          DELETED - tous les messages effacés
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          FLAGGED - tous les messages avec le flag \\FLAGGED (parfois
          interprété comme Important ou Urgent)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          FROM "string" - tous les messages avec la chaîne "string" dans le
          champ From
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          KEYWORD "string" - tous les messages avec la chaîne "string" comme mot-clé
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          NEW - tous les nouveaux messages
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OLD - tous les anciens messages
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ON "date" - tous les messages avec la date "date" comme champ Date
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          RECENT - tous les messages avec le flag \\RECENT
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SEEN - tous les messages lus (avec le flag\\SEEN flag)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SINCE "date" - tous les messages avec la date Date: après "date"
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SUBJECT "string" - tous les messages avec la chaîne "string"
          dans le champ Subject
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          TEXT "string" - tous les messages avec le texte "string"
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          TO "string" - tous les messages avec la chaîne "string" dans le
          champ To
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNANSWERED - tous les messages non répondus
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNDELETED - tous les messages non effacés
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNFLAGGED - tous les messages non marqués
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNKEYWORD "string" - tous les messages ne contenant pas le mot-clé "string"
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNSEEN - tous les messages non lus
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Les valeurs pour <parameter>flags</parameter> sont <constant>SE_UID</constant>, qui fait que le tableau réponse
       contient les UID plutôt que les numéros de séquence.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Jeu de caractères MIME à utiliser lors de la recherche de &string;. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau de numéro de messages ou d'UID.
  </para>
  <para>
   Retourne &false; si la recherche n'est pas comprise, ou bien qu'aucun
   message n'a été trouvé.
  </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;
  <example xml:id="imap-search.examples">
   <title>Exemple avec <function>imap_search</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$imap   = imap_open('{imap.example.com:993/imap/ssl}INBOX', 'foo@example.com', 'pass123', OP_READONLY);

$some   = imap_search($imap, 'SUBJECT "HOWTO be Awesome" SINCE "8 August 2008"', SE_UID);
$msgnos = imap_search($imap, 'ALL');
$uids   = imap_search($imap, 'ALL', SE_UID);

print_r($some);
print_r($msgnos);
print_r($uids);
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Array
(
    [0] => 4
    [1] => 6
    [2] => 11
)
Array
(
    [0] => 1
    [1] => 2
    [2] => 3
    [3] => 4
    [4] => 5
    [5] => 6
)
Array
(
    [0] => 1
    [1] => 4
    [2] => 6
    [3] => 8
    [4] => 11
    [5] => 12
)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_listscan</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
-->