imap_scanmailbox
imap_search() only supports IMAP2 search criterias, because the function mail_criteria() (from c-client lib) is used in ext/imap/php_imap.c for parsing the search string.
IMAP2 search criteria is defined in RFC 1176, section "tag SEARCH search_criteria".
imap_search
(PHP 4, PHP 5)
imap_search — Liefert ein Array von Nachrichten die den gegebenen Suchkriterien entsprechen
Beschreibung
array imap_search
( resource
$imap_stream
, string $criteria
[, int $options = SE_FREE
[, string $charset = NIL
]] )imap_search() durchsucht die Nachrichten des aktuellen Postfachs.
Der Suchstring um zB nach allen unbeantworteten Nachrichten von Mutter zu suchen wäre "UNANSWERED FROM Mutter". Die Suche untercheidet nicht nach Groß- und Kleinschreibung. Die folgende Liste von Suchkriterien wurde aus dem Sourcecode des UW c-client erstellt, sie ist daher nicht unbedingt vollständig oder in allen Einzelheiten korrekt (siehe auch » RFC2060, Abschnitt 6.4.4).
Parameter-Liste
-
imap_stream -
Eine von imap_open() zurückgegebene IMAP-Verbindung.
-
criteria -
Ein aus mit Leerzeichen getrennten Schlüsselworten und Argumenten. Argumente die selbt Leerzeichen enthalten müssen in doppelte Anführungszeichen gefasst werden (z.B. FROM "Hans Müller"). Es existieren folgende Schlüsselworte:
- ALL - return all messages matching the rest of the criteria
- ANSWERED - die gesuchten Nachrichten wurden beantwortet
- BCC "text" - die gesuchten Nachrichten enthalten "text" im Bcc: Feld
- BEFORE "datum" - die gesuchten Nachrichten wurden vor "datum" gesendet
- BODY "text" - der Nachrichtenkörper enthält "text"
- CC "text" - die gesuchten Nachrichten enthalten "text" im Cc: Feld
- DELETED - die gesuchten Nachrichten sind zur Löschung vorgemerkt
- FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set
- FROM "text" - sucht Nachrichten mit "text" im Absender (From:)
- KEYWORD "text" - sucht Nachrichten mit Schlüsselwort "text"
- NEW - die gesuchten Nachrichten sind neu
- OLD - die gesuchten Nachrichten sind nicht neu
- ON "datum" - die Nachrichten wurden am angegebenen "datum" gesendet
- RECENT - sucht Nachrichten deren \\RECENT Flag nocht gesetzt ist
- SEEN - sucht bereits gelesene Nachrichten (das \\SEEN Flag ist gesetzt)
- SINCE "datum" - sucht nach "datum" gesendete Nachrichten
- SUBJECT "text" - sucht Nachrichten mit "text" in der Betreffzeile
- TEXT "text" - sucht Nachrichten deren Text "text" enthält
- TO "text" - sucht Nachrichten mit "text" im Empfänger (To:)
- UNANSWERED - sucht noch nicht beantwortete Nachrichten
- UNDELETED - sucht nicht zum Löschen vorgemerkte Nachrichten
- UNFLAGGED - sucht Nachrichten die nicht als wichtig markiert sind
- UNKEYWORD "text" - sucht Nachrichten in deren Schlüsselwörtern "text" nicht enthalten ist
- UNSEEN - sucht ungelesene Nachrichten
-
options -
Der Parameter
optionskann aufSE_UIDgesetzt werden um UIDs statt Nachrichtennummern zurückzuerhalten. -
charset -
Rückgabewerte
Liefert ein Array mit Nachrichtennummern oder UIDs.
Wenn die Suchkriterien keinen Sinn ergaben oder
keine Nachrichten gefunden wurden wird FALSE
zurückgegeben.
Changelog
| Version | Beschreibung |
|---|---|
| 4.3.3 |
Der Parameter charset wurde hinzugefügt
|
add a note
User Contributed Notesimap_search
oliver at samera dot com dot py
26-Oct-2002 05:16
26-Oct-2002 05:16
oliver at samera dot com dot py
27-Jan-2002 06:03
27-Jan-2002 06:03
imap_search() return false if it does not understand the search condition or no messages have been found.
$emails imap_seach($mbox, "UNDELETED SENTSINCE 01-Jan-2002");
if($emails === false)
echo "The search failed";