Mailbox API – Account

APIs & Tools

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

Info

Get

Response

Contact Information

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

title

String

The current user's title. e.g. "Dr.", "Prof.", "Mr.", "Ms."

Default value: ““

firstName

String

The current user's first name

Default value: ““

middleName

String

The current user's middle name

Default value: ““

lastName

String

The current user's last name

Default value: ““

suffix

String

The current user's name suffix. e.g. "Jr.", "Sr.", "I", "II"

Default value: ““

personalEmailAddress

String

The current user's personal email address

Default value: ““

Response

If successful, the response will be empty.

Aliases

List

This endpoint returns the permanent alias email addresses of the user – the email addresses the user can receive emails on. The list is a combination between domain aliases and account aliases; by default, these aliases can also be used for authentication – this can be controlled through the allowAliasLogins admin level configuration.

Response

Temporary Aliases

List

Response

Create

Response

Delete

URL parameters

Name

Type

Description

id

String

The ID of the temporary alias

Response

If successful, the response will be empty.

Signatures

List

Response

Create

Request body (JSON)

Name

Type

Required

Values

Description

name

String

*

 

The signature name

type

String

*

“html”, “text”

The signature type

body

String

*

The signature body

Response

Get

URL parameters

Name

Type

Description

id

String

The signature ID

Response

Update

URL parameters

Name

Type

Description

id

String

The signature ID

Request body (JSON)

Name

Type

Required

Values

Description

name

String

 

The new signature name

type

String

“html”, “text”

The new signature type

body

String

The new signature body

Response

If successful, the response will be empty.

Delete

URL parameters

Name

Type

Description

id

String

The signature ID

Response

If successful, the response will be empty.

Avatar

Get

Response

The avatar image associated with the account.

Update

Request body

Include the avatar image as a multipart/form-data HTTP body part.

Response

If successful, the response will be empty.

Delete

Response

If successful, the response will be empty.

Vacation Auto-reply

Get

Response

Set

Request body (JSON)

Name

Type

Required

Values

Description

age

Number

*

Any non zero number. Examples:

1 - send every day

7 - send once a week

70 - send only once

The amount of time in days in between two auto-reply messages to the same sender

applyAlways

Boolean

*

Whether to send the auto-reply always. startTime and endTime are ignored when set to true

applyToExternal

Boolean

*

Whether to send the auto-reply to senders from outside the users domain

applyToInternal

Boolean

*

Whether to send the auto-reply to senders from withing the users domain

body

String

*

The body of the auto-reply email - plain text only

enabled

Boolean

*

Whether the vacation auto-reply feature is enabled or not

startTime

String

The start of the interval when the auto-reply messages are sent expressed as timestamp in UTC format.

Note: Field mandatory when applyAlways=false

endTime

String

The end of the interval when the auto-reply messages are sent expressed as timestamp in UTC format.

Note: Field mandatory when applyAlways=false

subject

String

The subject of the auto-reply email

Response

If successful, the response will be empty.

Password

Set

This endpoint allows you to set the initial internal password of a user. The endpoint could be used to set the initial IMAP password.

The endpoint checks the mustChangePassword flag at account level.

The endpoint assumes the user is already logged in.

Note that if a password has already been set, the reset endpoint should be used for reseting the user password.

Request body (JSON)

Name

Type

Required

Values

Description

newPassword

String

*

The new password

Response

If successful, the response will be empty.

Should return an HTTP error if mustChangePassword == false.

Reset

This endpoint allows you to reset the internal password of a user.

Request body (JSON)

Name

Type

Required

Values

Description

oldPassword

String

*

The old password

newPassword

String

*

The new password

Response

If successful, the response will be empty.

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.

Index Info REQUIRES DISCUSSION

Get

This endpoint is used to return the status of the conversation index. It may be expanded to support search, sort, etc. indexes.

Current support for sort.idx and search.idx is limited to initialized/uninitialized

URL parameters

Name

Type

Required

Values

Description

ids

Array (String)

*

"conversation" , "sort", "search"

The index IDs for which the status is retrieved

scope

String

*

 

The scope for which the status is retrieved. Either a folder id or folderContainerId retrieved from GET /api/v1/account/info for the whole mailbox.

Response

Index State Values

Value

Description

Notes

uninitialized

The index is not initialized on the requested scope. Uncommon response, usually after a server upgrade. Might take a long time to change state and data might be unavailable.

 

initialized

The index is initialized and populated with data. The index might not be populated with the latest data, but will become so momentarily or on next data retrieval.

 

uptodate

The index is up to date. Any data requests will not result in index updates.

(warning) not currently returned by “sort“ and “search”

unavailable

The index is unavailable for the requested scope. This state will not change.

(warning) only available for “conversation”, when the index is disabled for the current user