Test Mailbox Connection

POST

/mailboxes/{mailbox_id}/test-connection

• Production
• QA

Verify a mailbox’s IMAP/SMTP credentials and refresh its connection status.

Send an empty body to test what is stored. Supply credentials to test candidate values without saving them — useful for validating before a PATCH.

Authorizations

• BearerAuth

Parameters

Path Parameters

mailbox_id

required

Mailbox ID (mailboxes.id)

integer

Mailbox ID (mailboxes.id)

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body

Any of:

MailboxTestConnectionRequest

Optionally override credentials for the test without saving them.

object

imap_address

Any of:

string

string

null

null

imap_password

Any of:

string

string

null

null

imap_port

Any of:

integer

integer

null

null

imap_username

Any of:

string

string

null

null

smtp_address

Any of:

string

string

null

null

smtp_password

Any of:

string

string

null

null

smtp_port

Any of:

integer

integer

null

null

smtp_username

Any of:

string

string

null

null

null

null

Responses

200

Successful Response

object

data

required

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string