====== Mailbox ======
The mailbox is the basic unit for managing subscribers, guest rooms and system (auto attendant) menus within the DuVoice system. In cases of hospitality systems the mailbox number is typically configured to match the room number. In some cases it's configured as the primary extension number. 

===== Features =====
  * Create
  * Delete
  * Update
      * Name changes
      * Room status
      * Options like DND.

====== Change name ======
The API provides settings for first (given name), last (surname) and title. Each can be set independently of each other, however it is poor practice to not set the given name. Changing the name is performed via the [[dev:rest:api:mailbox:put|PUT]] method.

When a mailbox is checked out the system will automatically set the first name to //Room// and blank the last and title fields.

== PBX ==
When the system is configured with a PBXLink which supports name changes. When a name is changed this will automatically be sent to PBX.

== PMS ==
If a PMS link is configured and if that PMS supports name changes, the name will also be sent to the PMS whenever it's changed.

===== Example =====

==== Request ====
  curl -i -X PUT http://127.0.0.1:10022/rest/mailbox/7101 -d "firstName=Brock&lastName=Sampson&title=Mr" -u user:password

==== Response ====
<code yaml>
HTTP/1.1 200 OK
Date: Fri, 27 Sep 2019 18:08:46 GMT
Connection: Close
Content-Language: en
Server: DuVoice/6.03.32 DVREST/6.0.1
Access-Control-Allow-Origin: *
Location: 127.0.0.1:10022
</code>

====== Get mailbox ======
It's possible at anytime to get all the settings for a mailbox using the [[dev:rest:api:mailbox:get|GET]] method.

==== Request ====
  curl -i -X GET http://127.0.0.1:10022/rest/mailbox/7101 -u user:password

==== Response ====
<code yaml>
HTTP/1.1 200 OK
Date: Fri, 27 Sep 2019 18:11:20 GMT
Connection: close
Content-Language: en
Server: DuVoice/6.03.32 DVREST/6.0.1
Access-Control-Allow-Origin: *
Location: 127.0.0.1:10022
Content-Type: application/json
Content-Length: 675

{
  "arrivaldate" : "",
  "callScreening" : false,
  "checkedindate" : "",
  "checkedoutdate" : "",
  "cosname" : "guest",
  "created" : "20190604215303759",
  "custominfo" : [

  ],
  "departuredate" : "",
  "description" : "",
  "directory" : true,
  "dnd" : false,
  "firstName" : "Brock",
  "greeting" : 0,
  "id" : "7101",
  "language" : 0,
  "lastLogin" : "",
  "lastName" : "Sampson",
  "maidStatus" : 0,
  "modified" : "20190927110847951",
  "occupied" : false,
  "pmsGuest" : "",
  "restriction" : "",
  "roomid" : "7101",
  "tenant" : "8b9a6860-4a38-11e7-b52d-902b34db254e",
  "textCount" : 0,
  "title" : "Mr",
  "tutorial" : false,
  "type" : 5,
  "vip" : false
}
</code>

====== Set DND ======
Setting the DND for mailbox is performed via the [[dev:rest:api:mailbox:put|PUT]] method. Care should be taken with the DND setting as this could prevent a wakeup calls from alerting a room.

== PBX ==
When the system is configured with a PBXLink which supports DND it will be automatically sent to the PBX.

== PMS ==
DND settings are only received from the PMS and never sent to them because none support a third party from doing so.

==== Request ====
The dnd field will accept 0, 1, true and false. 1 is equal to true which would be to enable the feature.

  curl -i -X PUT http://127.0.0.1:10022/rest/mailbox/7101 -d "dnd=1" -u user:password

==== Response ====
<code yaml>
HTTP/1.1 200 OK
Date: Fri, 27 Sep 2019 18:18:13 GMT
Connection: Close
Content-Language: en
Server: DuVoice/6.03.32 DVREST/6.0.1
Access-Control-Allow-Origin: *
Location: 127.0.0.1:10022
</code>