(PHP 4, PHP 5, PHP 7, PHP 8)
imap_fetch_overview — Считывает обзор информации из заголовков сообщений
Функция извлекает заголовки писем по последовательности, которую передали
в аргументе sequence, и возвращает обзорную информацию
содержания заголовков.
imapЭкземпляр класса IMAP\Connection.
sequence
Описание последовательности сообщений. Сообщения перечисляют
синтаксисом X,Y или получают все сообщения
в пределах интервала синтаксисом X:Y.
flags
Параметр sequence будет содержать
последовательность индексов сообщений или UID-идентификаторов,
если для этого параметра установили значение FT_UID.
Функция возвращает массив объектов, каждый из которых описывает заголовок одного сообщения. Объект определит свойство, только если свойство содержится в объекте. Следующий список перечисляет возможные свойства объекта:
subject — тема
from — отправитель
to — получатель
date — дата отправки
message_id — идентификатор сообщения
references — ссылки на идентификатор сообщения
in_reply_to — содержимое заголовка 'In-Reply-To' ответа на идентификатор сообщения
size — размер в байтах
uid — UID-идентификатор сообщения в ящике
msgno — порядковый номер сообщения в ящике
recent — отметка о том, что письмо новое
flagged — отметка о важности
answered — отметка о том, что на письмо ответили
deleted — пометка об удалении
seen — отметка о том, что письмо прочитали
draft — пометка «черновик»
udate — метка Unix-времени даты получения
false, если возникла ошибка.
| Версия | Описание |
|---|---|
| 8.1.0 |
Параметр imap теперь ожидает экземпляр класса IMAP\Connection;
раньше параметр ждал ресурс (resource) imap.
|
Пример #1 Пример считывания обзорной информации из заголовков сообщений функцией imap_fetch_overview()
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
or die("Не получилось подключиться: " . imap_last_error())
;
$MC = imap_check($mbox);
// Получаем обзор каждого письма в папке INBOX
$result = imap_fetch_overview($mbox, "1:{$MC->Nmsgs}", 0);
foreach ($result as $overview) {
echo "#{$overview->msgno} ({$overview->date}) — От: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>