(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
- является ответом на письмо с этим идентификатором
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}) - From: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>