Download the PHP package elasticemail/elasticemail-php without Composer

Features

• Transactional and bulk email. Send single messages, bulk campaigns or CSV merge-file sends.
• Safe retries. Pass an Idempotency-Key to the send methods so a retried send is delivered and charged only once.
• Contacts, lists and segments. Add, update, import, export and bulk-delete contacts.
• Campaigns and automations. Create, update, pause and trigger automations for a contact.
• Templates, files and attachments. Manage templates and uploaded files.
• Domains. Verify sending domains and check SPF, DKIM, tracking and certificate status.
• Webhooks and inbound routes. Receive delivery events, optionally signed with HMAC-SHA256 and sent as JSON, and route incoming mail.
• Statistics, events and suppressions. Track delivery, bounces, complaints and unsubscribes.
• Subaccounts and security. Manage subaccounts and API keys.
• Sync and async. Every endpoint has a blocking method and an …Async method that returns a Guzzle promise.

Requirements

You'll also need an Elastic Email API key. You can create one in your API settings. Each endpoint's documentation lists the access level it needs.

Installation

Install the elasticemail/elasticemail-php package from Packagist with Composer:

Or add it to your composer.json:

Composer installs the dependencies (guzzlehttp/guzzle and guzzlehttp/psr7) for you. Then load Composer's autoloader:

Quick start

[!IMPORTANT] Elastic Email only sends from verified domains. Before your first send, verify your sending domain and use an address on that domain as the sender.

Configure the client

[!TIP] Keep your API key out of source code. Load it from an environment variable, a .env file kept out of version control or a secrets manager.

Send a transactional email

The from address must use a domain you've verified in your Elastic Email account.

Retry a send safely (Idempotency-Key)

Pass an Idempotency-Key to emailsPost, emailsTransactionalPost or emailsMergefilePost so a retry after a timeout or a dropped connection can't send the same email twice. If Elastic Email already processed the key, it returns the stored response (same TransactionID and MessageID, with an Idempotency-Replayed: true header) and sends nothing again.

Keys are kept for 24 hours per account, and a retry must send the same body: reusing a key with a different request returns 422. A 409 means the first request with that key is still running, and a 503 means the key couldn't be checked, so wait for Retry-After and retry with the same key. The header is optional, and sends without it work as before.

Send from a template with merge fields

Using a proxy

Pass any Guzzle options, such as a proxy or timeouts, to the HTTP client:

Create a signed webhook

Webhooks can sign every request with HMAC-SHA256 and send events as a POST with a JSON body. Both options are set when you create the webhook and can't be changed later. Webhooks created without them keep working as unsigned GET requests.

SigningSecret is returned only when the webhook is created and when you rotate it with webhookByPublicidSecretRotatePost, so store it right away. Each signed request carries X-ElasticEmail-Timestamp and X-ElasticEmail-Signature: v1=<hex>, where the signature is hex(HMAC-SHA256(secret, "{timestamp}\n{METHOD}\n{path and query}\n{raw body}")). Verify it against the raw body before you parse the JSON, reject timestamps more than 5 minutes old, and compare in constant time. The webhooks guide and the examples repository have ready-made handlers.

More examples

More complete, runnable samples are in the Elastic Email examples repository. It covers transactional email, SMTP, webhooks, inbound email, contacts and serverless platforms across 20+ languages and frameworks.

• 🐘 PHP examples
• 📂 All examples

This repository also includes short snippets for common tasks in examples/functions:

Authentication

API limits

• Up to 20 concurrent connections per account
• A hard timeout of 600 seconds per request

API reference

All URIs are relative to https://api.elasticemail.com/v4. The SDK covers 115 endpoints across 16 API classes: CampaignsApi, ContactsApi, DomainsApi, EmailsApi, EventsApi, FilesApi, InboundRouteApi, ListsApi, SecurityApi, SegmentsApi, StatisticsApi, SubAccountsApi, SuppressionsApi, TemplatesApi, VerificationsApi and WebhookApi.

Models

Tests

Versioning

The SDK follows the Elastic Email API v4. Package versions and release notes are listed on Packagist and in GitHub Releases.

Contributing

Contributions are welcome! Most of this SDK is generated from the Elastic Email OpenAPI specification by OpenAPI Generator, so please read CONTRIBUTING.md before opening a pull request.

• 🐛 Report a bug
• 💡 Request a feature
• 🔒 Report a security issue

This project follows the Contributor Covenant Code of Conduct.

Support

[!IMPORTANT] The fastest way to get help is the chat widget on elasticemail.com. Our support team can help with your account, sending, deliverability and API questions.

• 💬 Chat with support on elasticemail.com (preferred)
• 📚 API documentation
• 🧪 Examples repository
• 🐛 GitHub issues, for bugs in this SDK only

License

Released under the MIT License. Copyright © 2021–2026 Elastic Email.