PHP: imap_fetch_overview - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

imap_fetchbody imap_expunge

Last updated: Sat, 27 Jan 2007

view this page in

# imap_fetch_overview

(PHP 3 >= 3.0.4, PHP 4, PHP 5)

imap_fetch_overview -- Read an overview of the information in the headers of the given message

## Описание

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

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

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

`imap_stream`

  An IMAP stream returned by imap_open().

`sequence`

  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

`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:

- 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

`<?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 => $overview) {
echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>`

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

imap_fetchheader()

add a note User Contributed Notes
imap_fetch_overview
Group-Office Developer
09-Apr-2004 05:21
`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/imap.class.inc in a version later then 2.04.`
mails at slueoend dot ch
14-Dec-2003 04:15
`Not that this function and all other imap_fetch*-functions will download the whole message and not just the header information.`
se at designlinks dot net
02-Jul-2003 06:42
`To further explain 'warrenfalk's comment, the following sequences are exactly the same, and always returns messages with lowest UID to highest UID:
1:5
5:1
1,2,3,4,5
5,4,3,2,1
3,2,5,1,4
(always returned as 1,2,3,4,5)`
suurenbroekNoSpam at ov35 dot NoSpam dot nl
14-Oct-2002 04:34
`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)))
$subj=$val->subject;
else
$subj="";`
trionon at mail dot ru
25-Feb-2002 10:13
`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.`
steve at stevenchalker dot net
09-Nov-2001 08:26
`I think if you go like a list, you can list your "hotmail" messages.
<?php
$mbox=imap_open("{imap.server.com}","user","pass");
$MC=imap_check($mbox);
$MN=$MC->Nmsgs;
$overview=imap_fetch_overview($mbox,"1:$MN",0);
$size=sizeof($overview);
for($i=$size-1;$i>=0;$i--){
$val=$overview[$i];
$msg=$val->msgno;
$from=$val->from;
$date=$val->date;
$subj=$val->subject;
echo "#$msg: From:'$from' Date:'$date' Subject:'$subj'<BR>";
imap_close($mbox);
?>`
add a note
imap_fetchbody imap_expunge

Last updated: Sat, 27 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 09:32:46 2007 PST