Search by

qubrics / mailbox

roshanjonah

Qubrics Mailbox API client for PHP.

Package info

github.com/qubrics/qubrics-php-mailbox

pkg:composer/qubrics/mailbox

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 3

Dependents: 2

Suggesters: 0

Stars: 0

Open Issues: 0

v3.0.0 2026-11-06 00:41 UTC

Requires

Requires (Dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 534db204f23fd1cabab4d14ed4b9d9a7cfd78e6a

Published on Packagist.org on 2026-11-07 04:00 UTC

This package is auto-updated.

Last update: 2026-11-07 04:57:24 UTC

README

Packagist version PHP version License

Qubrics Mailbox API client for PHP.

Read the PHP SDK guide at qubrics.com/docs/sdks/php.

Requirements

  • PHP 8.2 or newer.
  • Composer.
  • A mailbox-scoped smx_mbx_ key or scoped smx_agent_ token. Alternatively, use a REST OAuth access token with the required scopes.

Installation

Run this command only after Packagist lists qubrics/mailbox version 3.0.0. Until then, retain your existing Composer constraint.

composer require qubrics/mailbox:^3.0

Before upgrading from 2.x, read the Mailbox 3.0 migration guide for changes-response return types, the distinct thread-message list response, and operation-specific metadata getter/setter types. Update typed wrappers and manually constructed metadata. If you use 1.x, apply the PHP 2.0 migration guide first.

If your custom Guzzle client uses FileCookieJar or SessionCookieJar, back up its state and re-authenticate into a fresh jar when upgrading. Guzzle rejects old records without a boolean HostOnly; do not guess that value. Default Qubrics API clients do not enable cookies. See the upstream migration warning.

Usage

Create the Mailbox API client with a mailbox-scoped key or scoped agent token.

<?php

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

use Qubrics\Mailbox\ClientFactory;

$mailboxApi = ClientFactory::createMailboxAPIApi(
    getenv('QUBRICS_MAILBOX_API_KEY') ?: getenv('SENDMUX_MAILBOX_API_KEY') ?: null
);

Use $mailboxApi->mailboxGetConnection() to test credentials without selecting a target mailbox.

The generated MailboxAPIApi exposes mailbox methods such as mailboxGetMe(), mailboxListMessages(), mailboxSendMessage(), and mailboxUploadAttachment().

Attachments and events

Message and event attachment metadata includes download_url, a short-lived presigned URL for that single attachment. Fetch it promptly with a plain HTTP client and no Authorization header. If it expires, re-fetch the message or attachment metadata to receive a fresh URL.

Use mailboxUploadAttachment() to upload bytes and pass the returned blob_id into mailboxSendMessage() attachments. Inline base64 attachments remain available in the generated send body shape for small payloads.

mailboxStreamEvents() exposes the Mailbox SSE endpoint for clients that want live message.received events.

OAuth access tokens

ClientFactory::createMailboxAPIApiWithAccessToken($accessToken) accepts a bare token or a callable returning one. Every API group factory has the same WithAccessToken variant. Providers run on each request and retry; your application owns token storage and refresh coordination. OAuth clients do not follow redirects.

$client = ClientFactory::createMailboxAPIApiWithAccessToken(
    static fn (): string => getenv('QUBRICS_ACCESS_TOKEN') ?: getenv('SENDMUX_ACCESS_TOKEN') ?: ''
);

See OAuth setup and lifecycle.

For API-key authentication, omit apiKey to read QUBRICS_API_KEY. Omit baseUrl to read QUBRICS_BASE_URL. Nonempty Qubrics values take precedence over SENDMUX_API_KEY and SENDMUX_BASE_URL. Explicit arguments take precedence over environment values.

Features

  • Validates smx_mbx_ keys or scoped smx_agent_ tokens before configuring the client.
  • Uses https://app.qubrics.com/api/v1 by default.
  • Adds retry and rate-limit backoff behaviour through qubrics/core.
  • Covers mailbox identity, folders, messages, attachments, submissions, threads, quota, usage, and event streams.
  • Includes generated models for Mailbox API requests and responses.

Related packages

Package Use it for
qubrics/core Shared helpers for auth, headers, retries, pagination, and errors.
qubrics/sending Sending API client.
qubrics/management Management API client.
qubrics/sdk Umbrella package that installs all PHP SDK surfaces.

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.

License

MIT. See LICENSE.