TestConnectedInbox

POST

https://api.cbf.tcn.com/api/v0alpha/omniapi/testconnectedinbox

TestConnectedInbox - check if connected inbox login works for a specified email_address,
username, password, server_name, and server_port (other fields from ConnectedInbox are ignored).
Required permissions:
OMNI_BOSS

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "connected_inbox_sid": 0,
    "email_address": "string",
    "username": "string",
    "password": "string",
    "check_frequency_minutes": 0,
    "server_name": "string",
    "server_port": 0,
    "last_scheduled_time": "1s",
    "last_checked": "1s",
    "purge_threshold": 0,
    "email_salt": "string",
    "num_consecutive_failures": 0,
    "last_error": "string",
    "standby_error_time": "1s",
    "last_updated": "1s",
    "max_message_size": 0,
    "max_messages": 0,
    "google_xoauth2_refresh_token": "string",
    "google_xoauth2_access_token": "string",
    "google_xoauth2_access_token_expiration": "1s",
    "authentication_type": "CONNECTED_INBOX_AUTHENTICATION_TYPE_PASSWORD",
    "oauth_reference_id": {
        "access_token": "string",
        "refresh_token": "string",
        "expires_at": 0,
        "reference_id": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/omniapi/testconnectedinbox' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "connected_inbox_sid": 0,
    "email_address": "string",
    "username": "string",
    "password": "string",
    "check_frequency_minutes": 0,
    "server_name": "string",
    "server_port": 0,
    "last_scheduled_time": "1s",
    "last_checked": "1s",
    "purge_threshold": 0,
    "email_salt": "string",
    "num_consecutive_failures": 0,
    "last_error": "string",
    "standby_error_time": "1s",
    "last_updated": "1s",
    "max_message_size": 0,
    "max_messages": 0,
    "google_xoauth2_refresh_token": "string",
    "google_xoauth2_access_token": "string",
    "google_xoauth2_access_token_expiration": "1s",
    "authentication_type": "CONNECTED_INBOX_AUTHENTICATION_TYPE_PASSWORD",
    "oauth_reference_id": {
        "access_token": "string",
        "refresh_token": "string",
        "expires_at": 0,
        "reference_id": "string"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "success": true,
    "details": "string"
}

🟢200Success

Modified at 2025-09-26 15:44:58

ListConnectedInboxes

UpdateConnectedInbox