POST /system-ms/email-server

Add the Email server.

Note:

  • Only Admin user is allowed to add Email server.

  • Only one Email server can be configured.

To add the Email server:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use POST /system-ms/email-server to send an HTTP POST request to the authentication service.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:
    {
  "smtpServer": "string",
  "port": 0,
  "userID": "string",
  "password": "string",
  "emailAddress": "string"
}
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description
    >smtpServer

    String

    Enter the IP address , DNS Name or Mail Server Host Name for Mail Server Configuration.

    Format:

    Up to 64 alphanumerical characters. The characters ?, ', ?, &, <, >, \, * and comma (,) are not allowed.

    Options:

    • IP address

    • Host name

    Examples:

    • 192.168.0.138

    • mkd-mbx02.company.com

    Maximum Length: 64

    Minimum Length: 1

    Pattern: ^[^,'?\\\\&><?*]*$
    Note: This parameter is mandatory.
    >port

    Integer (int32)

    Enter the port number of the system where the connection is opened for communication.
    >userID

    String

    Enter the User Id that will be used to access the mail server.

    Format: Up to 30 alphanumerical characters. The characters ?, ', *, ?, <,>and \ are not allowed. The user name is case sensitive.

    Example: Mailuser1

    Maximum Length: 113

    Minimum Length: 0

    Pattern: ^[^,'?\\&><?*]*$
    >password

    String

    Enter the Password that will be used to access the mail server.

    Format: Up to 30 alphanumerical characters. The password is case sensitive.

    Example: Mailpw1

    Note: Password in Email Server is enabled when a value has been entered in User Id in Email Server.

    Maximum Length: 30

    Minimum Length: 0
    >emailAddress

    String

    Enter the Email Address. The new password will be sent from this email address.

    Format: Up to 256 alphanumerical characters The characters ?, ', ?, &, <, >, \, * and comma (,) are not allowed.

    Example: [email protected]Maximum Length: 256

    Minimum Length: 1

    Pattern: ^([^,'?\\&><?*]+@[^,'?\\&><?*]+\.[aA-zZ]{2,4})*$
    Note: This parameter is mandatory.

  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/system-ms/email-server
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    201 Created

    		 
    {
  "passwordStrength": "string",
  "minimumPasswordLength": 0,
  "maximumPasswordLength": 0,
  "passwordExpirationPeriod": 0,
  "daysBeforeExpire": 0
}

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: Email Server
↑