Mailbox API — Folders

APIs & Tools

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

List

Query parameters

Name

Type

Required

Values

Description

type

String

"all", "mails", "events", "tasks", "notes", "contacts"

The folder type

Default value: "all"

Note: “public_container”, “shared_namespace” and “shared_container” are not available for this property

accessMode

String

"all", "local", "public", "shared"

List only folders matching this access mode

Default value: "all"

syncTokenOnly

Boolean

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

Default value: false

Response

Create

Request body (JSON)

Name

Type

Required

Values

Description

name

String

*


The new folder name

type

String


"mails", "events", "tasks", "notes", "contacts"

The folder type

Default value: "mails" when parentId is not present or when it is equal to the root folder. Otherwise, the default value will be equal to the type of the parent folder.

Note: “public_container”, “shared_namespace” and “shared_container” are not available for this property

Note: if the parentId is sent and is not the root folder Id, then type should not be sent. In this case, if the type is sent and does not match the parent folder type, the request will result in a 400 error.

parentId

String

The parent folder ID

Default value: the folder container ID (root folder)

To create folders in the root folder, you can either omit the parentId property or use the folderContainerId provided in Account Info.

Response

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

Update

URL parameters

Name

Type

Description

folderId

String

The folder id

Request body (JSON)

Name

Type

Required

Values

Description

name

String

*

The new folder name

Response

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

Delete

Folder deletion takes into account the deleteToTrash account setting:

  • if deleteToTrash is true (which is default), then

    • if the folder is not already in Trash, deleting it will actually move it to Trash

    • otherwise, if the folder already in Trash, it's permanently deleted.

  • else

    • the folder is permanently deleted.

URL parameters

Name

Type

Description

folderId

String

The folder id

Response

If successful, the response will be empty.

Copy

URL parameters

Name

Type

Description

folderId

String

The folder id

Request body (JSON)

Name

Type

Required

Values

Description

name

String

*

The name of the newly copied folder.

parentId

String

*

The destination parent folder ID; the container ID (root folder) for top level folders.

Response

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

Move

URL parameters

Name

Type

Description

folderId

String

The folder id

Request body (JSON)

Name

Type

Required

Values

Description

parentId

String

*

The new parent folder ID; the container ID (root folder) for top level folders.

Response

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