mapi_folder_gethierarchytable ()

mapitable	mapi_folder_gethierarchytable(mapifolder $folder, long $flags)

Gets the hierarchytable

Opens the hierarchytable of the folder. The hierarchytable contains the subfolders of the folder. Returns a mapitable object on success, FALSE on failure.

// Get a the messagestore $inbox is a valid MAPI Folder
$table = mapi_folder_gethierarchytable($inbox);
		

mapi_folder_getcontentstable ()

mapitable	mapi_folder_getcontentstable(mapifolder $folder, long $flags)

Gets the contentstable

Opens the contentstable of the folder. The contentstable contains the messages of the folder. Returns a mapitable object on success, FALSE on failure.

// Get the messages of $inbox
$table = mapi_folder_getcontentstable($inbox);
		

mapi_folder_createmessage ()

mapimessage mapi_folder_createmessage(mapifolder $folder, long $flags)

Creates a new message in the folder

This function makes a new message in the folder. It returns the newly created message and with mapi_setprops properties can be stored into the message. The message is not visible to other users until the mapi_savechanges function is called. Returns a mapimessage object on success, FALSE on failure.

// Create a new message into the inbox
$viewlist = mapi_folder_createmessage($inbox);
		

mapi_folder_deletemessages ()

boolean mapi_folder_deletemessages(mapifolder $folder, array $entryids, long $flags)

Deletes messages from a folder

This function removes a message with the given entryid's from the specified folder. Note that normally in Outlook, messages are simply moved to the 'Deleted items' folder when a 'delete' is requested, and messages are only really deleted when they are removed from the 'Deleted items' folder. Returns TRUE for success, FALSE for failure.

// Create a new message into the inbox
$msg = mapi_folder_createmessage($inbox);
mapi_savechanges($msg);

// Get the EntryID
$props = mapi_message_getprops($msg);

// Remove it
mapi_folder_deletemessages(array($props[PR_ENTRYID]));
		

mapi_folder_copymessages ()

boolean mapi_folder_copymessages(mapifolder $srcFolder, array $messageArray,  mapifolder $destFolder, long $Flags)

Copies one or more messages from one folder to another.

This function moves or copies the one or more messages given with the messageArray. The function will return true when the copying was succesfull.

The messagearray must be in following structure:

$messageArray = array (
	[0] => {entryid}
	[1] => {entryid}
	...
);
	  

The optional flag can be MESSAGE_MOVE when the messages must be moved from the sourcefolder to the destination folder, when no flag is provided the messages will be copied.

$storeprops = mapi_msgstore_getprops($userstore);
$wastebasket = mapi_msgstore_openentry($userstore, $storeprops[PR_IPM_WASTEBASKET_ENTRYID]);

$inbox = mapi_msgstore_getreceivefolder($userstore);
$contentstable = mapi_folder_getcontentstable($inbox);
$contents = mapi_table_queryallrows($contentstable); 

foreach($contents as $row) {
	$msg[] = $row[PR_ENTRYID];
}

mapi_folder_copymessages($inbox, $msg, $wastebasket, MESSAGE_MOVE);
		

mapi_folder_emptyfolder ()

boolean mapi_folder_emptyfolder(mapifolder $folder, long $flags)

Deletes all the messages in a folder.

This function deletes all the messages and subfolders in the folder. But without deleting itself.

The followin flag can be set: DEL_ASSOCIATED With this flag set the function deletes all subfolders, including subfolders containing messages with associated content. The DEL_ASSOCIATED flag only has meaning for the top-level folder the call acts on.

$storeprops = mapi_msgstore_getprops($userstore);
$wastebasket = mapi_msgstore_openentry($userstore, $storeprops[PR_IPM_WASTEBASKET_ENTRYID]);

mapi_folder_emptyfolder($wastebasket);
// wastebasket is empty now. 
		

mapi_folder_copyfolder ()

boolean mapi_folder_copyfolder(mapifolder $srcfolder, string $entryid, mapifolder $destfolder, string $new_foldername, long $flags)

Copies a folder from one parent folder to another.

This function moves or copies the folder given with entryid. The function will return true when the copy/move was successful.

$res = mapi_folder_copyfolder($inbox, $tocopy_folder_entryid, $dest_folder, "New folder name", COPY_SUBFOLDERS | FOLDER_MOVE);
if ($res == false) {
	print "mapi_folder_copyfolder() failed.";
}
		

mapi_folder_deletefolder ()

boolean mapi_folder_deletefolder(mapifolder $srcfolder, long $entryid, long $flags)

Deletes a folder.

This function deletes the folder given with the entryid. The function will return true when the deletion was successful.

// Delete a folder
$result = mapi_folder_deletefolder($parent, $folderid);
		

mapi_folder_createfolder ()

boolean mapi_folder_createfolder(mapifolder $parentfolder, string $name, string $description, long $flags, long $foldertype)

Creates a folder.

This function creates a folder within the given folder; with the given name and description. It returns true on success, false on failure.

// Create a folder
$result = mapi_folder_createfolder($folder, "New folder", "Description for new folder");
		

mapi_folder_setreadflags ()

boolean mapi_folder_setreadflags(mapifolder $folder, array $entryids, long $flags)

Mark a list of messages in a folder as read.

This function markes selected messages in a given folder. All the messages can be set read or unread in the folder. It returns true on success, false on failure.

// Mark all messages read in the inbox
$result = mapi_folder_createfolder($inbox, array());
		

mapi_folder_openmodifytable ()

resource mapi_folder_openmodifytable(mapifolder $inbox)

Returns the IExchangeModifyTable interface.

The IExchangeModifyTable interface is used for the rules table. Use this interface to read and write rules which are applied on incoming e-mails.

It returns the IExchangeModifyTable on success, false on failure.

// Requesting the IExchangeModifyTable interface
$inbox = mapi_msgstore_getreceivefolder($store);
$emt = mapi_folder_openmodifytable($inbox);
		

mapi_folder_setsearchcriteria ()

bool mapi_folder_setsearchcriteria(mapifolder $folder, array $restriction, array $folderlistr, long $flags)

Set/reset search criteria of a search folder.

mapi_folder_setsearchcriteria can be used to setup a search folder. Once setsearchcriteria has been successfully called, the server will start running the search. A contents table for this folder with show only those items that match the search and will be dynamically built in the background.

Note that after setsearchcriteria has been called, the contents table will not directly show all matches, but will start to build them slowly. You can see if the search is still running by calling mapi_folder_getsearchcriteria.

mapi_folder_getsearchcriteria ()

bool mapi_folder_getsearchcriteria(mapifolder $folder, long $flags)

Get search criteria and status of a search folder.

mapi_folder_getsearchcriteria returns an associative array with three values: the restriction and folder list from setsearchcriteria, and a searchstate flag. These are stored respectively in the 'restriction', 'folderlist' and 'searchstate' keys in the returned associative array. The searchstate value may be any combination of SEARCH_REBUILD, SEARCH_RUNNING, SEARCH_FOREGROUND and SEARCH_RECURSIVE.

When a folder first starts the search process (after mapi_folder_setsearchcriteria), it will return SEARCH_REBUILD | SEARCH_RUNNING until the search has completed. After this, it will return SEARCH_RUNNING, until the search is restarted or stopped. If the search has stopped, neither SEARCH_REBUILD or SEARCH_RUNNING will be set.