imap_search

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_search — Отримує повідомлення, які відповідають заданим критеріям

Опис

imap_search(    IMAP\Connection $imap,    string $criteria,    int $flags = SE_FREE,    string $charset = ""): array|false

Ця функція здійснює пошук у поточній поштовій скриньці, відкритій у потоці IMAP.

Наприклад, щоб знайти всі невідповідні повідомлення надіслані від мами (Mom), потрібно буде використовувати "UNANSWERED FROM mom". Пошук реєстронезалежний. Наведений список критеріїв вилучено із вихідних кодів UW c-client і може бути неповним або не зовсім точним (додатково дивіться » RFC1176, секція "tag SEARCH search_criteria").

Список параметрів

imap

Екземпляр IMAP\Connection

criteria

Рядок, розділений пробілами, в якому можна використовувати наступні ключові слова. Будь-які аргументи, що складаються з кількох слів, повинні бути поміщені в подвійні лапки (наприклад FROM "joey smith"). Результат співпадатиме з усіма заданими в параметрі criteriaкритериями.

ALL - повертати всі повідомлення, що відповідають іншим критеріям
ANSWERED - повідомлення з виставленим прапором\\ANSWERED
BCC "string" - повідомлення в полі Bcc: яких є "string"
BEFORE "date" - повідомлення з Date: до "date"
BODY "string" - повідомлення, що містять "string" в тілі
CC "string" - повідомлення у полі Cc: яких є "string"
DELETED - видалені повідомлення
FLAGGED - повідомлення із встановленим прапором\\FLAGGED (іноді називають "Термінове" або "Важливе")
FROM "string" - повідомлення в полі From: яких є "string"
KEYWORD "string" - повідомлення із ключовим словом "string"
NEW - нові повідомлення
OLD - старі повідомлення
ON "date" - повідомлення з Date: рівним "date"
RECENT означає повідомлення з виставленим прапором\\RECENT
SEEN - прочитані повідомлення (встановлений прапор\\SEEN)
SINCE "date" - повідомлення з Date: після "date"
SUBJECT "string" - повідомлення в полі Subject: яких є "string"
TEXT "string" - повідомлення з текстом "string"
TO "string" - повідомлення в полі To: яких є присутнім "string"
UNANSWERED - невідповідні повідомлення
UNDELETED - не видалені повідомлення
UNFLAGGED - повідомлення без встановлених прапорів
UNKEYWORD "string" - повідомлення, що не мають ключового слова "string"
UNSEEN - непрочитані повідомлення

flags

Коректні значення flags - це SE_UID, що призведе до того, що у поверненому масиві замість номерів повідомлень будуть міститися їх UID.

charset

Кодування MIME, у якому відбуватиметься пошук.

Значення, що повертаються

Повертає номери повідомлень або їх UID.

Повертає false, якщо повідомлення не знайдені, або критерії зазначені в criteria некоректні.

список змін

Версия	Опис
8.1.0	Параметр`imap` тепер чекає екземпляр IMAP\Connection; раніше очікувався ресурс (resource`imap`

Приклади

Приклад #1 Приклад використання imap_search()****

Loading...

Висновок наведеного прикладу буде схожим на:

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
)

Дивіться також

imap_listscan() - Отримує список поштових скриньок, імена яких містять заданий рядок