mailbox.purge

The mailbox.purge command is used to purge all new messages from a mailbox.

TR50 Request


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


Name	Type	Required	Description
thingKey	String	Yes	Identifies the Thing associated with the mailbox.

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


                        {
  "cmd": {
    "success": true,
    "params": {
      "count": 3
    }
  }
}


Name	Type	Description
count	Integer	The number of messages that have been purged.