sendmux-management

Generated Python client for the Sendmux Management API.

Documentation

• Management API reference: sendmux.ai/docs/api/introduction
• Source repository: Sendmux/sendmux-sdk

Requirements

• Python 3.10 or newer.
• A root Sendmux API key with the smx_root_* prefix.

For OAuth, use a REST access token with the scopes and mailbox access required by the operation. See OAuth for REST APIs.

Installation

pip install sendmux-management

OAuth access tokens

Pass either api_key or access_token. access_token accepts a bare token string or a synchronous callable; the callable is evaluated for each authenticated request. Your application owns token storage, expiry checks and refresh coordination.

import os

from sendmux_management import create_management_client

client = create_management_client(
    access_token=lambda: os.environ["SENDMUX_ACCESS_TOKEN"]
)

Usage

import os

from sendmux_management import DomainsApi, create_management_client

client = create_management_client(api_key=os.environ["SENDMUX_MANAGEMENT_API_KEY"])
api = DomainsApi(client)

domains = api.management_list_domains(limit=25)

for domain in domains.data:
    print(domain.id, domain.domain)

The package exports every generated Management model and API class plus:

• create_management_client
• configure_management
• SendmuxManagementApiClient

Conditional requests

Generated methods expose ETag parameters directly when the API operation supports them.

import os

from sendmux_management import DomainsApi, create_management_client

client = create_management_client(api_key=os.environ["SENDMUX_MANAGEMENT_API_KEY"])
api = DomainsApi(client)

domain = api.management_get_domain(
    public_id="mdom_123",
    if_none_match='W/"etag"',
)

print(domain.data)

Support

Open an issue in Sendmux/sendmux-sdk with the package name, version, and request ID from any API error.

Licence

MIT. See the licence file.