README

Umbrella package for Sendmux PHP SDK clients.

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

Requirements

• PHP 8.2 or newer.
• Composer.
• A Sendmux API key for each API surface you call.

Installation

composer require sendmux/sdk:^1.0

Usage

The umbrella package installs the core, sending, mailbox, and management packages together. Create clients through the surface package factories.

<?php

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

use Sendmux\Mailbox\ClientFactory as MailboxFactory;
use Sendmux\Management\ClientFactory as ManagementFactory;
use Sendmux\Sending\ClientFactory as SendingFactory;

$sending = SendingFactory::createEmailsApi(
    getenv('SENDMUX_MAILBOX_API_KEY') ?: ''
);

$mailbox = MailboxFactory::createMailboxAPIApi(
    getenv('SENDMUX_MAILBOX_API_KEY') ?: ''
);

$management = ManagementFactory::createMailboxesApi(
    getenv('SENDMUX_ROOT_API_KEY') ?: ''
);

Note

sendmux/sdk installs all PHP SDK surfaces. It does not replace the surface factories.

Included packages

The package also exposes Sendmux\Sdk\Sdk::VERSION for package-version checks.

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
• Sending API reference: docs.sendmux.ai/sending-api/introduction
• Mailbox API reference: docs.sendmux.ai/mailbox-api/introduction
• 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.