list_pms

Usage: array list_pms(string folderid)
Purpose: Returns message information for messages in a PM folder.
Availability: IPB SDK 0.1

Returns information on the private messages in the folder folderid, in an array. If information cannot be retrieved, or the currently logged in user does not have sufficent permissions FALSE is returned.

For example to display a list of messages in the Inbox folder:

if ($pm = $SDK->list_pms("in")) {
      foreach ($pm as $i) {
            echo $i['mt_title'].' ( Sent by <strong>'.$i['name'].'</strong> at '.date("M j Y, h:i A", $i['msg_date']).' )<br />';
      }
}

This function returns an array in the following structure:

Array (
      [0] => Array (
            [msg_id] => 1
            [msg_date] => 1084870199
            [msg_post] => testing <img src='http://localhost/html/emoticons/ohmy.gif' border='0' style='vertical-align:middle' alt='ohmy.gif' />
            [msg_cc_users] =>
            [msg_sent_to_count] => 1
            [msg_deleted_count] => 0
            [msg_post_key] => 0
            [msg_author_id] => 12
            [mt_id] => 1
            [mt_msg_id] => 1
            [mt_date] => 1084870199 // Unix Send Date
            [mt_title] => hey
            [mt_from_id] => 12
            [mt_to_id] => 1
            [mt_owner_id] => 1
            [mt_vid_folder] => in
            [mt_read] => 1
            [mt_hasattach] => 0
            [mt_hide_cc] => 0
            [mt_tracking] => 0
            [mt_user_read] => 0
            [name] => khlo // Message Sender Name
            [recipient_name] => Pita // IPBK SDK 0.4 and later
      )
      [1] => Array (
            [msg_id] => 2
            [msg_date] => 1084870679
            [msg_post] => testing laaaa
            [msg_cc_users] =>
            [msg_sent_to_count] => 1
            [msg_deleted_count] => 0
            [msg_post_key] => 0
            [msg_author_id] => 12
            [mt_id] => 1
            [mt_msg_id] => 1
            [mt_date] => 1084870679 // Unix Send Date
            [mt_title] => heydy
            [mt_from_id] => 12
            [mt_to_id] => 1
            [mt_owner_id] => 1
            [mt_vid_folder] => in
            [mt_read] => 1
            [mt_hasattach] => 0
            [mt_hide_cc] => 0
            [mt_tracking] => 0
            [mt_user_read] => 0
            [name] => khlo // Message Sender Name
            [recipient_name] => Pita // IPBK SDK 0.4 and later
      )
)