PHPackages                             bespoke/improvmx - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. bespoke/improvmx

ActiveLibrary[Mail & Notifications](/categories/mail)

bespoke/improvmx
================

ImprovMX API client library for Laravel PHP

1.0.1(5y ago)41.4k1[1 issues](https://github.com/BespokeTechLabs/ImprovMX-PHP-Client/issues)MITPHP

Since Jan 28Pushed 5y agoCompare

[ Source](https://github.com/BespokeTechLabs/ImprovMX-PHP-Client)[ Packagist](https://packagist.org/packages/bespoke/improvmx)[ Docs](https://github.com/bespoke/improvmx)[ GitHub Sponsors](https://github.com/BespokeTechLabs)[ RSS](/packages/bespoke-improvmx/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (3)Used By (0)

ImprovMX API Client
===================

[](#improvmx-api-client)

This repo contains the source for a Laravel client library for the [ImprovMX API](https://improvmx.com/api/).

[![Software License](https://camo.githubusercontent.com/c090e080484e2a2bc766446291d04437db823929042bf614b26a1643660ddf6f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e3f7374796c653d666c61742d737175617265)](LICENSE)[![Packagist Downloads](https://camo.githubusercontent.com/994de1f23a7d151a7b4612700a5b8205cf3a11b72b84c7f6da6a9c145823b7d3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f626573706f6b652f696d70726f766d783f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bespoke/improvmx)[![Latest Version](https://camo.githubusercontent.com/2133d624bf157404aa921351e7600509204f3f0218d795fc7266329ddbe87aff/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f426573706f6b65546563684c6162732f496d70726f764d582d5048502d436c69656e743f7374796c653d666c61742d737175617265)](https://github.com/BespokeTachLabs/ImprovMX-PHP-Client/releases)

Check out the [change log](CHANGELOG.md), [releases](https://github.com/BespokeTechLabs/ImprovMX-PHP-Client/releases), [license](LICENSE), [code of conduct](.github/CODE_OF_CONDUCT.md), and [contribution guidelines](.github/CONTRIBUTING.md).

Installation
------------

[](#installation)

This version supports [PHP](https://php.net) 7.2-8.0. To get started, simply require the project into an existing Laravel application using [Composer](https://getcomposer.org).

```
composer require bespoke/improvmx
```

Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have `composer` installed.

The project has a service provider which is automatically configured in new versions of Laravel.

To get the project working, simply add your ImprovMX API key into your .env file.

`IMPROVMX_KEY=XXXXXXXXXXXXXX`

Getting Started
---------------

[](#getting-started)

The recommended method for using the ImprovMX client is to access it using the Laravel service provider.

This will construct your client automatically using the API key within your .env file.

```
$improvMx = new ImprovMx();
$client = $improvMx->client();
```

Alternatively, an ImprovMX client can be constructed manually.

```
$client = new Bespoke\ImprovMX\Client("INPUT_API_KEY_MANUALLY");
```

Once the client has been constructed, the API can be consumed as follows:

```
$client->account()->getAccountDetails();
$client->domains()->list();
```

Example Usage
-------------

[](#example-usage)

### Account

[](#account)

```
$improvMx = new ImprovMX();

// Return the Account entity.
$accountDetails = $improvMx->client()->account()->getAccountDetails();

// Return a collection of white-labelled domains.
$domains = $improvMx->client()->account()->getWhiteLabeledDomains();
```

### Domains

[](#domains)

```
$improvMx = new ImprovMX();

// Return a collection of Domain entities.
$domains = $improvMx->client()->domains()->list();

// Returns the newly created Domain entity or null (if failed to create).
$improvMx->client()->domains()->add("domain.com", "email@email.com", "whitelabel-domain.com");

// Return the Domain entity (or null).
$domain = $improvMx->client()->domains()->get("test.com");

// Update the details for a domain - returns the Domain entity or null.
$improvMx->client()->domains()->update("domain.com", "email@email.com", "whitelabel-domain.com");

// Returns delete successful - true or false.
$success = $improvMx->client()->domains()->delete("domain.com");

// Returns a RecordValidity entity.
$details = $improvMx->client()->domains()->checkDomainValidity("domain.com");
```

### Aliases

[](#aliases)

```
$improvMx = new ImprovMX();

// Return a collection of Alias entities for a domain.
$aliases = $improvMx->client()->aliases()->list("domain.com");

// This command sets up email forwarding from user@domain.com to forward@email.com.
// Returns the newly created Alias entity or null (if failed to create).
$improvMx->client()->aliases()->add("domain.com", "user", "forward@email.com");

// Return the Alias entity (or null) for a given alias e.g. (alias@domain.com).
$alias = $improvMx->client()->aliases()->get("domain.com", "alias");

// Update the forwarding address for an alias - returns the Alias entity or null.
$improvMx->client()->aliases()->update("domain.com", "alias", "forward@email.com");

// Returns delete successful - true or false.
$success = $improvMx->client()->aliases()->delete("domain.com", "alias");
```

### Logs

[](#logs)

```
$improvMx = new ImprovMX();

// Return a collection of Log entities for a domain.
$logs = $improvMx->client()->logs()->getDomainLogs("domain.com");

// Return a collection of Log entities for a domain's alias.
$logs = $improvMx->client()->logs()->getAliasLogs("domain.com", "alias");
```

### SMTP Credentials

[](#smtp-credentials)

```
$improvMx = new ImprovMX();

// Return a collection of Credential entities for a domain.
$credentials = $improvMx->client()->smtpCredentials()->list("domain.com");

// Add a new SMTP account for a domain (returns with the Credential entity or null).
$logs = $improvMx->client()->smtpCredentials()->add("domain.com", "username", "password");

// Update the password for an SMTP account (by username) - returns the Credential entity or null.
$improvMx->client()->smtpCredentials()->update("domain.com", "username", "newPassword");

// Returns delete successful - true or false.
$success = $improvMx->client()->smtpCredentials()->delete("domain.com", "username");
```

Security
--------

[](#security)

If you discover a security vulnerability within this package, please send an email to Bespoke Technology Labs at . All security vulnerabilities will be promptly addressed. You may view our full security policy [here](https://github.com/BespokeTechLabs/ImprovMX-PHP-Client/security/policy).

License
-------

[](#license)

The ImprovMX API Client Library is licensed under [The MIT License (MIT)](LICENSE).

Credits
-------

[](#credits)

- Lewis Smallwood - Bespoke Technology Labs

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance15

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

2

Last Release

1926d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b8a7c9feb80e74f5755caeb40812734360f9169c93b8309f09e739c1b7a41d6?d=identicon)[LewisSmallwood](/maintainers/LewisSmallwood)

![](https://www.gravatar.com/avatar/fb4ad9b4f38c006d05fc459003cbcf6ca239cb345aff7bacf6950d06f6efee9b?d=identicon)[bespoke](/maintainers/bespoke)

---

Top Contributors

[![LewisSmallwood](https://avatars.githubusercontent.com/u/1150414?v=4)](https://github.com/LewisSmallwood "LewisSmallwood (6 commits)")

---

Tags

phpapiclientlaravelemaillibraryforwardingImprovMX

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/bespoke-improvmx/health.svg)

```
[![Health](https://phpackages.com/badges/bespoke-improvmx/health.svg)](https://phpackages.com/packages/bespoke-improvmx)
```

###  Alternatives

[resend/resend-laravel

Resend for Laravel

1191.4M6](/packages/resend-resend-laravel)[hafael/azure-mailer-driver

Supercharge your Laravel or Symfony app with Microsoft Azure Communication Services (ACS)! Effortlessly add email, chat, voice, video, and telephony-over-IP for next-level communication. 🚀

14109.2k](/packages/hafael-azure-mailer-driver)[erag/laravel-disposable-email

A Laravel package to detect and block disposable email addresses.

226102.4k](/packages/erag-laravel-disposable-email)[princealikhan/laravel-mautic-api

Free and Open Source Marketing Automation API

415.9k](/packages/princealikhan-laravel-mautic-api)[martian/spammailchecker

A laravel package that protect users from entering non-existing/spam email addresses.

422.0k](/packages/martian-spammailchecker)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)