This is a laravel/(lumen?) client library for use with dpslwk/vimbadmin-api
ViMbAdmin is a web based virtual mailbox administration system for dovecote and posftix.
The down side of ViMdAdmin is that it has no APi front end. At Nottingham Hackspace we needed to change our mailbox aliases from the Hackspace Management System (HMS). As the systems run on two different server a quick REST api was thrown together for consumption by HMS 2.0. This is the client package for use in HMS 2.0
- http://github.com/dpslwk/vimbadmin-api
- http://www.vimbadmin.net
- http://nottinghack.org.uk
- https://github.com/NottingHack/hms2
Via Composer
$ composer require lwk/vimbadmin-laravel-clientThe following service provider will be autodiscovered for laravel 5.5+.
LWK\ViMbAdmin\ViMbAdminServiceProvider::class,
Define setup in .env with the following values
VIMBADMIN_URL- Url for api endpointVIMBADMIN_ID- Client IdVIMBADMIN_SECRET- Client SecretVIMBADMIN_DRIVER- Token store provider [json, eloquent, doctrine]VIMBADMIN_FILE- File name for json storeVIMBADMIN_MODEL- Eloquent modelVIMBADMIN_ENITITY- Docrotine Entity
or Publish the config and edit as needed
php artisan vendor:publish --provider="LWK\ViMbAdmin\ViMbAdminServiceProvider" --tag=config
If using either eloquent or doctrine token storage db migrations and mappings need to be provided.
$client = App::make(LWK\ViMbAdminClient());
echo $client->findDomains();Please see CHANGELOG for more information on what has changed recently.
$ composer testPlease see CONTRIBUTING and CONDUCT for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.