Get IMAP/SMTP connection settings + login for an owned mailbox
GET /v1/inboxes/{inbox_id}/credentials
Paid-plan only. Re-checks ownership and unseals the mailbox password so an agent can configure a real mail client.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”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
Section titled “ Responses ”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 setting. SMTP acceptance means custody; required review waits for approval, and recipient policies and billing apply at dispatch.
object
Example
support@extrovertmail.comEquals the address.
One IMAP or SMTP endpoint for a mailbox.
object
Example
smtp.extrovert.devExample
993tls (implicit TLS, e.g. IMAP 993) or starttls (e.g. SMTP 587).
One IMAP or SMTP endpoint for a mailbox.
object
Example
smtp.extrovert.devExample
993tls (implicit TLS, e.g. IMAP 993) or starttls (e.g. SMTP 587).
Missing or invalid credential.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeMachine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.
Consumed plus reserved units.
Requested additional units.
Next UTC usage-period boundary; pending reservations survive this boundary.
Authenticated but lacking the required scope, or out of quota.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeMachine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.
Consumed plus reserved units.
Requested additional units.
Next UTC usage-period boundary; pending reservations survive this boundary.
Resource not found.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeMachine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.
Consumed plus reserved units.
Requested additional units.
Next UTC usage-period boundary; pending reservations survive this boundary.