Download the PHP package mosaiqo/mailer-php without Composer

Mailer PHP SDK

Official PHP SDK for the Mailer REST API v1. It wraps the transactional send, contacts, lists, tags, templates, messages and campaigns endpoints behind typed resources and readonly DTOs, with first-class error handling and idempotency support — plus an optional, batteries-included Laravel integration.

⚠️ Read-only mirror. This repo is an automated split of the SDK from a private monorepo. Do not open pull requests here — they can't be merged (the mirror is force-pushed) and will be auto-closed. Found a bug or have a request? Open an issue (see CONTRIBUTING).

🤖 Integrating with an AI agent? Start with AGENTS.md — a terse, imperative integration playbook with the human-gate steps called out. This README is the full human reference.

Features

• Typed resources + readonly DTOs over the full Mailer API v1 surface (send, contacts, lists, tags, templates, messages, read-only campaigns).
• A precise exception hierarchy with machine code branching.
• Automatic, idempotency-safe retries with exponential backoff.
• Lazy pagination via cursor() generators (no page bookkeeping).
• Per-send idempotency keys to make retries duplicate-free.
• Optional Laravel integration (auto-discovered): a mailer mail transport, a mailer notification channel and a Mailer facade.
• Zero required dependencies beyond Guzzle; the core works in plain PHP without any Illuminate package installed.

Requirements

• PHP >= 8.3
• guzzlehttp/guzzle ^7 (the only runtime dependency)
• Laravel ^11.0 || ^12.0 || ^13.0 — optional, only for the Laravel integration (mail transport, notification channel, facade). The core SDK runs fine without it.

Installation

The package is published on Packagist — require it directly with Composer, no repository entry or Git/SSH access needed:

Path repository (monorepo development)

When developing inside the Mailer monorepo, point Composer at the package directory with a path repository:

Quick start: integrate into a Laravel app

The full, copy-pasteable recipe to route a real Laravel app's email through a mailer-app instance. (Detailed behavior and options are documented further down.)

1. Require the package (published on Packagist):

2. Set the environment variables.

Where to get the API key. In mailer-app, open Settings → API keys for the project you want to send from and create a key (it is shown once — copy it straight into MAILER_API_TOKEN). Keys are per project, so the key also selects which project's sender, templates and contacts the sends use.

3. Add the mailer mailer to config/mail.php.

4. Send. Nothing else in your mailing code changes:

Or call the API client directly — e.g. to render a stored template by slug with per-recipient variables:

That is the whole integration. The rest of this document covers the SDK's full surface and the transport's detailed behavior.

Plain PHP usage

Batch sends

No attachments in batches. /send/batch rejects messages.*.attachments with a 422 — attachments are single-send only. Call send()->email() per recipient instead (the Laravel mail transport does this fan-out for you).

Notifications (in-app & push)

Send a notification to a contact over one or more channels. Without a channels key the SDK sends in_app; pass channels to fan out (e.g. in-app and push):

Per-channel failures are data, not exceptions. Each requested channel comes back as a NotificationChannelResult, so one channel failing never aborts the others — and when no channel can be queued (the API replies 422 with the same envelope) you still get a NotificationResult (anyQueued() is false) rather than a thrown exception. A real validation error (missing title, etc.) still throws ValidationException.

Push prerequisites: the project must have a push provider configured and the contact must have at least one registered device token (see below).

Push device tokens

Register and remove the device tokens push notifications are delivered to. The contact is upserted with transactional semantics (no double opt-in):

The platform is the native device platform: ios or android. This endpoint registers native FCM device tokens only — web push uses a separate VAPID subscription flow, so web is not accepted here (passing it yields a 422).

Registering a token already owned by another contact in the project moves it to this contact; a contact is capped at 20 devices (the oldest is evicted past the cap). Removing a token from an unknown contact raises a NotFoundException (contact_not_found).

Idempotency

email() and batch() accept a named idempotencyKey argument, sent as the Idempotency-Key header. Re-sending with the same key returns the original result instead of creating a duplicate. While the first request is still in flight a concurrent retry with the same key gets a 409 — surfaced as a base MailerException with code idempotency_conflict; an empty or over-long key is rejected with a 422 ValidationException (code invalid_idempotency_key).

Other resources

The campaigns resource is intentionally read-only: it never sends or schedules a campaign. Trigger mass sends from the dashboard, not the SDK.

Paginated endpoints return a Paginated DTO exposing ->data (mapped DTOs), ->meta and ->links. The tags endpoint returns a flat Tag[] array.

Automatic pagination

Paginated resources also expose a cursor() generator that lazily walks every page for you, fetching one page at a time and yielding each mapped DTO. You never track page numbers — just iterate:

