Skip to main content
POST
email.account.protocol-diagnose

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
enum<string>
required

Connected mailbox app.

Available options:
gmail,
outlook

Response

The result

mailboxType
enum<string>
required

Documented mailbox organisation type, without exposing an infrastructure provider.

Available options:
label_based,
folder_based
protocol
string
required

Mailbox access uses the connected API; no SMTP or IMAP probe was performed.

Allowed value: "mailbox_api"
health
string
required

A mailbox profile read succeeded during this call; this does not prove delivery.

Allowed value: "connected"
features
enum<string>[]
required

Documented API operations; individual permissions may still refuse an operation.

Available options:
send,
folders,
raw_append
sendingLimits
object[]
required

Documented general limits; an empty list means unknown, not unlimited.