README

Sendmux Management API client for PHP.

Read the PHP SDK guide at docs.sendmux.ai/sdks/php.

Requirements

• PHP 8.2 or newer.
• Composer.
• A team-scoped API key with the smx_root_ prefix.

Installation

composer require sendmux/management:^1.0

Usage

Create the generated API group you need with a team-scoped key.

<?php

require __DIR__ . '/vendor/autoload.php';

use Sendmux\Management\ClientFactory;

$mailboxes = ClientFactory::createMailboxesApi(
    getenv('SENDMUX_ROOT_API_KEY') ?: ''
);

$domains = ClientFactory::createDomainsApi(
    getenv('SENDMUX_ROOT_API_KEY') ?: ''
);

$webhooks = ClientFactory::createWebhooksApi(
    getenv('SENDMUX_ROOT_API_KEY') ?: ''
);

The factory also exposes clients for billing, domain filters, emails, inboxes, mailbox filters, sending accounts, and webhooks.

Features

• Validates smx_root_ API keys before configuring the client.
• Uses https://app.sendmux.ai/api/v1 by default.
• Adds retry and rate-limit backoff behaviour through sendmux/core.
• Covers domains, sending accounts, mailboxes, filters, webhooks, logs, metrics, and billing data.
• Includes generated models for Management API requests and responses.

Related packages

Support

For help, include the package name, version, API surface, and sanitised request details. Do not include API keys, tokens, passwords, webhook secrets, customer data, or private account details.

• PHP SDK guide: docs.sendmux.ai/sdks/php
• Management API reference: docs.sendmux.ai/api/introduction
• API keys guide: docs.sendmux.ai/guides/api-keys
• Source repository: github.com/Sendmux/sendmux-sdk

License

MIT. See LICENSE.