API REFERENCE GUIDE

EMAIL SERVICES  message_read

api description

purpose

message_read returns a message defined by its identifier mid. The response is an associative array defined as follows:

  • UID: User ID as used in the session.
  • MID: Message ID.
  • SUB: Message subject.
  • MSG: Message body.
  • TOS: Recipient list, email addresses separated by blank spaces.
  • UPDATED: Timestamp of the latest update.
  • ... Other non documented fields.

message_read 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_read"
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.
midMessage ID.

optional parameters(s)

None

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

code message comments
658 Unknown message ID. The message ID is not recognized.

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_read
key
mid
 send
request
 clear
response
Response
code
msg
data

discussion