Check hosted Mail address

Outcome

Check the validity and current availability of a proposed hosted mailbox address.

Before you start

• Verify the intended environment, credential and authorized organization context before discovery.
• Discover Mail, the exact action and its mailboxes:read permission. Pass the accessible workspace resource binding separately from action input.

Discover the target

• Run credential-scoped Mail discovery and topolo workspaces list topolo-mail; select an authorized canonical workspace.
• Resolve mailbox IDs through mailboxes.collection.list in that workspace. Resolve message, draft, thread, folder and scheduled IDs through the related published reads; never reuse fixture IDs or another context.

topolo whoami --json
topolo apps get topolo-mail --json
topolo actions get app_topolo_mail.addresses.availability.get --json
topolo workspaces list topolo-mail --json

Request

Create payload.json using the current input schema and discovered identifiers. Plan the unchanged request before execution.

topolo actions validate app_topolo_mail.addresses.availability.get --data @payload.json --json
topolo actions plan app_topolo_mail.addresses.availability.get --resource-type workspace --resource-id <discovered-workspace-id> --data @payload.json --json
topolo actions call app_topolo_mail.addresses.availability.get --resource-type workspace --resource-id <discovered-workspace-id> --data @payload.json --json

For MCP, use topolo_get_action, topolo_validate_action and topolo_plan_action; execute with topolo_read_action. Pass resourceType workspace and the discovered resourceId separately from input. An absent service/action or non-executable plan blocks that operation.

Input fields

Effects

• Reads address rules and existing address occupancy without creating or reserving a mailbox.

Interpret the response

data.address/normalizedAddress can be null; valid and available are independent decisions. An invalid name returns HTTP 200 with valid:false and available:false. The hosting domain is environment-configured; plus aliases are reserved. Availability does not reserve the address and can change before creation.

Worked requests and responses

Successful fixture request · HTTP 200

Input

{
  "address": "synthetic-fixture"
}

SDK response or error

{
  "success": true,
  "data": {
    "address": "synthetic-fixture@topolo.app",
    "normalizedAddress": "synthetic-fixture@topolo.app",
    "available": true,
    "valid": true,
    "reason": null
  }
}

Supported variant · HTTP 200

Input

{
  "address": "invalid+alias"
}

SDK response or error

{
  "success": true,
  "data": {
    "address": null,
    "normalizedAddress": null,
    "available": false,
    "valid": false,
    "reason": "Use letters, numbers, dots, underscores, or hyphens on @topolo.app. Plus aliases are reserved."
  }
}

Refused requests

Unauthenticated caller · HTTP 401

Input

{
  "address": "synthetic-fixture"
}

SDK response or error

{
  "code": "auth_error",
  "status": 401,
  "message": "Fixture authentication refused"
}

Service HTTP body

{
  "success": false,
  "error": {
    "message": "Fixture authentication refused"
  }
}

Permission denied · HTTP 403

Input

{
  "address": "synthetic-fixture"
}

SDK response or error

{
  "code": "permission_denied",
  "status": 403,
  "message": "TopoloMail permission denied"
}

Service HTTP body

{
  "success": false,
  "error": {
    "message": "TopoloMail permission denied"
  }
}

Verify the result

• Require both valid:true and available:true; use the returned normalized address with an approved mailboxes.create and handle a later conflict.

Recover

This read requests no delivery or data change. Preserve failures and repeat discovery in the same authorized context; no rollback mutation is needed.

• HTTP 401 auth_error: Authenticate again in the intended environment and context, then repeat identity and action discovery.
• HTTP 403 permission_denied: Stop for the exact permission, organization, sender or Reply-To refusal. Do not broaden access or switch credentials automatically.

The captured SDK errors preserve the service code when structured, otherwise http_error and HTTP status. Do not invent a more specific code. Preserve the live request ID and inspect actual diagnostics for uncaptured failures.

Related actions

• Create Mail mailbox

• List Mail mailboxes

Evidence and limits

• Actual exported Mail handler dispatcher, widget handler, domain handlers, SDK transport/projection and shipped SQLite control/delivery/tracking migrations.

• Identity, permissions, verified workspace grants, provider connection state, OAuth URL generation, mailbox Durable Object operations and content protection are synthetic ports.

• Nexus AI and Auth archive are allowlisted in-process responses. No paid generation, billing, live OAuth, encryption custody, email delivery, asynchronous delivery or deployed outcome is proved. External network egress is refused.

The captured requests use synthetic identities and .test recipients. They demonstrate handler and SDK response behavior; they do not authorize delivery, provider consent, paid generation, deletion or other live effects. Current catalog discovery and environment proof remain separate release requirements.