SMF Function List

Main Menu

Navigation

Loads up all the info for either a single message or several PMs

array prepareMessageContext ([bool $reset])

Expected type: Boolean
Description: If true, starts over from the beginning of the PM list. Defaults to false.

Expected type: Array
Description:

Array Elements
Key	Optional	Expected type	Description
alternate	no	Integer	0 or 1. Used for alternating the background color of PMs
body	no	String	The actual message
counter	no	Integer	Internal message counter
fully_labeled	no	Boolean	Whether or not all available labels have been applied to this PM
id	no	Integer	ID of this PM
is_replied_to	no	Boolean	Whether or not the user has replied to this PM
is_selected	no	Boolean	Whether or not this PM has been selected
labels	no	Array	An array of information about any labels applied to this PM
member	no	Array	The $memberContext array for the member who sent this PM
number_recipients	no	Integer	The total number of recipients for this PM
recipients	no	Array	An array of information about the PM's recipients
subject	no	String	The subject of this PM
time	no	String	The date and time when the message was sent, formatted and adjusted based on the user's settings
timestamp	no	Integer	The raw timestamp corresponding to when the PM was sent

Pulls messages based on the $messages_request global variable, which is set in the MessageFolder function
Returns false if there's nothing to display