Introduction   Getting Started   Upgrading   Function Reference   Changelog   Support and Feedback

get_pm_folders

Usage: array get_pm_folders()
Purpose: Returns a array of the current user's PM folders.
Availability: IPB SDK 0.1

Returns the a listing of the currently logged in user's PM folders, in a multi-dimensional array. If the current user is not logged in, or information cannot be retrieved FALSE is returned.

To cycle through and display PM folders, try the following code:

/* The following code cycles through and displays a list of PM Folders */
$folders = $SDK->get_pm_folders();
foreach ($folders as $i) {
      // Displays "Internal ID: in - Full Name: Inbox<br />"
      echo 'Internal ID: '.$i['0'].' - Full Name: '.$i['1'].'<br />';
}

This function returns an array in the following structure:

Array (
   [0] => Array (
      [0] => in
      [1] => Inbox
   )
   [1] => Array (
      [0] => sent
      [1] => Sent Items
   )

)


User Contributed Notes

There are currently no user contributed notes for this page.

Documentation Generated at Sat, 16 Apr 2005 07:36:35 -0700
Find the latest version at http://ipbsdk.sourceforge.net