PHPackages                             xqueue/maileon-partner-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. xqueue/maileon-partner-api-client

ActiveLibrary

xqueue/maileon-partner-api-client
=================================

Partner API Client to XQ:Maileon

1.1.0(1y ago)074MITPHPPHP ^8.1

Since Jun 6Pushed 1y agoCompare

[ Source](https://github.com/xqueue/partner-php-api-client)[ Packagist](https://packagist.org/packages/xqueue/maileon-partner-api-client)[ Docs](https://www.maileon.de)[ RSS](/packages/xqueue-maileon-partner-api-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (4)Versions (5)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/44708e5efd1cc5cf74d9e9cebcb8a12074f319f344880a62ef05a94d300ee657/687474703a2f2f706f7365722e707567782e6f72672f7871756575652f6d61696c656f6e2d706172746e65722d6170692d636c69656e742f76)](https://packagist.org/packages/xqueue/maileon-partner-api-client)[![License](https://camo.githubusercontent.com/f1c15a28041b5dccc6184462adfc6b0b0ffd6744597684675787d2cb6353d3c6/687474703a2f2f706f7365722e707567782e6f72672f7871756575652f6d61696c656f6e2d706172746e65722d6170692d636c69656e742f6c6963656e7365)](https://packagist.org/packages/xqueue/maileon-partner-api-client)[![PHP Version Require](https://camo.githubusercontent.com/73cd7ca9d25152a87c868e5b4f339ab0cd1cf72eb5fad4a167ec641115d6fa59/687474703a2f2f706f7365722e707567782e6f72672f7871756575652f6d61696c656f6e2d706172746e65722d6170692d636c69656e742f726571756972652f706870)](https://packagist.org/packages/xqueue/maileon-partner-api-client)

Maileon Partner API Client
==========================

[](#maileon-partner-api-client)

Provides an API client to connect to XQueue Maileon's Partner REST API and (de-)serializes all API functions and data for easier use in PHP projects.

Maileon's REST API documentation can be found [here](https://support.maileon.com/support/partner-api/).

Table of contents
-----------------

[](#table-of-contents)

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Tests](#tests)

Requirements
------------

[](#requirements)

The API client requires `PHP >= 8.1` with `libcurl`.

Additionally all requests use an SSL encrypted API endpoint. To enable SSL support in CURL, please follow these steps:

1. Download the official SSL cert bundle by CURL from
2. Save the bundle to a directory that can be accessed by your PHP installation
3. Add the following entry to your php.ini (remember to change the path to where you put the cert bundle):

```
curl.cainfo="your-path-to-the-bundle/cacert.pem"

```

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

[](#installation)

You can add this library to your project using [Composer](https://getcomposer.org/):

```
composer require xqueue/maileon-partner-api-client

```

Usage
-----

[](#usage)

The API client divides the features of Maileon's Partner REST API into specific consumable services. Each service provides all functions of it's specific category.

- **AccountService:**

    - Manage newsletter and customer accounts, api keys, mailing domains.
- **BlacklistService:**

    - Manage your blacklists.
- **ContingentService:**

    - Manage contingents and prepaid status.
- **DistributorReportService:**

    - Get Volume and SMS Reports.
- **GeneralService:**

    - Get domains list, validate domain, get locales.
- **JobService:**

    - Get jobs, create account job.
- **ProductService:**

    - Manage products and upload templates.
- **ReportService:**

    - Get report checks and report CSAs.
- **RoleService:**

    - Create or delete custom roles.
- **UserService:**

    - Manage user accounts and roles.
- **WebhookService:**

    - Manage webhooks.

Examples
--------

[](#examples)

Get Newsletter Accounts:

```
$service = new AccountService(['API_KEY' => 'Your API key'])

$response = $service->getNewsletterAccounts();

if(!$response->getResponse()->isSuccess()){
    // handle error
}

$newsletterAccounts = $response->getData();
```

Create Job:

```
$service = new JobService(['API_KEY' => 'Your API key'])

$response = $this->jobService->createAccountJob(
            $locale,
            $type,
            $author,
            $customerAccountName,
            $newsletterAccountName,
            $customDomain ?? null,
            $providedDomain ?? null,
            $subdomain ?? null,
            $customDns ?? null,
            $accountTemplateId ?? null,
            $users ?? null,
            $customerAccountId ?? null,
            $domainAsLogin ?? null,
            $uiVersion ?? null
        );

if(!$response->getResponse()->isSuccess()){
    // handle error
}

$data = $response->getData();
$jobId = $data['jobId'];
```

Tests
-----

[](#tests)

In order to run the unit tests you need to have Docker installed.

First you need to create a .env file and add your API key:

```
MAILEON_PARTNER_API_KEY=**********
```

Run the following commands to create the container and install the required packages:

```
docker-compose up -d

docker exec -it partner-api composer install

```

Run the following commands to run the tests:

```
docker exec -it partner-api composer test
docker exec -it partner-api composer test-coverage  // or this if you want to have the coverage generated
```

###  Health Score

33

—

LowBetter than 74% of packages

Maintenance51

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 67.6% 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 ~109 days

Total

4

Last Release

375d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/82467e5256302f21f754aa7f48572cc2d47f06792ca16715359e721b760ef302?d=identicon)[xqueue](/maintainers/xqueue)

---

Top Contributors

[![tibor-cser](https://avatars.githubusercontent.com/u/161594652?v=4)](https://github.com/tibor-cser "tibor-cser (23 commits)")[![ddietz-xqueue](https://avatars.githubusercontent.com/u/200758299?v=4)](https://github.com/ddietz-xqueue "ddietz-xqueue (5 commits)")[![itops-xqueue](https://avatars.githubusercontent.com/u/55448834?v=4)](https://github.com/itops-xqueue "itops-xqueue (3 commits)")[![mbeckerle-xqueue](https://avatars.githubusercontent.com/u/61004875?v=4)](https://github.com/mbeckerle-xqueue "mbeckerle-xqueue (3 commits)")

---

Tags

maileonXQueuePartner-API

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/xqueue-maileon-partner-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/xqueue-maileon-partner-api-client/health.svg)](https://phpackages.com/packages/xqueue-maileon-partner-api-client)
```

###  Alternatives

[kreait/firebase-php

Firebase Admin SDK

2.4k39.7M72](/packages/kreait-firebase-php)[cuyz/valinor-bundle

Symfony integration of `cuyz/valinor` — a library that helps to map any input into a strongly-typed value object structure.

51215.0k2](/packages/cuyz-valinor-bundle)[eliashaeussler/cache-warmup

Composer package to warm up website caches, based on a given XML sitemap

73387.5k5](/packages/eliashaeussler-cache-warmup)[n1ebieski/ksef-php-client

PHP API client that allows you to interact with the API Krajowego Systemu e-Faktur

7228.4k](/packages/n1ebieski-ksef-php-client)[eliashaeussler/typo3-warming

Warming - Warms up Frontend caches based on an XML sitemap. Cache warmup can be triggered via TYPO3 backend or using a console command. Supports multiple languages and custom crawler implementations.

20229.9k](/packages/eliashaeussler-typo3-warming)[integer-net/magento2-sansec-watch

Sansec Watch integration for Magento 2

35161.2k](/packages/integer-net-magento2-sansec-watch)

PHPackages © 2026

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