Mailbox API – Account | Axigen Documentation

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

Info
- Get
Contact Information
- Get
- Update
Aliases
- List
Temporary Aliases
- List
- Create
- Delete
Signatures
- List
- Create
- Get
- Update
- Delete
Avatar
- Get
- Update
- Delete
Vacation Auto-reply
- Get
- Set
Password
- Set
- Reset
Index Info
- Get

Info

Get

Response

Contact Information

Get

Response

Update

Request body (JSON)

Name	Type	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	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.

Index Info

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.	not currently returned by “sort“ and “search”
unavailable	The index is unavailable for the requested scope. This state will not change.	only available for “conversation”, when the index is disabled for the current user