A cursor() returns a plain \Generator (the core SDK never depends on Illuminate). In a Laravel app you can wrap it in a LazyCollection to use the collection pipeline:

Resilience (automatic retries)

When you let the SDK build its own HTTP client (the default — you do not inject a Guzzle client), it installs an automatic retry middleware with exponential backoff.

• What is retried: network/connection errors, 5xx responses, and 429 rate-limit responses.
• Idempotency safety: only requests that are safe to repeat are retried — GET/HEAD/OPTIONS/PUT/DELETE, or any request that carries an Idempotency-Key header. A POST/PATCH without an Idempotency-Key (e.g. an email()/batch() send made without idempotencyKey:) is never retried, so the transport can never duplicate a send. Pass an idempotency key to make sends retry-safe.
• Retry-After: on a 429, the Retry-After header is honored (numeric seconds or an HTTP-date); otherwise the delay is exponential (min(retry_max_delay, retry_base_delay * 2 ^ attempt), no jitter).

Tune it through the optional options argument (4th constructor parameter):

When you inject your own Guzzle client it is used as-is — add the retry middleware yourself via Mailer\Sdk\Http\RetryMiddleware::make() if you want it.

Error handling

Every non-2xx response is mapped to a typed exception. All exceptions extend Mailer\Sdk\Exception\MailerException and expose:

• getErrorCode(): ?string — the machine code field
• getStatus(): ?int — the HTTP status
• getBody(): ?array — the raw decoded response envelope
• getMessage(): string — the human-facing message (standard \Exception)

Testing with the sandbox

A sandbox project lets your CI exercise the real send pipeline without touching production data or real inboxes. The API token is the routing: a sandbox token quietly captures everything it sends and unlocks the event simulator; a production token can't even see the simulator (it gets a bare 404). So the same code under test only needs a different MAILER_API_TOKEN.

The recipe is: send → read it back from messages() (the sandbox inbox) → simulate an event → assert.

Notes and safety properties:

• Webhooks fire for real, flagged "sandbox": true. Outbound webhooks triggered by simulated events carry a "sandbox": true marker so your endpoint can tell test traffic apart.
• Simulated bounces suppress only inside the sandbox. A hard_bounce / complaint you simulate adds the address to the sandbox project's suppression list — it never contaminates production suppression or the shared platform reputation.
• The simulator is invisible to production tokens. simulate() with a production token gets a bare 404 (a NotFoundException with no error code), so a mis-pointed token fails loudly instead of mutating real data.

Laravel integration

The package is auto-discovered (no manual provider/alias registration). It registers a container-bound MailerClient singleton, a Mailer facade, a mailer mail transport and a mailer notification channel — all driven by the same mailer-sdk config.

Configuration

Publish the config file:

Then set the env vars (every key below maps to config/mailer-sdk.php):

Resolve the client from the container:

The resilience knobs (MAILER_TIMEOUT, MAILER_RETRIES, MAILER_RETRY_BASE_DELAY, MAILER_RETRY_MAX_DELAY) are wired into the container-bound client automatically.

