(PHP 4, PHP 5)

imap_fetch_overviewRead an overview of the information in the headers of the given message


array imap_fetch_overview ( resource $imap_stream , string $sequence [, int $options = 0 ] )

This function fetches mail headers for the given sequence and returns an overview of their contents.

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


Поток IMAP, полученный из imap_open().


A 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


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:

  • 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


Пример #1 imap_fetch_overview() example

     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) {
"#{$overview->msgno} ({$overview->date}) - From: {$overview->from}

Смотрите также


I think if you go like a list, you can list your "hotmail" messages.
"#$msg: From:'$from' Date:'$date' Subject:'$subj'<BR>";
2001-11-09 22:26:30
This performance hint is useful if you need to print the result of imap_sort():

It's faster to prepare large string with UIDs and then to call imap_fetchoverview once than calling imap_fetchoverview in a loop.
2002-02-25 12:13:28
Note that these object-variables only exist when they are actually in the mail.

This means that if a mail has no subject, the property $val->subject will not exist.

Calling $val->subject will generate an notice:
Notice: Undefined property: subject in /home/html/inc/Mbox.php on line xxx

Use this to check it:
if (array_key_exists( "subject", get_object_vars($val)))
2002-10-14 07:34:24
To further explain 'warrenfalk's comment, the following sequences are exactly the same, and always returns messages with lowest UID to highest UID:


(always returned as 1,2,3,4,5)
2003-07-02 09:42:42
Not that this function and all other imap_fetch*-functions will download the whole message and not just the header information.
2003-12-14 18:15:05
About the sequence sorting again.
I've found that there's a significant speed improvement by preparing the sequence and then fetch them at once with large mailboxes. On small mailboxes wyou will not notice a speed difference.

But then there's the sorting problem. I've spent all night fiuring out how to do this myself. I found the solution!

Prepare an array of messages with imap_sort. Create a second array that maps the message numbers to the actuall place in the fetched array.
You know it will be in numeric order so you can make an array map with the sort() function sorting it from high to low.
Then you can proces the array fetched with imap_fetch_overview with the array_map and you will have them sorted. If you need an example look in the Group-Office code classes/ in a version later then 2.04.
2004-04-09 20:21:19
Here is a function to get messages from IMAP and sort them for pagination.

     * Return array of IMAP messages for pagination
     * @param   int     $page       page number to get
     * @param   int     $per_page   number of results per page
     * @param   array   $sort       array('subject', 'asc') etc
     * @return  mixed   array containing imap_fetch_overview, pages, and total rows if successful, false if an error occurred
     * @author  Raja K
public function listMessages($page 1$per_page 25$sort null) {
$limit = ($per_page $page);
$start = ($limit $per_page) + 1;
$start = ($start 1) ? $start;
$limit = (($limit $start) != ($per_page-1)) ? ($start + ($per_page-1)) : $limit;
$info imap_check($this->_imap_stream);
$limit = ($info->Nmsgs $limit) ? $info->Nmsgs $limit;
true === is_array($sort)) {
$sorting = array(
'direction' => array(   'asc' => 0
'desc' => 1),
'by'        => array(   'date' => SORTDATE,
'arrival' => SORTARRIVAL,
'from' => SORTFROM,
'subject' => SORTSUBJECT,
'size' => SORTSIZE));
$by = (true === is_int($by $sorting['by'][$sort[0]])) 
$direction = (true === is_int($direction $sorting['direction'][$sort[1]])) 
$sorted imap_sort($this->_imap_stream$by$direction);
$msgs array_chunk($sorted$per_page);
$msgs $msgs[$page-1];
$msgs range($start$limit); //just to keep it consistent
$result imap_fetch_overview($this->_imap_streamimplode($msgs','), 0);
false === is_array($result)) return false;
if(true === is_array($sorted)) {
$tmp_result = array();
$result as $r)
$tmp_result[$r->msgno] = $r;
$result = array();
$msgs as $msgno) {
$result[] = $tmp_result[$msgno];
$return = array('res' => $result,
'start' => $start,
'limit' => $limit,
'sorting' => array('by' => $sort[0], 'direction' => $sort[1]),
'total' => imap_num_msg($this->_imap_stream));
$return['pages'] = ceil($return['total'] / $per_page);
2007-03-14 13:22:57
you want a sortet list of mails, but you get always the same order? your c-client seems to cause this. i realized this with linux libc6-2.3.6 and php-5.2.0

try this little code:

# here you try to sort by your criteria
# here the order of the messages to fetch should be recognised, but it isn't

# so try to work around simply:
{ $liste[$i]=$tmp[array_search($tmp[$i]->uid,$sort)]; }

so now you can use the sort by date, address, and so on.
2007-03-20 09:05:04
That's right: 

calling imap_fetch_overview() once is faster, than calling it
in a loop.

But if you want to get a "day sorted" list, you need to call it in a loop, cause if you enter a "string" of UIDs, they are always sorted by UID, not by the order you entered it.

Heres a little example how to get a date-sorted list:

/*Sort all msgs by Arrival Date. Newest = 0, oldest = Array Count*/
/*returns an array, containing the UIDs of messages*/
$SortedArray imap_sort($Handle,SORTARRIVAL,1,SE_UID);

For (
$i $Start$i$Start $Limit$i++){
/*Read UID from Sorted Array*/
$UID $SortedArray[$i];
/*Get Detailed MSG Infos*/
$Overview imap_fetch_overview($Handle$UIDFT_UID);

2009-01-16 11:15:19
This seems to retrieve incomplete values for headers, instead of getting the entire value, it gets the first. for example, this is a valid To: header


but imap_fetch_overview will only return:
2009-06-20 12:43:38
Hopefully someone will find this a jumpstarter for a sortable, paginated list:

public function listMessages($nStart=0$nCnt=10) {
    if (!
$this->loaded) {
    if ((
$nStart+$nCnt) > $this->getNum()) {
$nCnt $this->getNum()-$nStart;
$aMsgs imap_fetch_overview($this->rCon, ($nStart+1).':'.($nStart+$nCnt));
$aRet = array();
    if (
$aMsgs) {
        foreach (
$aMsgs as $msg) {
$aRet[$msg->udate] = $msg;
2011-04-06 20:31:59
If you lost a mail use this
public function READallUnreadmail(){
        if (
$headers imap_check($this->msgbox)){
$lastnr $headers->Nmsgs;
            if (
                while (list(
$key$val) = each($mails)) {
                   if (++
"<br>".$val->msgno." - ".$val->date." - ".$val->subject."\n<br>";
2012-10-23 10:25:31
I've found that for some messages, this function and also function imap_headerinfo(), can't decode the message_id information and returns an ID like "<xxxxxxxxx@unknownmsgid>" 

In these cases, I use the following to get the correct messageid:


Con algunos mensajes, esta funcion, al igual que la funcion imap_headerinfo(), no pueden decodificar correctamente la información del ID de mensaje y devuelven un ID como este "<xxxxxxxxx@unknownmsgid>" 

En esos casos, uso lo siguiente para obtener el ID de mensaje correcto:

2013-12-18 18:52:09
The Remote class here ( has a lot of examples of processing mailbox folders with imap-fetch-overview:

         $recent_messages = @imap_search($this->stream, 'SINCE "'.date("j F Y",$tstamp).'"',SE_UID); // 30 November 2013
         if ($recent_messages===false) continue; // to do - continue into next account
         $result = imap_fetch_overview($this->stream, implode(',',array_slice($recent_messages,0,$message_limit)),FT_UID);
         foreach ($result as $item) {         
           $msg = $this->parseHeader($item);
2014-01-13 05:25:20
Judging from the comments here, it appears like people are forgetting the basics to already-available PHP sorting functions. Use usort(); and the tiniest custom function ever to compare them all.

Change the arguments to imap_fetch_overview to your own, obviously.


usort($result, function($a$b) {

This usort function will look at each overview and order them in the exact latest to oldest message order as determined by the "udate" value for each message. This works. I'm using it. They're sorted in the exact order they appear in my actual inbox. Why obfuscate it any more?
2015-02-20 03:18:46
The use of the $range parameter is explained in the example at:


// fetch message information for message 2
// and messages 4 to 6
$info imap_fetch_overview($imap"2,4:6");


<table border=1>

// loop through the array
foreach ($info as $msg) {

// display the seen property nicely
if ($msg->seen == 1) {
$read "Yes";
   } else {
$read "No";

// print other message information

2015-10-06 14:31:44
There is a typo in the manual. The correct return value for arrival time is:  udate not update.
2017-01-25 12:12:54
While using fetch overview it displays only single mail. i need to display mail with replied and forward and all. how its possible?
2017-02-15 14:30:50

    Поддержать сайт на родительском проекте КГБ