Download the PHP package misarai/misarmail-php without Composer

On this page you can find all versions of the php package misarai/misarmail-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of misarai/misarmail-php

Informations about the package misarmail-php

MisarMail PHP SDK

Send transactional email and run marketing campaigns from PHP — one client, ext-curl and ext-json only.

Packagist php

33 resource groups · 90 methods · SSE streaming · typed plan-limit errors

MisarMail is one API for both halves of your email: the receipts and password resets your product sends, and the campaigns, segments and automations your marketing team runs on the same contact list and the same verified domains.

PHP 8.1+, with nothing but ext-curl and ext-json underneath. Requests take plain associative arrays and every method returns a decoded array — no DTOs to learn.

Install

Composer

composer.json

Authentication

Create a developer key at https://mail.misar.io/developers. It starts with msk_ and is sent as Authorization: Bearer msk_….

Every call is metered against the subscription attached to that key. There is no client-side limit checking — the server decides, and the SDK surfaces its answer. A plan refusal answers 403 with code: "plan_limit_exceeded" and is never retried.

Resources

Every group the client exposes, and every public method on it.

Send

Resource Methods What it covers
$mail->email send Transactional send — cc/bcc/reply-to, tags, metadata, idempotency_key.
$mail->sandbox send, list, delete Test sends captured instead of delivered.

Campaigns and tests

Resource Methods What it covers
$mail->campaigns list, create, get, update, send, delete Marketing campaigns: draft, edit, queue for send.
$mail->abTests list, create, get, setWinner Subject, content, send-time, from-name and preheader splits, and winner selection.

Audience

Resource Methods What it covers
$mail->contacts list, create, get, update, delete, import Subscribers, plus bulk import.
$mail->segments members Dynamic audience segments and their membership.
$mail->landingPages create Hosted landing pages with an email capture form.

Content

Resource Methods What it covers
$mail->templates list, create, get, update, delete, render Reusable templates and server-side variable rendering.
$mail->ai subjectLines AI-generated subject lines.

Automations

Resource Methods What it covers
$mail->automations list, create, get, update, delete, activate Trigger-based workflows — welcome series, drips, re-engagement.

Deliverability and sending infrastructure

Resource Methods What it covers
$mail->domains list, create, get, verify, delete Sending domains and their DNS verification.
$mail->dmarc check, listDomains, addDomain, removeDomain Live SPF/DKIM/DMARC record checks and monitored domains.
$mail->deliverability audit, score Deliverability score, audit and remediation guidance.
$mail->dedicatedIps list, create, update, delete Dedicated sending IPs.
$mail->warmup get IP/domain warm-up progress and today's remaining capacity.
$mail->inbound list, create, get, delete Inbound routing domains, so replies land in the unified inbox.

Mailbox and inbox

Resource Methods What it covers
$mail->emails list, get, update Stored messages in the mailbox.
$mail->emailAccounts list Connected mailbox accounts.

Analytics and attribution

Resource Methods What it covers
$mail->analytics overview Delivery and engagement stats — aggregate, or one campaign.
$mail->track event, purchase Custom events and ecommerce purchases.
$mail->revenue attribution Revenue attributed back to email.
$mail->usage get Metered usage for a period.

Validation

Resource Methods What it covers
$mail->validate email Address validation, and the credit balance behind it.

Plan, billing and credits

Resource Methods What it covers
$mail->plan get, monetization Current plan, quotas and monetization stats.
$mail->billing subscription, checkout Subscription state and checkout.
$mail->subscription get, upsert, cancel Subscription read/write and per-product plan limits.
$mail->wallet get, credit, debit Credit balance, credit and debit.
$mail->creditRates list What each metered action costs in credits.
$mail->teamMembers get Team members on the account.
$mail->monetization tip Newsletter tips.

Developer

Resource Methods What it covers
$mail->keys list, create, get, revoke API keys — create, list, revoke.
$mail->webhooks list, create, get, update, delete, test Webhook endpoints, plus a test delivery.
$mail->streaming generateEmail, campaignSend The two Server-Sent Events endpoints.

