mscode-pl/mailcow-php-api

A full-featured implementation of the MailCow API

0.14.3 2024-10-07 18:47 UTC

Requires

• php: >=7.2
• ext-json: *
• guzzlehttp/guzzle: ^7.5

Requires (Dev)

• phpunit/phpunit: ^9.5.0

GPL-3.0-or-later

• Efe Bagri
• MsCode.pl Team

• php
• rest
• api
• API-Client
• php-api-client
• mailcow-api
• mailcow

README

Getting Started

Requirements

• PHP 7.2+
• Extensions: Composer, PHP-JSON

In the root of your project execute the following:

$ composer require mscode-pl/mailcow-php-api

or add this to your composer.json file:

{
    "require": {
        "mscode-pl/mailcow-php-api": "^0.14.1"
    }
}

Then perform the installation:

$ composer install --no-dev

Usage

Search for the API Documentation here.
You need an API Key for that.

Example

<?php
// Require the autoloader
require_once 'vendor/autoload.php';

// Use the library namespace
use MsCode\Mailcow\MailCowAPI;

// Then simply pass your API-Token when creating the API client object.
$client = new MailCowAPI('mailcow-with-https.example.com','MAILCOW_API_KEY');

// Then you are able to perform a request
var_dump($client->domains()->getDomains());
?>