get_message

Function

Function Name	Description	Level
get_message	Returns content of private message given a box id and message id	3, 4

Input Parameters:

Name	Type	Required?	Description	Level
message_id	String	yes		3
box_id	String	yes		3
return_html	Boolean	yes	Return post content with some bbcode supported. Currently it can return <i>, <u>, <b> and <font color="xxxx"> where "xxxx" is name of the color. This extra parameter is used in conjunction with "disable_html" flag in get_config. If "disable_html=0" or is missing, this parameter should be set to false. Otherwise if disable_html is "1", this paramter should be set to true, or simply not using this paramter at all.</font></b></u></i>	4

Output Parameters:

Name	Type	Required?	Description	Level
result	Boolean	yes	true: action success. False: action failed	3
result_text	byte[]			3
msg_from_id	String			4
msg_from	byte[]		username of the message sender. this field is not required if the current box is a Sent box	3
icon_url	String		returns the sender avatar URL. If the current box is a Sent box, returns the first recipient avatar URL	3
sent_date	Date		The time stamp when the message is sent.	3
timestamp	String		The time stamp when the message is sent.
msg_subject	byte[]		message subject. Make sure to remove all BBCode	3
text_body	byte[]		same rule as get_thread's post_content field	3
is_online	Boolean		This value is to indicate whether the sender of this message is currently online.	3
allow_smilies	Boolean		This value (if "false") is to instruct the app do not display smilies and instead display it in text format. This is to address certain forum system allows forum admin to disable smilies across the board. If this flag is missing, assume "true"	4
msg_to	Array of Hash table	yes	returns an array of Hash-table of recipient data	3,4
user_id	String			4
username	byte[]	yes		3
attachments	Array of Hash table		Returns a list of attachments user has uploaded within this message, in array of hash format.
filename	byte[]	yes
filesize	Int	yes
content_type	String	yes	return "jpg", "pdf" or other file extension.
url	String	yes	URL of the attachment source.
thumbnail_url	String		if content type is image, use absolute path (optional: if not presented, use "url" to load thumbnail instead)