get_box

Function

Function Name	Description	Level
get_box	Returns a list of message subject and short content from a specific box.	3, 4

Input Parameters:

Name	Type	Required?	Description	Level
box_id	String	yes	API level 4 feature: return only unread pms if box_id is 'unread'	3,4
start_num	Int		same requirement as get_thread. Returns the latest 20 messages if both start_num and end_num is not entered.	3
end_num	Int		para_description	3

Output Parameters:

Name	Type	Required?	Description	Level
result	Boolean	yes	true: action success. False: action failed	3
result_text	byte[]			3
total_message_count	Int	yes	Returns total number of messages in the box	3
total_unread_count	Int	yes	Returns total number of unread messages in this box	3
list	Array of Hash table	yes	return a list of messages from this box	3
msg_id	String	yes
msg_state	Int	yes	1 = "Unread", 2 = "Read", 3 = "Replied", 4 = "Forwarded"	3
timestamp	String		The time stamp when the message is sent.
sent_date	Date		The time stamp when the message is sent.	3
msg_from_id	String	yes	user id of the message sender	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
msg_subject	byte[]		message subject. Make sure to remove all BBCode	3
short_content	byte[]		same rule as get_topic short_content	3
is_online	Boolean		This value is to indicate whether the sender of this message is currently online.	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