imap-search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: nobody Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<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>
   Liefert ein Array von Nachrichten, die den gegebenen Suchkriterien entsprechen
  </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>
   Diese Funktion durchsucht die Nachrichten des aktuellen Postfachs auf dem
   angegebenen <acronym>IMAP</acronym>-Stream.
  </para>
  <para>
   Der Suchstring, um &zb; nach allen unbeantworteten Nachrichten von Mutter
   zu suchen, wäre "UNANSWERED FROM Mutter". Die Suche unterscheidet nicht
   nach Groß- und Kleinschreibung. Die folgende Liste von Suchkriterien wurde
   aus dem Sourcecode des UW-c-client erstellt und ist daher nicht unbedingt
   vollständig oder in allen Einzelheiten korrekt (siehe auch
   <link xlink:href="&url.rfc;1176">RFC1176</link>, Abschnitt "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>
       Ein String, in dem die folgenden durch Leerzeichen getrennten
       Schlüsselwörter erlaubt sind. Argumente, die selbt Leerzeichen
       enthalten, müssen in doppelte Anführungszeichen gefasst werden (&zb;
       <literal>FROM "Hans Müller"</literal>). Die Ergebnisse müssen mit allen
       Einträgen in <parameter>criteria</parameter> übereinstimmen.
       <itemizedlist>
        <listitem>
         <simpara>
          ALL - gebe alle Nachrichten zurück, die den übrigen Kriterien
          entsprechen
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ANSWERED - sucht Nachrichten mit dem Flag \\ANSWERED
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BCC "text" - sucht Nachrichten mit "text" im Bcc:-Feld
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BEFORE "datum" - sucht Nachrichten, die vor "datum" gesendet wurden
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          BODY "text" - sucht Nachrichten mit "text" im Nachrichtenkörper
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          CC "text" - sucht Nachrichten mit "text" im Cc:-Feld
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          DELETED - sucht Nachrichten, die zur Löschung vorgemerkt sind
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          FLAGGED - sucht Nachrichten mit dem Flag \\FLAGGED (manchmal auch
          als wichtig oder dringend bezeichnet)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          FROM "text" - sucht Nachrichten mit "text" im From:-Feld
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          KEYWORD "text" - sucht Nachrichten mit dem Schlüsselwort "text"
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          NEW - sucht neue Nachrichten
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OLD - sucht alte Nachrichten
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ON "datum" - sucht Nachrichten, die am angegebenen "datum" gesendet
          wurden
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          RECENT - sucht Nachrichten mit dem Flag \\RECENT
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SEEN - sucht bereits gelesene Nachrichten (das Flag \\SEEN ist
          gesetzt)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SINCE "datum" - sucht nach "datum" gesendete Nachrichten
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          SUBJECT "text" - sucht Nachrichten mit "text" in der Betreffzeile
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          TEXT "text" - sucht Nachrichten, deren Text "text" enthält
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          TO "text" - sucht Nachrichten mit "text" im To:-Feld
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNANSWERED - sucht noch nicht beantwortete Nachrichten
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNDELETED - sucht Nachrichten, die nicht zum Löschen vorgemerkt sind
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNFLAGGED - sucht Nachrichten, die nicht als wichtig markiert sind
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNKEYWORD "text" - sucht Nachrichten, in deren Schlüsselwörtern
          "text" nicht enthalten ist
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          UNSEEN - sucht ungelesene Nachrichten
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Der einzige gültige Werte für <parameter>flags</parameter> ist
       <constant>SE_UID</constant>, was bewirkt, dass das zurückgegebene Array
       UIDs anstelle von Nachrichtennummern enthält.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Der bei der Stringsuche zu verwendende MIME-Zeichensatz.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein Array mit Nachrichtennummern oder UIDs zurück.
  </para>
  <para>
   Wenn die Suchkriterien <parameter>criteria</parameter> nicht verstanden
   wurden oder keine Nachrichten gefunden wurden, wird &false; zurückgegeben.
  </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><function>imap_search</function>-Beispiel</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
-->