Tests connectivity to the mail server for the specified mailbox.

curl --request GET \
  --url https://{install}/api/mail/mailbox/{id}/test \
  --header 'Authorization: Bearer <token>'

GET

api

mail

mailbox

{id}

test

Tests connectivity to the mail server for the specified mailbox.

curl --request GET \
  --url https://{install}/api/mail/mailbox/{id}/test \
  --header 'Authorization: Bearer <token>'

Authorization

string

header

required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

string

required

The unique identifier of the mailbox to test.

Mailbox connection test succeeded.