PHPackages                             rapidmail/rapidmail-apiv3-client-php - 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. [API Development](/categories/api)
4. /
5. rapidmail/rapidmail-apiv3-client-php

ActiveLibrary[API Development](/categories/api)

rapidmail/rapidmail-apiv3-client-php
====================================

rapidmail API v3 client

1.1.7(1y ago)6131.7k—9.3%91BSD-2-ClausePHPPHP ^5.6 || ^7.0 || ^8.0CI passing

Since Sep 25Pushed 5mo ago4 watchersCompare

[ Source](https://github.com/rapidmail/rapidmail-apiv3-client-php)[ Packagist](https://packagist.org/packages/rapidmail/rapidmail-apiv3-client-php)[ RSS](/packages/rapidmail-rapidmail-apiv3-client-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (17)Used By (1)

[![rapidmail Logo](https://avatars0.githubusercontent.com/u/25850436?v=3&s=50 "rapidmail Logo")](https://avatars0.githubusercontent.com/u/25850436?v=3&s=50) rapidmail APIv3 client
===================================================================================================================================================================================

[](#-rapidmail-apiv3-client)

API client written in PHP providing access to the current version of the [rapidmail](https://www.rapidmail.de) API.

[![CI Status](https://github.com/rapidmail/rapidmail-apiv3-client-php/workflows/CI/badge.svg)](https://github.com/rapidmail/rapidmail-apiv3-client-php/actions)[![Latest Stable Version](https://camo.githubusercontent.com/1adf6fca8a16fd2f49ae092e22d9cc237a75bd3ee3219ff634111467dd577661/68747470733a2f2f706f7365722e707567782e6f72672f72617069646d61696c2f72617069646d61696c2d61706976332d636c69656e742d7068702f762f737461626c65)](https://packagist.org/packages/rapidmail/rapidmail-apiv3-client-php)

Installation With Composer
--------------------------

[](#installation-with-composer)

Preferred installation method is to use the [Composer](https://getcomposer.org) dependency manager.

```
composer require rapidmail/rapidmail-apiv3-client-php
```

Getting started
---------------

[](#getting-started)

Create a new API client instance and provide your APIv3 credentials:

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

use Rapidmail\ApiClient\Client;

$client = new Client('api_username_hash', 'api_password_hash');
```

After that you can access various services encapsulated within the client:

```
$mailingService = $client->mailings();

// Iterate all mailings

foreach($mailingService->query() as $mailing) {
    var_dump($mailing);
}
```

Examples
--------

[](#examples)

### Retrieve mailings

[](#retrieve-mailings)

Get a list of your mailings with some filters applied:

```
// Filter for sent mailings newer than a given date

var_dump(
    $mailingService->query([
        'created_since' => '2019-09-01 10:22:00',
        'status' => 'sent'
    ])
);
```

### Retrieve recipient lists

[](#retrieve-recipient-lists)

```
$listService = $client->recipientlists();

foreach ($listService->query() as $list) {
    var_dump($list);
}
```

### Retrieve recipients

[](#retrieve-recipients)

```
$recipientsService = $client->recipients();

$collection = $recipientsService->query(
    [
        'recipientlist_id' => 123456789 // Recipientlist ID MUST be provided
    ]
);

foreach ($collection as $recipient) {
    var_dump($recipient);
}
```

### Create a new recipient

[](#create-a-new-recipient)

```
$recipientsService = $client->recipients();

var_dump(
    $recipientsService->create(
        // Dataset: Represents the recipient dataset you're creating
        [
            'recipientlist_id' => 123456789, // Required
            'email' => 'john@example.net', // Required
            'firstname' => 'John',
            'lastname' => 'Doe',
            'gender' => 'male'
        ],
        // Flags: Configures system behavior, like sending activationmails
        [
            'send_activationmail' => 'yes'
        ]
    )
);
```

Error handling
--------------

[](#error-handling)

Always keep in mind to handle errors properly and catch exceptions that might occur:

```
use \Rapidmail\ApiClient\Exception\ApiClientException;

try {
    $mailingService->query(['status' => 'unknown']);
} catch (ApiClientException $e) {
    // Catch API client exceptions
    echo "Exception raised: " . $e->getMessage();
}
```

Documentation
-------------

[](#documentation)

More information about using the API client can be found in the following subsections:

- [Available services](/docs/available-services.md)
- [Typed parameters](/docs/typed-parameters.md)

Known issues
------------

[](#known-issues)

1. Exceptions on 201 HTTP-Response-Code (used when a dataset was successfully created) are generated when using PHP Versions 7.4.5 and 8.1.2. If you're having issues with these versions, please try updating to a later version of PHP.
2. Client versions <1.1.7 do not work with guzzlehttp/guzzle 7.8+. Please upgrade to version 1.1.7 or later or downgrade your version of guzzlehttp/guzzle to 7.7.

Also refer to the [API documentation](https://developer.rapidmail.wiki/documentation.html) for a complete list of the available endpoints and their parameters.

License
-------

[](#license)

rapidmail APIv3 client is licensed under the terms of the [BSD 2-clause](LICENSE) license.

Support
-------

[](#support)

Contact: [www.rapidmail.de](https://www.rapidmail.de) -  - +49 761 - 55 77 55 77

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance57

Moderate activity, may be stable

Popularity41

Moderate usage in the ecosystem

Community19

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 91.9% 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 ~183 days

Recently: every ~113 days

Total

11

Last Release

588d ago

PHP version history (2 changes)1.0.0-betaPHP ^5.6 || ^7.0

1.1.0PHP ^5.6 || ^7.0 || ^8.0

### Community

Maintainers

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

---

Top Contributors

[![eth8505](https://avatars.githubusercontent.com/u/1136509?v=4)](https://github.com/eth8505 "eth8505 (34 commits)")[![mklewitz](https://avatars.githubusercontent.com/u/60610432?v=4)](https://github.com/mklewitz "mklewitz (1 commits)")[![rkrx](https://avatars.githubusercontent.com/u/5672982?v=4)](https://github.com/rkrx "rkrx (1 commits)")[![saitho](https://avatars.githubusercontent.com/u/7293310?v=4)](https://github.com/saitho "saitho (1 commits)")

---

Tags

apiapi-clientnewsletterrapidmail

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/rapidmail-rapidmail-apiv3-client-php/health.svg)

```
[![Health](https://phpackages.com/badges/rapidmail-rapidmail-apiv3-client-php/health.svg)](https://phpackages.com/packages/rapidmail-rapidmail-apiv3-client-php)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[saloonphp/saloon

Build beautiful API integrations and SDKs with Saloon

2.4k9.6M468](/packages/saloonphp-saloon)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k21](/packages/neuron-core-neuron-ai)[yoti/yoti-php-sdk

Yoti SDK for quickly integrating your PHP backend with Yoti

27539.9k1](/packages/yoti-yoti-php-sdk)[commercetools/commercetools-sdk

The official PHP SDK for the commercetools Composable Commerce APIs

19281.5k](/packages/commercetools-commercetools-sdk)

PHPackages © 2026

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