cyberfusion/proxmox-mail-gateway

Library for Proxmox Mail Gateway.

Maintainers

Details

github.com/CyberfusionIO/php-cyberfusion-proxmox-mail-gateway

Source

Issues

Security Policy

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 2

Open Issues: 1

v2.1.0 2025-03-01 09:28 UTC

Requires

Requires (Dev)

MIT f921c320d4fff519f4bbb9b5aef915ff0beca70f

This package is auto-updated.

Last update: 2025-03-29 15:33:40 UTC

README

Library for Proxmox Mail Gateway.

Proxmox Mail Gateway API documentation: https://pmg.proxmox.com/pmg-docs/api-viewer/index.html

Install

Composer

Run the following command to install the package from Packagist:

composer require cyberfusion/proxmox-mail-gateway

Usage

Example

use Cyberfusion\ProxmoxMGW\Client;
use Cyberfusion\ProxmoxMGW\Endpoints\Config\DkimEndpoint;
use Cyberfusion\ProxmoxMGW\Exceptions\AuthenticationException;
use Cyberfusion\ProxmoxMGW\Models\DkimDomainData;
use Cyberfusion\ProxmoxMGW\Requests\DkimGetRequest;

try {
    $client = new Client('pmgtest.cyberfusion.nl');
    $client->authenticate('apiuser', 'Super secret password.');
} catch (AuthenticationException $e) {
    // Handle authentication error
}

$dkimEndpoint = new DkimEndpoint($client);
$result = $dkimEndpoint->get(new DkimGetRequest('example.com'));
if ($result->failed()) {
    // Handle error
}

/** @var DkimDomainData $dkim */
$dkim = $result->getData('dkim');
// $dkim->domain -> example.com