README

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

Install

Via Composer

$ composer require lwk/vimbadmin-laravel-client

The 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 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

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

Usage

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

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email dps.lwk@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

lwk / vimbadmin-laravel-client

Maintainers

Details