Test mail server config (basic auth or OAuth2)

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

Headers

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID integer

    ID of organization, for which the operation must be performed

application/json

Body Required

  • id integer
  • host string Required
  • port integer(int32) Required
  • secureConnectionType string Required

    Values are TLS or NONE.

  • userName string
  • password string
  • useAuth boolean
  • fromEmail string Required
  • authType string Required

    Values are BASIC or OAUTH2.

  • oauthProvider string Required

    Values are GOOGLE, MICROSOFT, or YAHOO.

  • clientId string Required
  • oauthScopes string
  • requiresReauth boolean
  • oauth boolean
  • basicAuth boolean

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • isSuccessful boolean
    • errorType string

      Values are VALIDATION_ERROR, SERVER_UNREACHABLE, AUTHENTICATION_FAILED, or OTHER.

    • 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 "WEAL-TOKEN: string" \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --data '{"id":42,"host":"string","port":42,"secureConnectionType":"TLS","userName":"string","password":"string","useAuth":true,"fromEmail":"string","authType":"BASIC","oauthProvider":"GOOGLE","clientId":"string","oauthScopes":"string","requiresReauth":true,"oauth":true,"basicAuth":true}'
Request examples 
# Headers
WEAL-TOKEN: string
TARGET-ORGANIZATION-ID: 42

# Payload
{
  "id": 42,
  "host": "string",
  "port": 42,
  "secureConnectionType": "TLS",
  "userName": "string",
  "password": "string",
  "useAuth": true,
  "fromEmail": "string",
  "authType": "BASIC",
  "oauthProvider": "GOOGLE",
  "clientId": "string",
  "oauthScopes": "string",
  "requiresReauth": true,
  "oauth": true,
  "basicAuth": true
}
Response examples (200) 
{
  "isSuccessful": true,
  "errorType": "VALIDATION_ERROR",
  "message": "string"
}