PHPackages                             alfredo-ramos/mailrelay-api-client - 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. alfredo-ramos/mailrelay-api-client

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

alfredo-ramos/mailrelay-api-client
==================================

Mailrelay API Client

0.2.1(10mo ago)05.0k1GPL-3.0-or-laterPHPPHP ^7.2.5 || ^8.0.0CI passing

Since Apr 2Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/AlfredoRamos/mailrelay-api-client)[ Packagist](https://packagist.org/packages/alfredo-ramos/mailrelay-api-client)[ Docs](https://github.com/AlfredoRamos/mailrelay-api-client)[ Fund](https://alfredoramos.mx/donate/)[ RSS](/packages/alfredo-ramos-mailrelay-api-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (6)Used By (0)

### About

[](#about)

A [Mailrelay](https://mailrelay.com) API client.

[![Build Status](https://camo.githubusercontent.com/be9b74bd2616165e48a04211967fc62eb4d505b514a91aebc6da30d606bb02ef/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f416c667265646f52616d6f732f6d61696c72656c61792d6170692d636c69656e742f63692e796d6c3f7374796c653d666c61742d737175617265)](https://github.com/AlfredoRamos/mailrelay-api-client/actions)[![Latest Stable Version](https://camo.githubusercontent.com/1841bffc4ea66bc78ec946f4a817b984c7f03068f946bcd107adb9f498b0a5af/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c667265646f2d72616d6f732f6d61696c72656c61792d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265266c6162656c3d737461626c65)](https://packagist.org/packages/alfredo-ramos/mailrelay-api-client)[![Code Quality](https://camo.githubusercontent.com/a0eae0eba8bf13212dfc0d3f67be56a21973793bba0c190703da06d5b0606f93/68747470733a2f2f696d672e736869656c64732e696f2f636f646163792f67726164652f66363630336135373238626134396535383536623730326431353938386465652e7376673f7374796c653d666c61742d737175617265)](https://app.codacy.com/gh/AlfredoRamos/mailrelay-api-client/dashboard)[![License](https://camo.githubusercontent.com/29c2d3b9f8c5b9d9dca3c806db4327ac2bebcac94ee8f14f52660c8a8d1eeda5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f616c667265646f2d72616d6f732f6d61696c72656c61792d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://raw.githubusercontent.com/AlfredoRamos/mailrelay-api-client/master/LICENSE)

> ⚠️ **While all API endpoints have been implemented, it's still under development, so it might have some bugs.**

### Requirements

[](#requirements)

- PHP 8.1.0 or greater

### Installation

[](#installation)

Open your `composer.json` file and add the package in the `require` object:

```
"alfredo-ramos/mailrelay-api-client": "^0.3.0"
```

Then run `composer update` on your terminal.

### Usage

[](#usage)

The constructor takes an `array` with the API data needed to connect with your Mailrelay account.

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

$mailrelay = new AlfredoRamos\Mailrelay\Client([
	'api_account' => 'mailrelay_account',
	'api_token' => 'mailrelay_api_token'
]);
```

KeyTypeRequiredDescription`api_account``string`YesThe account name you use to login into Mailrelay.`api_token``string`YesThe Mailrelay API token generated from `https://{ACCOUNT}.ipzmarketing.com/admin/api_keys`.You can access each endpoint using the `AlfredoRamos\Mailrelay\Client::api()` method.

```
// Create or update a subscriber
$mailrelay->api('subscribers')->sync([
	'status' => 'active',
	'email' => 'user@example.org',
	'group_ids' => [1]
]);

// Get account package info
$mailrelay->api('package')->info();
```

To get the number of total pages and results per page for `list()` methods:

```
$result = $this->client->withOptions(['full_response' => true])->api('subscribers')->list([
	'page' => 1, 'per_page' => 10
]);
$subscribers = $result->toArray();
$total = $result->totalPages();
$perPage = $result->perPage();
```

For more detailed information about Mailrelay API endpoints, please refer to the [official API documentation](https://apidocs.mailrelay.com).

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance64

Regular maintenance activity

Popularity23

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 86.7% 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 ~517 days

Total

4

Last Release

322d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4165935?v=4)[Alfredo Ramos](/maintainers/AlfredoRamos)[@AlfredoRamos](https://github.com/AlfredoRamos)

---

Top Contributors

[![AlfredoRamos](https://avatars.githubusercontent.com/u/4165935?v=4)](https://github.com/AlfredoRamos "AlfredoRamos (72 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (4 commits)")

---

Tags

emailemail-marketingmailrelaymailrelay-apiapiclientemailmailrelay

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/alfredo-ramos-mailrelay-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/alfredo-ramos-mailrelay-api-client/health.svg)](https://phpackages.com/packages/alfredo-ramos-mailrelay-api-client)
```

###  Alternatives

[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)

PHPackages © 2026

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