https://github.com/exbil/mailcow-php-api
A full-featured implementation of the MailCow API
https://github.com/exbil/mailcow-php-api
api api-client exbil mailcow mailcow-api mailcow-api-client php rest rest-api
Last synced: 3 months ago
JSON representation
A full-featured implementation of the MailCow API
- Host: GitHub
- URL: https://github.com/exbil/mailcow-php-api
- Owner: Exbil
- License: agpl-3.0
- Created: 2023-10-05T14:58:21.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2025-03-26T22:42:04.000Z (7 months ago)
- Last Synced: 2025-05-16T01:46:38.805Z (5 months ago)
- Topics: api, api-client, exbil, mailcow, mailcow-api, mailcow-api-client, php, rest, rest-api
- Language: PHP
- Homepage: https://www.exbil.net
- Size: 40 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailcow PHP API Client
## Getting Started
### Requirements
* [**PHP 8.3+**](https://www.php.net/downloads.php)
* Extensions: [Composer](https://getcomposer.org/), [PHP-JSON](https://www.php.net/manual/en/book.json.php)
In the root of your project execute the following:
```sh
$ composer require exbil/mailcow-php-api
```
or add this to your `composer.json` file:
```json
{
"require": {
"exbil/mailcow-php-api": "^0.14.2"
}
}
```
Then perform the installation:
```sh
$ composer install --no-dev
```
## Usage
Search for the API Documentation [here](https://demo.mailcow.email/api/) or your own mailcow instance via `https://domain.com/api`.
You need an API Key for that which can be found in an self-hosted instance within the admin dashboard.
### Example
```php
domains()->getDomains());
?>
```