smtp¶
Configure SMTP Server
smtp Specification¶
Parameter Value Type Configuration Resource Element Name smtp Element URI /axapi/v3/smtp Element Attributes smtp_attributes Partition Visibility shared Schema smtp schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/smtp | ||
Get Object | GET | /axapi/v3/smtp | ||
Modify Object | POST | /axapi/v3/smtp | ||
Replace Object | PUT | /axapi/v3/smtp | ||
Delete Object | DELETE | /axapi/v3/smtp |
smtp attributes¶
mailfrom
Description Configure email source address
Type: string
Format: email-addr
Maximum Length: 63 characters
Maximum Length: 1 characters
needauthentication
Description Configure SMTP server need authtication
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port
Description Configure SMTP Port (Configure SMTP port, default is 25)
Type: number
Range: 1-65535
smtp-server
Description Configure SMTP Server (length:1-254)
Type: string
Format: host
Maximum Length: 254 characters
Maximum Length: 1 characters
Mutual Exclusion: smtp-server and smtp-server-v6 are mutually exclusive
smtp-server-v6
Description Configure SMTP Server IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: smtp-server-v6 and smtp-server are mutually exclusive
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
username-cfg
Description: username-cfg is a JSON Block. Please see below for username-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
username-cfg¶
Specification Value Type object password
Description: password is a JSON Block. Please see below for username-cfg_password
Type: Object
username
Description Configure SMTP login username
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
username-cfg_password¶
Specification Value Type object encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)smtp-password
Description Configure SMTP login password
Type: string
Format: password
Maximum Length: 31 characters
Maximum Length: 1 characters