Mailbox API – Account Settings

Axigen Documentation

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

Settings

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

archivingPolicy

String

 "none", "folderPerYear", "folderPerMonth", "subfolderPerMonth"

The new archiving policy type

conversationView

Boolean

The new option for the Conversation View

theme

String

"neutral", "breeze", "ocean"

The new option for theme

deleteToTrash

Boolean

The new option for delete to trash

confirmMailDelete

Boolean

The new option for confirm mail delete

autoAddRecipients

Boolean

The new option for auto add recipients

purgeTrashOnLogout

Boolean

The new option for purge trash message selector

purgeSpamOnLogout

Boolean

The new option for purge spam message selector

bodyHtmlFilteringLevel

Number

[0-3]

The new option for html filter level

language

String

"ar","bg","ca","cs","da","de","el","en","es","et","fa","fi","fr","he","hi","hr","hu","id","is","it","ja","ko","lt","lv","mk","nl","no","pl","pt","ro","ru","sk","sl","sr","sv","th","tr","tk","uk","vi","zh-cn","zh-tw"

The new option for language

timezone

String

The new option for timezone

dateFormat

String

"MM-DD-YYYY", "MM-DD-YY", "MM-D-YYYY", "MM-D-YY", "M-DD-YY", "M-D-YYYY", "M-D-YY", "MM/DD/YYYY", "MM/DD/YY", "MM/DD/YY",
"MM/D/YYYY", "MM/D/YY", "M/DD/YYYY", "M/DD/YY", "M/D/YYY", "M/D/YY", "MM.DD.YYYY", "MM.DD.YY", "MM.D.YYYY", "MM.D.YY",
"M.DD.YYYY", "M.D.YY", "DD-MM-YYYY", "DD-MM-YY", "DD-M-YYYY", "DD-M-YY", "D-MM-YYYY", "D-MM-YY", "D-M-YYYY", "D-M-YY",
"DD/MM/YYYY", "DD/MM/YY", "DD/M/YYYY", "DD/M/YY", "D/MM/YYYY", "D/MM/YY", "D/M/YYYY", "D/M/YY", "DD.MM.YYYY", "DD.MM.YY",
"DD.M.YY", "D.MM.YYYY", "D.MM.YY", "D.M.YYYY", "D.M.YY", "YYYY-MM-DD", "YYYY-MM-D", "YYYY-M-DD", "YYYY-M-D", "YY-MM-DD",
"YY-MM-D", "YY-M-DD", "YY-M-D", "YYYY/MM/DD", "YYYY/MM/D", "YYYY/M/DD", "YYYY/M/D", "YY/MM/DD", "YY/MM/D", "YY/M/D",
"YYYY.MM.DD", "YYYY.MM.D", "YYYY.M.DD", "YYYY.M.D", "YY.MM.DD", "YY.MM.D", "YY.M.DD", "YY.M.D"

The new option for date format

timeFormat

String

"h:mm A.M.", "h:mm A.M.", "hh:mm AM", "hh:mm A.M.", "h.mm AM", "h.mm A.M.", "hh.mm AM", "hh.mm A.M.", "h:mm", "hh:mm", "h.mm",
"hh:mm", "h.mm", "hh.mm", "h"h" mm"min"", "hh"h" mm"min""

The new option for time format

weekStartDays

Number

[0-6]

The new option for week start days

workingDays

Number

[1-127]

The new option for working days

startWorkingTime

String

The new option for start working time

endWorkingTime

String

The new option for end working time

calendarType

String

"persian", "gregorian"

The new option for calendar type

receipts

Object

receipts.sendReadReceipts

String

"ask", "always", "never"

The new option for sending read receipts

receipts.requestReadReceipts

Boolean

The new option for requesting read receipts

receipts.requestDeliveryReceipts

Boolean

The new option for requesting delivery receipts

Response

If successful, the response will be empty.

WebMail UI Settings

For Axigen WebMail frontend-specific settings and configurations.

The UI Settings endpoints are available starting with Axigen X5 (10.5).

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

uiSettings

String

*

Any string up to 8192 bytes

The frontend settings to be saved for the current account

Response

If successful, the response will be empty.

Delete

This will reset the settings to an empty string.

Response

If successful, the response will be empty.

Client UI Settings

For custom frontend-specific settings and configurations

The UI Settings endpoints are available starting with Axigen X5 (10.5).

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

clientSettings

String

*

Any string up to 8192 bytes

The frontend settings to be saved for the current account

Response

If successful, the response will be empty.

Delete

This will reset the settings to an empty string.

Response

If successful, the response will be empty.