BizKitHub
DocsAPI ReferenceEmailer/bff/emailer/check-smtp
postEmailerAdmin BFF

/bff/emailer/check-smtp

Connects and authenticates against the SMTP server without saving anything and without sending an e-mail. Returns a step-by-step classified result.

EmailerpostBffEmailerCheck-smtp

Parameters

JSON body

Request body

application/json
hoststringRequired

SMTP server hostname.

Examplesmtp.example.com
portstringRequired

SMTP server port.

Example587
fromstringRequired

Sender email address (From header).

authUserstringRequired

SMTP authentication username.

authPasswordstringOptional

SMTP password. Empty = use the saved password.

Response schema

1 status code documented

200Success
successbooleanRequired
usedStoredPasswordbooleanRequired
stepsobject[]Required
Each array item:
stepstringRequired

target | connection | auth | send

statusstringRequired

ok | failed | skipped

diagnosisobjectOptional
stagestringRequired

target | connect | tls | auth | sender | recipient | message | unknown

reasonstringRequired

Classified failure reason, e.g. AUTH_REJECTED.

providerstringRequired

proton | google | microsoft | seznam | other

hintsstring[]Required

Actionable hint code, e.g. PROTON_TOKEN_USER.

smtpCodenumberOptional

SMTP reply code, e.g. 535.

enhancedCodestringOptional

Enhanced status code, e.g. 5.7.8.

commandstringOptional

SMTP verb the server answered, e.g. AUTH PLAIN.

errorCodestringOptional

Transport error code, e.g. EAUTH.

contextobjectRequired
hoststringRequired
portnumberRequired
securitystringRequired

SSL/TLS (465) or STARTTLS.

providerstringRequired
authUserstringRequired
fromstringRequired
passwordLengthnumberRequired
durationMsnumberRequired
checkedAtstringRequired

Response example

application/json
{
  "success": false,
  "usedStoredPassword": false,
  "steps": [
    {
      "step": "example_step",
      "status": "example_status"
    }
  ],
  "diagnosis": {
    "stage": "example_stage",
    "reason": "example_reason",
    "provider": "example_provider",
    "hints": [
      "string"
    ],
    "smtpCode": 0,
    "enhancedCode": "example_enhancedCode",
    "command": "example_command",
    "errorCode": "example_errorCode"
  },
  "context": {
    "host": "example_host",
    "port": 0,
    "security": "example_security",
    "provider": "example_provider",
    "authUser": "example_authUser",
    "from": "example_from",
    "passwordLength": 0
  },
  "durationMs": 0,
  "checkedAt": "example_checkedAt"
}

Request example

POST /bff/emailer/check-smtp

post
curl -X POST "https://api.bizkithub.com/bff/emailer/check-smtp" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "host": "smtp.example.com",
  "port": "587",
  "from": "example_from",
  "authUser": "example_authUser",
  "authPassword": "example_authPassword"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key