imap_fetch_overview
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_fetch_overview — Read an overview of the information in the headers of the given message
說明
$imap, string $sequence, int $flags = 0): array|false
This function fetches mail headers for the given
sequence and returns an overview of their
contents.
參數
-
imap -
IMAP\Connection 實例。
-
sequence -
A message sequence description. You can enumerate desired messages with the
X,Ysyntax, or retrieve all messages within an interval with theX:Ysyntax -
flags -
sequencewill contain a sequence of message indices or UIDs, if this parameter is set toFT_UID.
返回值
Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are:
-
subject- the messages subject -
from- who sent it -
to- recipient -
date- when was it sent -
message_id- Message-ID -
references- is a reference to this message id -
in_reply_to- is a reply to this message id -
size- size in bytes -
uid- UID the message has in the mailbox -
msgno- message sequence number in the mailbox -
recent- this message is flagged as recent -
flagged- this message is flagged -
answered- this message is flagged as answered -
deleted- this message is flagged for deletion -
seen- this message is flagged as already read -
draft- this message is flagged as being a draft -
udate- the UNIX timestamp of the arrival date
false on failure.
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 |
現在 imap 參數接受 IMAP\Connection
實例，之前接受 資源(resource)。
|
範例
示例 #1 imap_fetch_overview() example
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
or die("can't connect: " . imap_last_error());
$MC = imap_check($mbox);
// Fetch an overview for all messages in 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);
?>