Test mail server connection

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}
Close
POST /api-v1/mail-server/test-connection

Tests the mail server configuration (basic auth or OAuth2). Returns 200 if the connection is successful, or 400 if it fails.

Headers

  • WEAL-TOKEN Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID

    ID of organization, for which the operation must be performed

application/json

Body Required

  • id integer(int64)
  • host string Required

    Minimum length is 1.

  • port integer(int32) Required
  • secureConnectionType string Required

    Values are TLS or NONE.

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

    Values are BASIC or OAUTH2.

  • oauthProvider string

    Values are GOOGLE, MICROSOFT, or YAHOO.

  • clientId string
  • oauthScopes string
  • requiresReauth boolean
  • basicAuth boolean
  • oauth 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" \
 --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,
  "basicAuth": true,
  "oauth": true
}'
Request examples 
# Headers

# 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,
  "basicAuth": true,
  "oauth": true
}
Response examples (200) 
{
  "isSuccessful": true,
  "errorType": "VALIDATION_ERROR",
  "message": "string"
}