• Welcome to Simple Machines Community Forum. Please login or sign up.

deleteMessages

Description

Handles deleting of personal messages

Syntax

void deleteMessages (mixed $personal_messages[, mixed $folder[, mixed $owner]])



Parameter $personal_messages

Expected type: Mixed
Description: Which PMs should be deleted

Allowed types for $personal_messages
Allowed values Description
Null If null, all PMs matching the given criteria will be deleted.
Array of Integers The IDs of specific PMs to delete



Parameter $folder

Expected type: Mixed
Description: Which folder to delete the PMs from

Allowed types for $folder
Allowed values Description
Null If null, PMs will be deleted from both the inbox and the outbox
String Set to 'sent' to delete only from the outbox. Set to anything else to delete from the inbox.



Parameter $owner

Expected type: Mixed
Description: Whose PMs should be deleted.

Allowed types for $owner
Allowed values Description
Null Delete the current user's PMs. Default value.
Array of Integers The IDs of the members whose PMs we want to delete.


Notes

  • Deletes one or more PMs
Advertisement: