Introduction   Getting Started   Upgrading   Function Reference   Changelog   Support and Feedback

remove_pm_folder

Usage: string remove_pm_folder (string folderid)
Purpose: Removes a PM Folder.
Availability: IPB SDK 0.4

Attempts to delete all messages in and remove the current user's PM folder with the internal ID folderid. Returns TRUE on success.

The Inbox and Sent Items (in and sent) are special folders, and cannot be removed.

If the operation failed, FALSE will be returned. A full error message can be accessed via sdk_error

// Removes folder 'dir_12'
$folder = "dir_12";
if ($SDK->remove_pm_folder ($folder)) {
      echo 'Folder '.$folder.' Successfully Removed';
}


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