SMTP

Configure SMTP server

Configure SMTP server. Returns SMTP settings. See get SMTP settings for the response details.

put/smtp

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

enabledboolean required

Determines whether SMTP is enabled or not

encryption_methodstring

Encryption method. Custom trusted CA certificates can be configured in Advanced settings. Required if SMTP is enabled.

hoststring

SMTP server hostname. Required if SMTP is enabled.

portnumber

SMTP server port. Required if SMTP is enabled.

anonymousboolean

Use anonymous SMTP server. Required if SMTP is enabled.

userstring

Username. Required if SMTP is enabled and SMTP server is not anonymous.

passwordstring

Password. Required if SMTP is enabled and SMTP server is not anonymous.

sender_emailstring

Sender e-mail. Required if SMTP is enabled.

Response

Successful response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.