Connection config. MAILER_API_TOKEN is required — an empty token throws a Mailer\Sdk\Exception\MailerConfigurationException at construction. MAILER_BASE_URL is optional: it defaults to the hosted API (https://mailer.mosaiqo.com/api/v1), so hosted users only set the token; self-hosted users override it. An explicitly empty or api.mailer.test placeholder base URL still throws, instead of silently sending to a dead host.

Mail transport (MAIL_MAILER=mailer)

The package registers a mailer mail driver, so you can route Laravel's Mail facade (and notifications, queued mailers, etc.) through the platform /send API without changing any mailing code.

Add a mailer entry to config/mail.php:

and select it:

Now every send flows through the API:

The transport maps the message to a single /send call (one recipient) or a /send/batch call (multiple recipients), reading the subject, HTML body and text body off the message.

Sending with a stored template

To render a platform template by slug instead of inline HTML, set the template headers on the underlying Symfony message from your Mailable. The transport then sends a template payload ({to, template, variables}) and ignores the inline subject/body:

Attachments

Attachments on a Mailable / Symfony message are mapped onto the /send attachments field and delivered by the platform. The behavior is driven by mailer-sdk.mail.attachments (env MAILER_MAIL_ATTACHMENTS):

Platform limits (validated server-side, one guard duplicated client-side):

• Max 10 files per send, 10 MB decoded per file and ~10 MB decoded total per send. The SDK checks the total before uploading and throws a local Mailer\Sdk\Exception\AttachmentsTooLargeException (error code attachments_too_large — the same code the server's 422 carries), so an oversized send fails fast instead of uploading megabytes of base64 first. Per-file size, filename and content-type validation stay server-side.
• Executable filename extensions are rejected by the API with a 422 field error (.exe, .bat, .cmd, .com, .cpl, .dll, .jar, .js, .jse, .lnk, .msi, .pif, .scr, .vbs, .vbe, .wsf, .wsh, .ps1, .msc, .hta, .reg), as are filenames with path separators or control characters.
• Batch sends: the /send/batch endpoint rejects attachments (single-send only), so a multi-recipient message carrying attachments is automatically fanned out as per-recipient single /send calls. Each fan-out send gets its own per-recipient idempotency key (attachments hash into the content key), so a requeued job still dedupes; an explicit X-Mailer-Idempotency-Key is derived per recipient ({key}:{sha1(recipient) prefix}) for the same reason. Expect N API calls (and N ratelimit slots) instead of one batch call.

Behavior & limitations

The platform /send API is intentionally narrow; the transport adapts to it with explicit, documented behavior rather than silent surprises.

• From / Reply-To are ignored. The API does not accept from or reply_to — the platform always uses the project's configured sender (set the project default_from_email/default_from_name and a verified sending domain in the dashboard). A From set on the message is logged at debug level and dropped.
• Attachments are sent by default. They are mapped onto the /send attachments field (see Attachments above for modes, limits, the filename blocklist and the batch fan-out). Consumers who relied on the old fail-loud behavior must set mailer-sdk.mail.attachments = 'fail' explicitly; 'ignore' still drops them with a warning — never silently.
• Suppressed recipients are not failures. When the platform rejects an address as suppressed (recipient_suppressed), the transport does not throw: it logs a warning and dispatches a Mailer\Sdk\Laravel\Events\MessageSuppressed event (carrying the recipient email and reason). In a batch send, each suppressed recipient gets its own event while the rest are delivered. Listen for the event to prune your lists.
• Quota / sending-domain rejections are failures. quota_exceeded and sending_domain_not_verified (and any other unexpected API error) are re-thrown as a Symfony\Component\Mailer\Exception\TransportException with the SDK exception kept as previous, so Laravel's mailer/queue treats the send as failed and can retry per your own policy. A batch send throws if any recipient hard-fails, summarizing the failed recipients.
• Multiple recipients become a batch. To + Cc + Bcc are merged into the delivery list; each recipient is sent its own copy via /send/batch (the message content is shared, the to differs per item). Exception: a message carrying attachments fans out as per-recipient single /send calls, because the batch endpoint rejects attachments (see Attachments above).
• Idempotency is automatic and retry-safe. Per send the transport sets an Idempotency-Key derived from mailer-sdk.mail.idempotency (env MAILER_MAIL_IDEMPOTENCY):
  • content (default): a deterministic hash of the message content, so a requeued job never duplicates the send. Two genuinely identical messages sent within the platform's idempotency window dedup — switch to random if that is not what you want.
  • random: a fresh UUID per send attempt (no dedup).
  • off: no key. Override per message with the X-Mailer-Idempotency-Key (MailerHeaders::IDEMPOTENCY_KEY) header.

Notification channel

The SDK also registers a mailer notification channel, so a Notification can deliver through the platform /send API by returning ['mailer'] from via() and defining toMailer($notifiable).

toMailer() returns a Mailer\Sdk\Laravel\Mail\MailerMessage for full control. Inline mode uses subject()/html()/text():

Template mode renders a stored template with per-recipient variables:

Recipient routing precedence: an explicit MailerMessage::to() wins, then routeNotificationFor('mailer'), then routeNotificationFor('mail'), then a public $email property on the notifiable.

Other return types are accepted too: a plain /send payload array is used directly (its to/idempotency_key keys are honored, and an attachments key passes through to the API — see Attachments above for shape and limits), and an Illuminate\Contracts\Mail\Mailable is rendered to its subject + HTML only (its attachments are NOT carried over) — return a MailerMessage for templates, a text part or an explicit idempotency key, or the array form for attachments.

The outcome semantics mirror the transport: a suppressed recipient is not a failure — a Mailer\Sdk\Laravel\Events\MessageSuppressed event is dispatched and the send is skipped — while quota / sending-domain / any other API error is rethrown so Laravel marks the notification failed and retries per your queue policy.

A complete notification:

Facade

The package registers a Mailer facade (auto-registered via package discovery) that proxies the same container-bound MailerClient singleton — no separate configuration is needed:

Contributing / Development

Tests run entirely against a Guzzle MockHandler — no network access required.

For how this package is split out of the monorepo into its own repository, tagged with SemVer and published to Packagist, see PUBLISHING.md.