lwk / vimbadmin-laravel-client
Laravel client for ViMbAdmin-api
Installs: 1 840
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 4
Requires
- php: ^7.4 | ^8.0
- guzzlehttp/guzzle: ^7.0.1
- illuminate/support: ^6.0|^8.0|^9.0|^10.0
- sainsburys/guzzle-oauth2-plugin: ^3.0
- symfony/property-access: ^5.0|^6.0
- symfony/serializer: ^2.7|^3.0|^4.0|^5.0|^6.0
Requires (Dev)
- phpunit/phpunit: ^9.5.10
- squizlabs/php_codesniffer: ^3.5
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
- http://github.com/dpslwk/vimbadmin-api
- http://www.vimbadmin.net
- http://nottinghack.org.uk
- https://github.com/NottingHack/hms2
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 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.
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.