mailbox.summary

TR50 Request


                        {
  "cmd": {
    "command": "mailbox.summary",
    "params": {
      "thingKey": "mything"
    }
  }
}

Request Parameters


Name	Type	Required	Description
thingKey	String	Yes	Identifies the Thing associated with the mailbox.
start	String		When doing a definite time period request this is the timestamp for the start of the specified time window.
end	String		When doing a definite time period request this is the timestamp for the end of the specified time window.
last	String		When doing a last period of time request this specifies the last X amount of time in seconds (s), minutes (m), hours (h), or days (d).

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "summary": {
        "new": 1,
        "completed-auto": 0,
        "completed-error": 0,
        "completed-ok": 0,
        "in-flight": 0,
        "in-progress": 0,
        "expired": 0,
        "purged": 3
      }
    }
  }
}

Response Parameters


Name	Type	Description
summary	Object	The summary object.

Summary Object


Name	Type	Description
new	Integer	The number of items in the mailbox that are new.
completed-error	Integer	The number of items in the mailbox that completed with an error.
completed-ok	Integer	The number of items in the mailbox that completed successfully
completed-auto	Integer	The number of items in the mailbox that completed automatically
in-flight	Integer	The number of items in the mailbox that are in-flight.
in-progress	Integer	The number of items in the mailbox that are in-progress.
expired	Integer	The number of items in the mailbox that expired.
purged	Integer	The number of items in the mailbox that were purged.