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.8(4mo ago)6153.9k↓60.3%101BSD-2-ClausePHPPHP ^5.6 || ^7.0 || ^8.0CI failing

Since Sep 25Pushed 4mo 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 2w ago

READMEChangelog (10)Dependencies (8)Versions (18)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

56

—

FairBetter than 97% of packages

Maintenance76

Regular maintenance activity

Popularity41

Moderate usage in the ecosystem

Community20

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 91.5% 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 ~217 days

Recently: every ~248 days

Total

12

Last Release

132d 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://avatars.githubusercontent.com/u/25850436?v=4)[positive rapidmail](/maintainers/rapidmail)[@rapidmail](https://github.com/rapidmail)

---

Top Contributors

[![eth8505](https://avatars.githubusercontent.com/u/1136509?v=4)](https://github.com/eth8505 "eth8505 (43 commits)")[![gachowy](https://avatars.githubusercontent.com/u/332179?v=4)](https://github.com/gachowy "gachowy (1 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

[aws/aws-sdk-php

AWS SDK for PHP - Use Amazon Web Services in your PHP project

6.2k555.0M2.8k](/packages/aws-aws-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k832.6k55](/packages/neuron-core-neuron-ai)[sylius/sylius

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

8.5k6.0M778](/packages/sylius-sylius)[tempest/framework

The PHP framework that gets out of your way.

2.3k37.6k21](/packages/tempest-framework)[theodo-group/llphant

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

1.7k441.1k8](/packages/theodo-group-llphant)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.3M49](/packages/tencentcloud-tencentcloud-sdk-php)

PHPackages © 2026

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