Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

imap_mailboxmsginfo(3) [php man page]

IMAP_MAILBOXMSGINFO(3)							 1						    IMAP_MAILBOXMSGINFO(3)

imap_mailboxmsginfo - Get information about the current mailbox

SYNOPSIS
object imap_mailboxmsginfo (resource $imap_stream) DESCRIPTION
Checks the current mailbox status on the server. It is similar to imap_status(3), but will additionally sum up the size of all messages in the mailbox, which will take some additional time to execute. PARAMETERS
o $ imap_stream -An IMAP stream returned by imap_open(3). RETURN VALUES
Returns the information in an object with following properties: Mailbox properties +--------+----------------------------------------+ | Date | | | | | | | date of last change (current datetime) | | | | |Driver | | | | | | | driver | | | | |Mailbox | | | | | | | name of the mailbox | | | | | Nmsgs | | | | | | | number of messages | | | | |Recent | | | | | | | number of recent messages | | | | |Unread | | | | | | | number of unread messages | | | | |Deleted | | | | | | | number of deleted messages | | | | | Size | | | | | | | mailbox size | | | | +--------+----------------------------------------+ Returns FALSE on failure. EXAMPLES
Example #1 imap_mailboxmsginfo(3) example <?php $mbox = imap_open("{imap.example.org}INBOX", "username", "password") or die("can't connect: " . imap_last_error()); $check = imap_mailboxmsginfo($mbox); if ($check) { echo "Date: " . $check->Date . "<br /> " ; echo "Driver: " . $check->Driver . "<br /> " ; echo "Mailbox: " . $check->Mailbox . "<br /> " ; echo "Messages: " . $check->Nmsgs . "<br /> " ; echo "Recent: " . $check->Recent . "<br /> " ; echo "Unread: " . $check->Unread . "<br /> " ; echo "Deleted: " . $check->Deleted . "<br /> " ; echo "Size: " . $check->Size . "<br /> " ; } else { echo "imap_mailboxmsginfo() failed: " . imap_last_error() . "<br /> "; } imap_close($mbox); ?> PHP Documentation Group IMAP_MAILBOXMSGINFO(3)

Check Out this Related Man Page

IMAP_FETCH_OVERVIEW(3)							 1						    IMAP_FETCH_OVERVIEW(3)

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

SYNOPSIS
array imap_fetch_overview (resource $imap_stream, string $sequence, [int $options]) DESCRIPTION
This function fetches mail headers for the given $sequence and returns an overview of their contents. PARAMETERS
o $ imap_stream -An IMAP stream returned by imap_open(3). o $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 o $options -$sequence will contain a sequence of message indices or UIDs, if this parameter is set to FT_UID. RETURN VALUES
Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible proper- ties are: o subject - the messages subject o from - who sent it o to - recipient o date - when was it sent o message_id - Message-ID o references - is a reference to this message id o in_reply_to - is a reply to this message id o size - size in bytes o uid - UID the message has in the mailbox o msgno - message sequence number in the mailbox o recent - this message is flagged as recent o flagged - this message is flagged o answered - this message is flagged as answered o deleted - this message is flagged for deletion o seen - this message is flagged as already read o draft - this message is flagged as being a draft EXAMPLES
Example #1 imap_fetch_overview(3) 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} "; } imap_close($mbox); ?> SEE ALSO
imap_fetchheader(3). PHP Documentation Group IMAP_FETCH_OVERVIEW(3)
Man Page