Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

imap_thread(3) [php man page]

IMAP_THREAD(3)								 1							    IMAP_THREAD(3)

imap_thread - Returns a tree of threaded message

SYNOPSIS
array imap_thread (resource $imap_stream, [int $options = SE_FREE]) DESCRIPTION
Gets a tree of a threaded message. PARAMETERS
o $ imap_stream -An IMAP stream returned by imap_open(3). o $options - RETURN VALUES
imap_thread(3) returns an associative array containing a tree of messages threaded by REFERENCES, or FALSE on error. Every message in the current mailbox will be represented by three entries in the resulting array: o$thread["XX.num"] - current message number o$thread["XX.next"] o$thread["XX.branch"] EXAMPLES
Example #1 imap_thread(3) Example <?php // Here we're outputting the threads of a newsgroup, in HTML $nntp = imap_open('{news.example.com:119/nntp}some.newsgroup', '', ''); $threads = imap_thread($nntp); foreach ($threads as $key => $val) { $tree = explode('.', $key); if ($tree[1] == 'num') { $header = imap_headerinfo($nntp, $val); echo "<ul> <li>" . $header->fromaddress . " "; } elseif ($tree[1] == 'branch') { echo " </li> </ul> "; } } imap_close($nntp); ?> PHP Documentation Group IMAP_THREAD(3)

Check Out this Related Man Page

IMAP_GET_QUOTA(3)							 1							 IMAP_GET_QUOTA(3)

imap_get_quota - Retrieve the quota level settings, and usage statics per mailbox

SYNOPSIS
array imap_get_quota (resource $imap_stream, string $quota_root) DESCRIPTION
Retrieve the quota level settings, and usage statics per mailbox. For a non-admin user version of this function, please see the imap_get_quotaroot(3) function of PHP. PARAMETERS
o $ imap_stream -An IMAP stream returned by imap_open(3). o $quota_root -$quota_root should normally be in the form of user.name where name is the mailbox you wish to retrieve information about. RETURN VALUES
Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space allowed for this mailbox. The usage value represents the mailboxes current level of capacity. Will return FALSE in the case of failure. As of PHP 4.3, the function more properly reflects the functionality as dictated by the RFC2087. The array return value has changed to support an unlimited number of returned resources (i.e. messages, or sub-folders) with each named resource receiving an individual array key. Each key value then contains an another array with the usage and limit values within it. For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update. EXAMPLES
Example #1 imap_get_quota(3) example <?php $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); $quota_value = imap_get_quota($mbox, "user.kalowsky"); if (is_array($quota_value)) { echo "Usage level is: " . $quota_value['usage']; echo "Limit level is: " . $quota_value['limit']; } imap_close($mbox); ?> Example #2 imap_get_quota(3) 4.3 or greater example <?php $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN) or die("can't connect: " . imap_last_error()); $quota_values = imap_get_quota($mbox, "user.kalowsky"); if (is_array($quota_values)) { $storage = $quota_values['STORAGE']; echo "STORAGE usage level is: " . $storage['usage']; echo "STORAGE limit level is: " . $storage['limit']; $message = $quota_values['MESSAGE']; echo "MESSAGE usage level is: " . $message['usage']; echo "MESSAGE limit is: " . $message['limit']; /* ... */ } imap_close($mbox); ?> NOTES
This function is currently only available to users of the c-client2000 or greater library. The given $imap_stream must be opened as the mail administrator, otherwise this function will fail. SEE ALSO
imap_open(3), imap_set_quota(3), imap_get_quotaroot(3). PHP Documentation Group IMAP_GET_QUOTA(3)
Man Page