Client

Thing Detail
Entry point new MisarMail\Client($apiKey, $timeout = 30, $baseUrl = null) — every resource is a readonly property.
$baseUrl / $apiBase https://api.misar.io/mail/v1 and the derived base for routes outside /v1; both readable on the client.
Results A decoded array. 204/empty comes back as [].
Transport cURL, 10-second connect timeout, $timeout for the rest.
Retried 429, 500, 502, 503, 504 and cURL failures — 3 attempts, 300 ms then 600 ms.
Never retried Plan refusals, and streams.
Errors MisarMail\ApiError, with NetworkError and PlanLimitError extending it.
Webhook verifier Not shipped here — verify HMAC-SHA256(timestamp . "." . rawBody) yourself with hash_hmac() and hash_equals(). (Go, Python, Ruby and Dart ship one.)
Escape hatch $mail->request($method, $path, $data, $baseOverride) is public.

Quick start

Primary functions

Send a transactional email

from is a single address array and to is a list of them. Pass an idempotency_key and a retry can never send twice — the response comes back with idempotent: true the second time.

List and create contacts

Responses are enveloped. list() returns ['success', 'data', 'pagination'] and takes page/limit as named integers, not an options array; create() returns ['success', 'data'] with the contact under data.

get() and delete() take the contact id, which the route reads from the query string rather than a path segment. update() is different again: it identifies the contact by email address, not by id.

Bulk import contacts

Counts come back under summary, and errors is a separate list of messages.

Create and send a campaign

Campaigns take fromName and fromEmail as separate fields — there is no from array here, unlike email->send(). send() queues the campaign and reports it as scheduled.

Only draft, scheduled or paused campaigns can be updated, and only draft campaigns can be deleted.

Validate an address

Each call spends a credit, and the response tells you what is left.

Render a template

Track events and revenue

The event name field is event_name, and purchase totals are integer cents in total_cents.

Read analytics and manage keys

Without campaignId you get aggregate usage and totals for the period; with one you get that campaign's stats and rates. keys->list() returns the keys under keys, not data, and create() returns the raw key exactly once.

Errors

Three classes, all in the MisarMail namespace:

Class When
ApiError Any non-2xx API response. Carries $status. Extends RuntimeException.
NetworkError cURL never got an answer, or every retry was spent. $status is 0.
PlanLimitError The subscription behind the key does not cover the call.

NetworkError and PlanLimitError both extend ApiError, so catch (MisarMail\ApiError $e) catches everything the SDK throws.

Plan limits

Both a spent allowance and a feature that is not on the plan answer 403, carrying code: "plan_limit_exceeded". The SDK keys on that code rather than the status, which is why a refusal is typed correctly even though 403 is otherwise an authorization failure. It throws PlanLimitError and does not retry — retrying cannot help until the allowance resets or the plan changes. Read $upgradeUrl to send the user somewhere useful.

$mail->plan->get() returns plan, sending (the per-day and per-month email caps), usage — an array with one entry per metered feature, each carrying used, limit and remaining — and upgrade, which is null until a quota is tight. A null limit means unlimited, and remaining is null alongside it rather than 0. Read it before an expensive call rather than discovering the ceiling through a refusal.

The key needs the read or subscription scope.

Streaming

Two endpoints stream Server-Sent Events. Both sit outside /v1, which the SDK handles for you:

Method Route
streaming->generateEmail() POST /api/ai/generate-email/stream
streaming->campaignSend() GET /api/campaigns/{id}/send-stream

PHP has no async iterator here, so both take a callback and block until the stream ends. Return false from the callback to stop early. Frames are unnamed (data: {…}, with no event: line) and the stream ends with data: [DONE], which the SDK consumes rather than handing on. Each StreamEvent carries $event (normally null), $data (the decoded array, or null when the payload was not JSON) and $raw. A stream is never retried: replaying one that failed mid-flight would duplicate whatever you had already read.

Links

MIT © Misar AI

All versions of misarmail-php with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package misarai/misarmail-php contains the following files

Loading the files please wait ...