imap_fetch_overview(3) [php 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)

Check Out this Related Man Page

IMAP_GET_QUOTAROOT(3)							 1						     IMAP_GET_QUOTAROOT(3)

imap_get_quotaroot - Retrieve the quota settings per user

SYNOPSIS

       array imap_get_quotaroot (resource  $imap_stream, string  $quota_root)

DESCRIPTION

	Retrieve  the  quota  settings per user. The limit value represents the total amount of space allowed for this user's total mailbox usage.
       The usage value represents the user's current total mailbox capacity.

PARAMETERS

	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $quota_root
		-$quota_root should normally be in the form of which mailbox (i.e. INBOX).

RETURN VALUES

	Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and  a
       corresponding array with the usage and limit values within.

	This function will return FALSE in the case of call failure, and an array of information about the connection upon an un-parsable response
       from the server.

EXAMPLES

       Example #1

	      imap_get_quotaroot(3) example

	      <?php
	      $mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
		    or die("can't connect: " . imap_last_error());

	      $quota = imap_get_quotaroot($mbox, "INBOX");
	      if (is_array($quota)) {
		 $storage = $quota['STORAGE'];
		 echo "STORAGE usage level is: " .  $storage['usage'];
		 echo "STORAGE limit level is: " .  $storage['limit'];

		 $message = $quota['MESSAGE'];
		 echo "MESSAGE usage level is: " .  $message['usage'];
		 echo "MESSAGE limit level is: " .  $message['limit'];

		 /* ...  */

	      }

	      imap_close($mbox);
	      ?>

NOTES

	This function is currently only available to users of the c-client2000 or greater library.

	The $imap_stream should be opened as the user whose mailbox you wish to check.

SEE ALSO

       imap_open(3), imap_set_quota(3), imap_get_quota(3).

PHP Documentation Group 												     IMAP_GET_QUOTAROOT(3)

Linux and UNIX Man Pages

imap_fetch_overview(3) [php man page]

Check Out this Related Man Page