Mailbox API – Labels | Axigen Documentation

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

List
Get
Create
Update
Delete

Axigen labels are case insensitive and are also exposed in IMAP as permanent flags.

Since there is a degree of inconsistency across IMAP clients in how they handle permanent flags, the following labels are not allowed for use with the Mailbox API: junk, notjunk, nonjunk.

If any of the labels above are added via IMAP clients, they will not be exposed by the Mailbox API. Moreover, the Mailbox API will not allow these labels to be created and / or applied to emails or conversations.

List

Query parameters

Name	Type	Required	Values	Description
`syncTokenOnly`	`Boolean`			When true, the endpoint should only return the syncToken without the label list. Default value: false

Name

Type

Required

Values

Description

syncTokenOnly

Boolean

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

Default value: false

Response

Get

URL parameters

Name	Type	Description
`labelId`	`String`	The label ID

Response

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

Create

Request body (JSON)

Name	Type	Required	Values	Description
`name`	`String`	*		The label name (up to 128 characters)

Response

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

Update

URL parameters

Name	Type	Description
`labelId`	`String`	The label ID

Request body (JSON)

Name	Type	Required	Values	Description
`name`	`String`	*		The new label name (up to 128 characters)

Response

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

Delete

URL parameters

Name	Type	Description
`labelId`	`String`	The label ID

Response

If successful, the response will be empty.