Skip to content
calternal docs

Test a Mail account connection

POST
/api/v1/mail/accounts/test
curl --request POST \
  --url https://example.com/api/v1/mail/accounts/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "app_password": "example", "email": "example", "imap_host": "example", "imap_port": 1, "imap_tls_mode": "implicit", "provider": "gmail", "smtp_app_password": "example", "smtp_host": "example", "smtp_port": 1, "smtp_tls_mode": "implicit", "smtp_username": "example", "username": "example" }'

Requires a signed-in User. It checks the IMAP settings and credentials without saving an account. It returns 400 for invalid settings, or a provider error when the connection check fails. Route: /api/v1/mail/accounts/test. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
app_password
required
string
email
required
string
imap_host
required
string
imap_port
required
integer format: int32
imap_tls_mode
required

IMAP transport mode. Cleartext authentication is never allowed.

string
Allowed values: implicit starttls
provider
required
string
Allowed values: gmail icloud fastmail custom
smtp_app_password
string | null
smtp_host
required
string
smtp_port
required
integer format: int32
smtp_tls_mode
required

IMAP transport mode. Cleartext authentication is never allowed.

string
Allowed values: implicit starttls
smtp_username
required
string
username
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
imap_authenticated
required
boolean
selectable_folder_count
required
integer
Examplegenerated
{
  "imap_authenticated": true,
  "selectable_folder_count": 1
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

424

Section titled “424”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

502

Section titled “502”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

504

Section titled “504”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}