All folder operations can be executed by a user when connecting with his/her credentials.

+

When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

+

A GET API call on the folder returns a message list:

A GET API call on the folder returns a message list:

<pre>

<pre>

GET /vmrest/mailbox/folders/deleted/messages

GET /vmrest/mailbox/folders/deleted/messages

+

</pre>

+

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:

+

<pre>

+

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

</pre>

</pre>

Line 107:

Line 137:

</pre>

</pre>

-

HTTP requests for Messages differ by folder, so they are listed here separately for each folder:

+

A DELETE API call on Messages in the Deleted Items folder will delete the message from the folder. This is a hard (permanent) delete.

+

<pre>

+

DELETE /vmrest/messages/<message-id>

+

</pre>

-

<br>

+

A POST API call on the Deleted Items folder can be used to empty the whole folder. The messages are hard deleted.

-

+

<pre>

-

{| border="1" cellspacing="0" cellpadding="5" align="center"

+

POST /vmrest/mailbox/folders/deleted/messages?method=empty

-

|-

+

</pre>

-

! Folder

+

-

! Request

+

-

! Description

+

-

|-

+

-

| inbox/messages

+

-

| GET

+

-

| Returns read and unread messages that are not drafts or deleted messages.

+

-

|-

+

-

| inbox/messages

+

-

| PUT

+

-

| Can be used to update the message subject only.

+

-

|-

+

-

| inbox/messages

+

-

| DELETE

+

-

| Depending on system settings, either removes message or moves it to the "deleted" folder.

+

-

|-

+

-

| inbox/messages

+

-

| POST?method=accept

+

-

| Causes a dispatch message to be accepted.

+

-

|-

+

-

| inbox/messages

+

-

| POST?method=reject

+

-

| Causes a dispatch message to be rejected.

+

-

|-

+

-

| deleted/messages

+

-

| GET

+

-

| Returns list of deleted messages (if the system is set to "soft" delete - otherwise the list will always be empty).

+

-

|-

+

-

| deleted/messages

+

-

| DELETE

+

-

| Removes messages from the deleted folder (does a "hard" delete).

+

-

|-

+

-

| deleted/messages

+

-

| POST?method=empty

+

-

| Empties the deleted folder (permanently removes all messages in the folder).

+

-

|-

+

-

| deleted/messages

+

-

| POST?method=undelete

+

-

| Undeletes the specified message.

+

-

|-

+

-

| sent/messages

+

-

| GET

+

-

| Returns a list of recently sent messages.

+

-

|-

+

-

| sent/messages

+

-

| DELETE

+

-

| Deletes a message from the sent list.

+

-

|}

+

-

+

-

A '''dispatch message''' is a message that needs to go to one and only one member of a group. When the message is accepted by any one user, it is no longer available to other users. When the message is rejected by a user in the group, it is removed from the user's voicemail list.

Contents

About Mailboxes and Folders

The root of the Cisco Unity Connection Messaging Interface (CUMI) API is the Mailbox resource that is associated with each user. This contains some general information about the user's mailbox, and also contains a Folders resource that lists the folders for the mailbox. This list is currently fixed, although it is possible that folders may be added in the future.

Doing a GET on the Mailbox returns properties of the mailbox (for example, quotas) as well as a link to the Folders element for the mailbox:

Mailbox Folder Operations

There are three Folders currently supported on a Unity Connection Mailbox -

Inbox

Sent Items

Deleted Items

Doing a GET on the Folders returns the fixed list of folders:

GET /vmrest/mailbox/folders

A Folder consists of a small set of properties (DisplayName and MessageCount) and a collection of Messages.
Doing a GET on a Folder returns a small folder resource object and a reference to its list of Messages:

Inbox Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials.
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list:

GET /vmrest/mailbox/folders/inbox/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call can on Messages in the Inbox folder can update the Subject or the Read field on the Messages. No other parameter on a message can be changed:

Sent Items Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials.
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list:

GET /vmrest/mailbox/folders/sent/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call on Messages in the Sent Items folder can update the Subject on the Messages. No other parameter on a message can be changed:

Deleted Items Folder Operations

All folder operations can be executed by a user when connecting with his/her credentials.
When using the administrative credentials, using the userobjectid parameter will allow administrators to do the same operations on the users mailbox.

A GET API call on the folder returns a message list:

GET /vmrest/mailbox/folders/deleted/messages

A user with administrative privileges can list the messages in another users folder by passing in the userobjectid of the user:

GET /vmrest/mailbox/folders/inbox/messages?userobjectid=<userobjectid>

A PUT API call can be used on Messages in the Deleted Items folder to update the Subject on the Messages. No other parameter on a message can be changed:

A DELETE API call on Messages in the Deleted Items folder will delete the message from the folder. This is a hard (permanent) delete.

DELETE /vmrest/messages/<message-id>

A POST API call on the Deleted Items folder can be used to empty the whole folder. The messages are hard deleted.

POST /vmrest/mailbox/folders/deleted/messages?method=empty

Offset and Limit

Each of the folders will accept the parameters "pagenumber" and "rowsperpage" to specify which messages to retrieve:

/vmrest/mailbox/folders/inbox/messages?pagenumber=1&rowsperpage=10

Sorting

Initially, server-side sorting will be limited to what can be done efficiently by the database, and will default to placing new messages first, followed by read messages, and sorted within each by ArrivalTime.

As recommended in the VTG REST guidelines, sorting will be controlled via "sortkey" and "sortorder" parameters, although initially only the following sort orders will be supported by the server:

Sort Description

Sort Parameters

Newest first

no parameters (default) or sortkey=arrivaltime&sortorder=descending

Oldest first

sortkey=arrivaltime&sortorder=ascending

Urgent first

sortkey=priority&sortorder=descending

Filtering

Filtering can be done on the folders by read, priority, voice, fax and dispatch.