SMTP Configuration

Owned by Sacha Parisot (Unlicensed)
03-Jun-2022
2 min read

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                                                                                                                
smtpHostString(Required)
smtpPortInteger(Required)  Allowed values:  1 - 65535
authUserString(Required)
authFromString(Required)
authPasswordString(Required)
smtpAuthBoolean(Required)  Default value: false
smtpTlsBoolean(Required)  Default value: false

Return Codes

200         Success.  Zone created.                                                                                                                         
406Configuration 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.