api.mailbox.org : PHP-API-Client

Download

Die aktuelleste Version des Clients ist unter folgender URL zum Download verfügbar:

https://api.mailbox.org/v1/client

Funktionsweise

Die Datei des Clients sollte an geeigneter Stelle im Softwareprojekt abgelegt werden. Danach
wird sie im PHP-Code required:

<?php
require_once './api.mailbox.org.client.php';

Nun wird eine neue Instanz des Clients erzeugt. Dabei kann im Konstruktor entweder eine Auth-ID übergeben werden
(authentifizierte Requests) oder kein Wert (anonyme Requests):

// anonyme Requests
$api = new api_mailbox_org_client();
// authentifizierte Requests
 
// wir nehmen an, dass die ID in einer $_SESSION Variable steckt
$auth_id = $_SESSION['api_auth_id'];
$api = new api_mailbox_org_client($auth_id);

Jetzt können Methoden ausgeführt werden. Dabei bitte die Dokumentation der API-Methoden beachten.

Beispiele

hello.world (anonymer Request)

<?php
require_once './api.mailbox.org.client.php';
$api = new api_mailbox_org_client();
$r = $api->call('hello.world');
if ($r === FALSE) {
	echo 'API ERROR! Code: '.$api->error_code().', Message: '.$api->error_message();
} else {
    // "Hello World!"
	echo $r;
}

 

Auth-ID anfordern (anonymer Request)

<?php
require_once './api.mailbox.org.client.php';
$api = new api_mailbox_org_client();
 

$params = array(
    'user' => 'test_account',
    'pass' => '123456'
);
$r = $api->call('auth', $params);
if ($r === FALSE) {
	echo 'API ERROR! Code: '.$api->error_code().', Message: '.$api->error_message();
} else {
    $_SESSION['api_auth_id'] = $r['session'];
}

 

domain.list mit gültiger Auth-ID ausführen (authentifizierter Request)

<?php
require_once './api.mailbox.org.client.php';
 

// wir nehmen an, dass die ID in einer $_SESSION Variable steckt
$auth_id = $_SESSION['api_auth_id'];
$api = new api_mailbox_org_client($auth_id);
 

$params = array(
    'account' => 'test_account',
);
$r = $api->call('domain.list', $params);
if ($r === FALSE) {
	echo 'API ERROR! Code: '.$api->error_code().', Message: '.$api->error_message();
} else {
    foreach ($r AS $item) {
        echo 'Domain: '.$item['domain'].', Anzahl Mailadressen: '.$item['count_mails'].PHP_EOL;
    }
}