Test mail server config

POST /api-v1/mail-server/test-connection

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

application/json

Body Required

mailServerConfig

  • fromEmail string
  • host string
  • id integer
  • password string
  • port integer(int32)
  • secureConnectionType string

    Values are TLS or NONE.

  • useAuth boolean
  • userName string

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • errorType string

      Values are VALIDATION_ERROR, SERVER_UNREACHABLE, AUTHENTICATION_FAILED, or OTHER.

    • isSuccessful boolean
    • message string
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

POST /api-v1/mail-server/test-connection 
curl \
 --request POST 'https://wyzio.app/api-v1/mail-server/test-connection' \
 --header "Content-Type: application/json" \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string" \
 --data '{"fromEmail":"string","host":"string","id":42,"password":"string","port":42,"secureConnectionType":"TLS","useAuth":true,"userName":"string"}'
Request examples 
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
{
  "fromEmail": "string",
  "host": "string",
  "id": 42,
  "password": "string",
  "port": 42,
  "secureConnectionType": "TLS",
  "useAuth": true,
  "userName": "string"
}
Response examples (200) 
{
  "errorType": "VALIDATION_ERROR",
  "isSuccessful": true,
  "message": "string"
}