(PHP 4, PHP 5)
imap_fetch_overview — Read an overview of the information in the headers of the given message
$imap_stream
, string $sequence
[, int $options = 0
] )
This function fetches mail headers for the given
sequence and returns an overview of their
contents.
imap_streamAn IMAP stream returned by imap_open().
sequenceA message sequence description. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax
options
sequence will contain a sequence of message
indices or UIDs, if this parameter is set to
FT_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:
Example #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);
?>