(PHP 4, PHP 5, PHP 7, PHP 8)
imap_search — Retourne un tableau de messages après recherche
$imap,$criteria,$flags = SE_FREE,$charset = ""Effectue une recherche dans la boîte aux lettres courante, sur le flux IMAP courant.
Par exemple, pour rechercher les messages non répondus, envoyés par maman, il est possible d'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 » RFC1176, et en particulier, la section "tag SEARCH search_criteria").
imapUne instance de IMAP\Connection.
criteria
Une chaîne de caractères, délimitée par des espaces, dans laquelle les mots-clés
suivants sont acceptés. Tous les arguments à plusieurs mots (e.g.
FROM "joey smith") doivent être placés entre guillemets.
Les résultats devront correspondre à toutes les entrées
criteria.
ALL - retourne tous les messages qui vérifient le reste du critère.
ANSWERED - tous les messages avec le flag \\ANSWERED
BCC "string" - tous les messages avec la chaîne "string" dans le champ Bcc
BEFORE "date" - tous les messages avec Date : avant "date"
BODY "string" - tous les messages avec "string" dans le corps
CC "string" - tous les messages avec "string" dans le champ Cc
DELETED - tous les messages effacés
FLAGGED - tous les messages avec le flag \\FLAGGED (parfois interprété comme Important ou Urgent)
FROM "string" - tous les messages avec la chaîne "string" dans le champ From
KEYWORD "string" - tous les messages avec la chaîne "string" comme mot-clé
NEW - tous les nouveaux messages
OLD - tous les anciens messages
ON "date" - tous les messages avec la date "date" comme champ Date
RECENT - tous les messages avec le flag \\RECENT
SEEN - tous les messages lus (avec le flag \\SEEN)
SINCE "date" - tous les messages avec la date Date: après "date"
SUBJECT "string" - tous les messages avec la chaîne "string" dans le champ Subject
TEXT "string" - tous les messages avec le texte "string"
TO "string" - tous les messages avec la chaîne "string" dans le champ To
UNANSWERED - tous les messages non répondus
UNDELETED - tous les messages non effacés
UNFLAGGED - tous les messages non marqués
UNKEYWORD "string" - tous les messages ne contenant pas le mot-clé "string"
UNSEEN - tous les messages non lus
flags
Les valeurs pour flags sont SE_UID, qui fait que le tableau réponse
contient les UID plutôt que les numéros de séquence.
charsetJeu de caractères MIME à utiliser lors de la recherche de chaîne de caractères.
Retourne un tableau de numéro de messages ou d'UID.
Retourne false si la recherche n'est pas comprise, ou bien qu'aucun
message n'a été trouvé.
| Version | Description |
|---|---|
| 8.1.0 |
La paramètre imap attend désormais une instance de
IMAP\Connection ; auparavant, une resource imap était attendue.
|
Exemple #1 Exemple avec imap_search()
<?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);
?>Résultat de l'exemple ci-dessus est similaire à :
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
)