Mailbox API – Conversations

Axigen Documentation

The Mailbox API is available starting with Axigen X4 (10.4).

List

This endpoint returns a list of conversation instances, starting from a specific (requested) folder.

Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).

Query parameters

Name

Type

Required

Values

Description

folderId

String

*

 

The folder ID

sort

String

"subject", "from", "to", "date", "isUnread", "isFlagged", "importance", "hasAttachments"

The sorting field

Default value: last provided value or "date" if not yet set

dir

String

"ASC", "DESC"

The sorting direction

Default value: last provided value or "DESC" if not yet set

start

Number

The starting position

Default value: 0

limit

Number

The maximum number of retrieved items

Default value: the WebMailData pageSize

activeConversationId

String

The active conversation ID is used to generate the activeRowIndex property.

Note: this is used to compute server-side the absolute index in the list for the provided conversation item (used mainly for clients to restore selections etc.)

syncTokenOnly

Boolean

 

 

When true, the endpoint should only return the syncToken without the conversation list.

Default value: false

Response

Get

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

Query parameters

Name

Type

Required

Values

Description

start

Number

The starting position

Default value: 0

limit

Number

The maximum number of retrieved items

Default value: the WebMailData pageSize

mailIds

Array (mailId)

The array of mailIds to be retrieved from the specified conversation.

(warning) If sent and not empty, overrides start, limit

(question)syncTokenOnly

Boolean

 

 

When true, the endpoint should only return the syncToken without the mail list.

Default value: false

Response

Get conversation from mail

URL parameters

Name

Type

Required

Values

Description

mailId

String

*

The mail ID

Response

If successful, the response will contain an instance of conversation.

Update

Updating isUnread affects all members of the conversation that are not in the Sent or Drafts folders, while updating isFlagged affects all members of the conversation.

Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

Request body (JSON)

Name

Type

Required

Values

Description

isUnread

Boolean

The unread / read value

isFlagged

Boolean

The flagged / not flagged value

Response

If successful, the response will contain an instance of conversation.

Move

This operation affects all members of the conversation that are not in the Sent or Drafts folders.

Conversations are cross-folder, covering all folders except for Spam and Trash (and their children).

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

Request body (JSON)

Name

Type

Required

Values

Description

destinationFolderId

String

*

The destination folder ID

Response

If successful, the response will contain an instance of conversation.

Conversations can be moved to Spam. In this case, all the mails from the ConversationInstance are moved to Spam and the Conversation data is deleted.

This will result in a 200 OK response with an empty body, signaling that the Conversation doesn’t exist anymore.

Delete

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

Response

If successful, the response will be empty.

Add Label

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

Request body (JSON)

Name

Type

Required

Values

Description

labelId

String

*

The label ID

Response

If successful, the response will be empty.

Remove Label

URL parameters

Name

Type

Required

Values

Description

conversationId

String

*

The conversation ID

labelId

String

*

The label ID

Response

If successful, the response will be empty.