lwk/vimbadmin-laravel-client

Laravel client for ViMbAdmin-api

vimbadmin-laravel-client

![Software License][ico-license] , _(*1)

This is a laravel/(lumen?) client library for use with dpslwk/vimbadmin-api, _(*2)

ViMbAdmin is a web based virtual mailbox administration system for dovecote and posftix., _(*3)

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, _(*4)

• http://github.com/dpslwk/vimbadmin-api
• http://www.vimbadmin.net
• http://nottinghack.org.uk
• https://github.com/NottingHack/hms2

Install

Via Composer, _(*5)

``` bash $ composer require lwk/vimbadmin-laravel-client, <sub>(*6)</sub>

The following service provider will be autodiscovered for laravel 5.5+. 

LWK\ViMbAdmin\ViMbAdminServiceProvider::class,, <sub>(*7)</sub>

Define setup in .env with the following values

* `VIMBADMIN_URL` - Url for api endpoint
* `VIMBADMIN_ID` - Client Id
* `VIMBADMIN_SECRET` - Client Secret
* `VIMBADMIN_DRIVER` - Token store provider [json, eloquent, doctrine]
* `VIMBADMIN_FILE` - File name for json store
* `VIMBADMIN_MODEL` - Eloquent model
* `VIMBADMIN_ENITITY` - Docrotine Entity

or Publish the config and edit as needed

php artisan vendor:publish --provider="LWK\ViMbAdmin\ViMbAdminServiceProvider" --tag=config, <sub>(*8)</sub>

If using either `eloquent` or `doctrine` token storage db migrations and mappings need to be provided.

## Usage

``` php
$client = App::make(LWK\ViMbAdminClient());
echo $client->findDomains();

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*9)</sub>

Testing

bash $ composer test, <sub>(*10)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*11)</sub>

Security

If you discover any security related issues, please email dps.lwk@gmail.com instead of using the issue tracker., <sub>(*12)</sub>

Credits

• Matt Lloyd
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*13)</sub>