prepareMessageContext

Description

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

Syntax

array prepareMessageContext ([bool $reset])



Parameter $reset

Expected type: Boolean
Description: If true, starts over from the beginning of the query results set (default is false)



Return value

Expected type: Array
Description:

Array Elements
Key Optional Expected type Description
alternate no Integer Used to alternate background colors - either 0 or 1 ($counter % 2)
body no String The text of the PM
counter no Integer A counter indicating what PM this is in the list (ie 1, 2, 3, etc.) - mainly used to determine when to alternate the background color
id no Integer The ID of this particular PM
member no Array An array of information about the sender of the PM, loaded by loadMemberContext (or guest info if the member no longer exists)
recipients no Array of arrays An array containing two arrays: to (array of recipient IDs from the "to" field) and bcc (array of member IDs for recipients in the "bcc" field)
subject no String The subject of the message (or the appropriate "(No Subject)" string if there isn't one)
time no String A formatted date/time string indicating when the PM was sent
timestamp no Integer The raw Unix timestamp corresponding to when the PM was sent (used by the timeFormat() function to get the time string)


Notes

  • Outputs the information as a nice array
Advertisement: