health monitor method imap¶

IMAP type

imap Specification¶

Parameter Value

Type Configuration Resource

Element Name imap

Element URI /axapi/v3/health/monitor/{name}/method/imap

Element Attributes imap_attributes

Partition Visibility shared

Schema imap schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/imap	imap attributes
POST /axapi/v3/health/monitor/a/method/imap Payload: { "imap": { "imap-password": 1, "imap": 1, "imap-port": 1, "imap-username": "a", "imap-password-string": "a", "pwd-auth": 1, "imap-plain": 1, "imap-cram-md5": 1, "imap-login": 1 } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/imap	imap attributes
GET /axapi/v3/health/monitor/a/method/imap Reponse: { "imap": { "imap": 1, "imap-port": 1, "imap-username": "a", "imap-password": 1, "imap-encrypted": "goehcNN1j9jE0Ouipmk2IobGBayIIMedit8K/LfbRiZGgAsiWffX5UlLGnWhsm7Z", "pwd-auth": 1, "imap-plain": 1, "imap-cram-md5": 1, "imap-login": 1, "uuid": "7ac38a64-4fca-11ee-8c93-17f0fbeb6d81", "a10-url": "/axapi/v3/health/monitor/a/method/imap" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/imap	imap attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/imap	imap attributes
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/imap	imap attributes
DELETE /axapi/v3/health/monitor/a/method/imap Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

imap attributes¶

imap

Description IMAP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

imap-cram-md5

Description Challenge-response authentication mechanism

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

imap-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

imap-login

Description Simple login

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

imap-password

Description Specify the user password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

imap-password-string

Description Configure password, ‘’ means empty password

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

imap-plain

Description Plain text

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

imap-port

Description Specify the IMAP port, default is 143 (Port Number (default 143))

Type: number

Range: 1-65534

Default: 143

imap-username

Description Specify the username

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

pwd-auth

Description Specify the Authentication method

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters