API REFERENCE GUIDE

EMAIL SERVICES  message_list

api description

purpose

message_list returns the list of message identifiers for a signed user. It is an associative array composed of two elements:

  • "total" is the total number of of messages owned by the current signed user.
  • "list" is the array of message descriptors owned by the current user. As this list may be very long, the result may be a subset, returned in page mode (See optional parameters).Each message descriptor is an array composed of the following elements:
    1. message ID
    2. message subject
    3. ... Other undocumented elements

message_list requires valid session parameters: uuid, usid, udid and eost. See signin for further details.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"message_list"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
uuidUnique User ID.
usidUnique Session ID.
udidUnique Device ID.
eostEnd of Session Time.

optional parameters(s)

parameter values / comments
pagelenMaximum length of the returned list. Default value: 100. Maximum value: 500.
pagenumPage number. Default value: 0 (first page).

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

No specific errors.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
message_list
key
 send
request
 clear
response
Response
code
msg
data

discussion