/
SMTP Configuration

SMTP Configuration

This API allows you to manage your SMTP configuration.  

URI Definition

Method

URI and Fields

GET

/iap/smtp/configuration

Returns the current SMTP configuration.

Response Parameters

See the payload parameters for the PUT method.

Response Example

[                                                                                                                                                                                     

    {
        smtpHost: "mail.server.com",
        smtpPort: "455",
        authUser: "user",
        authFrom: "user@server.com",
        smtpAuth: true,
        smtpTls: true
    }
]

Return Codes

200         

Success.  Zone created.               

POST

/iap/smtp/configuration

Specifies the SMTP configuration.

Payload Parameters

Field                      

Type            

Description                                                                                                                

smtpHost

String

(Required)

smtpPort

Integer

(Required)  Allowed values:  1 - 65535

authUser

String

(Required)

authFrom

String

(Required)

authPassword

String

(Required)

smtpAuth

Boolean

(Required)  Default value: false

smtpTls

Boolean

(Required)  Default value: false

Return Codes

200         

Success.  Zone created.                                                                                                                         

406

Configuration not accepted. Invalid authorization credentials.

Query Parameters

Optional query parameters can be used with your REST request.  Specifying queries is described under Queries and Parameters, Path Parameters, and Query Parameters.