isAccessiblePM

Description

Checks whether the specified PM is accessible to the current user.

Syntax

bool isAccessiblePM (int $pmID[, string $validFor])


Parameter $pmID

Expected type: Integer
Description: The ID of the PM


Parameter $validFor

Expected type: Enumerated String
Description: A string indicating which box the message is valid for.

Possible string values
Allowed values Description
'inbox' Only valid for the inbox
'in_or_outbox' Valid for either (default value)
'outbox' Only valid for the outbox (sent items)


Return value

Expected type: Boolean
Description: True if it is available, false otherwise


View all versions of this function
Advertisement: