Skip to content

Validate Inbox Send Mailbox

POST
/inbox/emails/validate-mailbox

Can this mailbox send right now? Reads only - nothing is delivered.

Checks that the mailbox is connected, syncing, of a supported provider, that its credentials still work, and that this caller is allowed to send as it. Gates on inbox:read: a key that can only read the inbox must still be able to find out whether a send WOULD work before anyone tries.

An unauthorised mailbox is a 403 here, the same refusal the send itself gives, so the pre-flight and the real thing cannot disagree.

Authorizations

Parameters

Query Parameters

mailbox
required

The mailbox address you intend to send AS.

string

The mailbox address you intend to send AS.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string