API Version: Development

IPCortex.Types.Mailbox

A Mailbox instance represents an extensions mailbox, and stores a count of read and unread messages. Each Device can have a default mailbox associated with it based on the extension(s) that call it.

Properties

Name Type Description
name String Mailbox name. e.g. 123@default
label String Friendly name or number.
read Number Number of read messages.
unread Number Number of unread messages.

Methods

mailbox.addListener(event, callback)

Kind: class method of IPCortex.Types.Mailbox
Add listener method, inherited from Api base class and common to all classes.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

mailbox.removeListener(event, callback)

Kind: class method of IPCortex.Types.Mailbox
Remove listener method, inherited from Api base class and common to all classes. event and callback must be identical to those used in addListener() in order for the remove to succeed.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

Events

  • new - A new mailbox is created.
  • update - One of the mailbox message counters have changed.