Mailboxes

Test Mailbox Connection

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.

post/mailboxes/{mailbox_id}/test-connection

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/{mailbox_id}/test-connection
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Mailbox ID (mailboxes.id)

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

smtp_addressstring nullable
smtp_portinteger nullable
smtp_usernamestring nullable
smtp_passwordstring nullable
imap_addressstring nullable
imap_portinteger nullable
imap_usernamestring nullable
imap_passwordstring nullable

Response

Successful Response

dataobject required

Changes

No recorded changes to this operation across all 3 revisions of this API.