All requests are authenticated using DIGEST authentication and SSL protected.
API
Base URL: https://{host name}:8085/mailbox/{user id
}
URL | METHOD | Description |
---|---|---|
/mwi | PUT w/no body | Updates the MWI for this mailbox (i.e. tells the status server |
| GET | Returns the MWI status for this mailbox in RFC-3842 format. |
/messages | GET | returns all messages in mailbox |
/message/{messageid} | GET | where {messageid} is the unique message ID for the message, an 8 digit number. |
/heard | PUT (no body) | Marks the message heard (and updates MWI |
| GET | returns message heard status. The body returned is the XML fragment: <heard>true|false</heard> |
| DELETE | DELETE Marks the message unheard (and updates MWI) |
/delete | PUT (no body) | Moves the message to Trash folder |
/preferences/activegreeting | PUT with body <activegreeting>{value}\</activegreeting> where {value} is one of : | sets the active greeting |
| GET | returns the active greeting (returns above fragment) |
| DELETE | sets the active greeting to |
Examples
$curl --digest -k --request GET https://200:123@localhost:8085/mailbox/200/mwi Messages-Waiting: no Voice-Message: 0/3 (0/0)
$curl --digest -k --request PUT https://200:123@localhost:8085/mailbox/200/message/00000080/heard
$curl --digest -k --request PUT https://200:123@localhost:8085/mailbox/200/message/00000018/delete
$curl --digest -k --request GET https://200:123@localhost:8085/mailbox/200/messages <message id=00000018 heard=true urgent=false folder=deleted duration=0 received=1171062204000/>
$curl --digest -k --request GET https://200:123@localhost:8085/mailbox/200/preferences/activegreeting standard