get_box_info

Function

Function Name	Description	Level
get_box_info	Returns a list of message boxes and their information. It allows the app to support multiple folders beyond Inbox and Sent box.	3

Input Parameters:

Name	Type	Required?	Description	Level

Output Parameters:

Name	Type	Required?	Description	Level
result	Boolean	yes	true: action success. False: action failed	3
result_text	byte[]			3
message_room_count	Int		returns remaining message quota - certain forum systems put a limit on how many messages a user can store.	3
list	Array of Hash table	yes	returns a list of folder/box information	3
box_id	String	yes		3
box_name	byte[]	yes		3
msg_count	Int	yes	number of messages in this box.	3
unread_count	Int	yes	number of unread messages in this box.	3
box_type	String		Optional. returns "INBOX" if it is inbox. Returns "SENT" if it is a sent-box.	3