Mailbox API — Account Filters

APIs & Tools

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

Get

Response

Update

Request body (JSON)

Name

Type

Required

Values

Description

whitelistIncludeAddressBook

Boolean

Whether the addresses in the address book are automatically included in the Whitelist

Default value: true

blacklistExcludeAddressBook

Boolean

Whether the addresses not in the address book are automatically excluded from the Blacklist

Default value: true

Response

Whitelist

List

Query parameters

Name

Type

Required

Values

Description

start

Number

The starting position

Default value: 0

limit

Number

The maximum number of retrieved items

Default value: the WebMailData pageSize

Response

Create

Request body (JSON)

Name

Type

Required

Values

Description

emailAddress

String

*

The email address to whitelist

Response

Update

URL parameters

Name

Type

Description

id

String

The whitelisted email address ID

Request body (JSON)

Name

Type

Required

Values

Description

emailAddress

String

*

The new email address

Response

Delete

URL parameters

Name

Type

Description

id

String

The whitelisted email address ID

Response

If successful, the response will be empty.

Blacklist

List

Query parameters

Name

Type

Required

Values

Description

start

Number

The starting position

Default value: 0

limit

Number

The maximum number of retrieved items

Default value: the WebMailData pageSize

Response

Create

Request body (JSON)

Name

Type

Required

Values

Description

emailAddress

String

*

The email address to blacklist

Response

Update

URL parameters

Name

Type

Description

id

String

The blacklisted email address ID

Request body (JSON)

Name

Type

Required

Values

Description

emailAddress

String

*

The new email address

Response

Delete

URL parameters

Name

Type

Description

id

String

The blacklisted email address ID

Response

If successful, the response will be empty.

Filters - on/off

List Presets

Response

Get Preset

Response

Choose Preset

Request body (JSON)

Name

Type

Required

Description

preset

String

true

Possible values are: “off”, “strong”, “weak”.

Response

If successful, the response will be empty.

List Filters

Response

Update Filter

URL parameters

Name

Type

Required

Description

id

Number

true

Filter id to be updated

Request body (JSON)

Name

Type

Required

Description

enabled

Boolean

true

Possible values are: “true”, “false”.

Response

If successful, the response will be empty.