Get IMAP/SMTP connection settings + login for an owned mailbox

GET

/v1/inboxes/{inbox_id}/credentials

• Production
• Local

Paid-plan only. Re-checks ownership and unseals the mailbox password so an agent can configure a real mail client.

Authorizations

• AgentKey
  mailbox:credentials

Parameters

Path Parameters

inbox_id

required

string

Opaque inbox id (the canonical path key). The inbox’s email address is also accepted here as a within-project alias. Treat the id as opaque.

Responses

200

Ok

Full IMAP/SMTP connection config and login for an owned inbox. Export requires a paid plan plus mailbox:credentials. IMAP remains usable after export, but SMTP submission is rejected unless a human has separately enabled the inbox’s paid-only direct_smtp_enabled bypass.

object

address

string

Example

support@extrovertmail.com

username

Equals the address.

string

password

string

imap

One IMAP or SMTP endpoint for a mailbox.

object

host

string

Example

smtp.extrovert.dev

port

integer

Example

993

security

tls (implicit TLS, e.g. IMAP 993) or starttls (e.g. SMTP 587).

string

Allowed values: tls starttls

smtp

One IMAP or SMTP endpoint for a mailbox.

object

host

string

Example

smtp.extrovert.dev

port

integer

Example

993

security

tls (implicit TLS, e.g. IMAP 993) or starttls (e.g. SMTP 587).

string

Allowed values: tls starttls

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

403

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

404

Resource not found.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope