Skip to content
Documentation/API reference
API · smtp

Retrieve SMTP settings

GET /api/v2/smtp

Authorization

Authenticated API key or user session. Use a workspace-scoped bearer key or an authorized user session.

Parameters

All resource access is checked against the selected workspace and user permissions.

Request

Set INBOXIT_API_KEY in your server environment. The CLI can also use an authenticated user session.

Example
curl -X GET 'https://inboxit.wtf/api/v2/smtp' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

Use INBOXIT_TOKEN for a scoped key, or inboxit login for a user session.

Example
inboxit smtp get

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "host": "mail.inboxit.wtf",
  "port": 587,
  "encryption": "STARTTLS",
  "username": "inboxit",
  "password": "Use a workspace API key with emails:send scope",
  "max_recipients": 1,
  "max_bytes": 100000,
  "attachments": false
}

Behavior & errors

Returns connection instructions, not a secret. Create a dedicated emails:send key for SMTP. See the SMTP guide for limits and Supabase setup. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.