coderam / clickatell
Clickatell notifications driver
Requires
- php: >=7.1
- arcturial/clickatell: ~2.1
- illuminate/notifications: ~5.5 || ~6.0 || ~7.0 || ~8.0
- illuminate/support: ~5.5 || ~6.0 || ~7.0 || ~8.0
Requires (Dev)
- mockery/mockery: ~1.3
- phpunit/phpunit: ~9.0
This package is auto-updated.
Last update: 2024-10-21 03:22:42 UTC
README
This package makes it easy to send notifications using clickatell.com with Laravel 5.5+, 6.x & 7.x.
Contents
Installation
You can install the package via composer:
composer require laravel-notification-channels/clickatell
Setting up the clickatell service
Add your Clickatell user, password and api identifier to your config/services.php
:
// config/services.php ... 'clickatell' => [ 'user' => env('CLICKATELL_USER'), 'pass' => env('CLICKATELL_PASS'), 'api_id' => env('CLICKATELL_API_ID'), ], ...
Usage
To route Clickatell notifications to the proper phone number, define a routeNotificationForClickatell
method on your notifiable entity:
class User extends Authenticatable { use Notifiable; /** * Route notifications for the Nexmo channel. * * @param \Illuminate\Notifications\Notification $notification * @return string */ public function routeNotificationForClickatell($notification) { return $this->phone_number; } }
You can use the channel in your via()
method inside the notification:
use Illuminate\Notifications\Notification; use NotificationChannels\Clickatell\ClickatellMessage; use NotificationChannels\Clickatell\ClickatellChannel; class AccountApproved extends Notification { public function via($notifiable) { return [ClickatellChannel::class]; } public function toClickatell($notifiable) { return (new ClickatellMessage()) ->content("Your {$notifiable->service} account was approved!"); } }
Available methods
TODO
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Security
If you discover any security related issues, please email hello@etiennemarais.co.za instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
- etiennemarais
- arcturial
- For the Clickatell Client implementation which I leverage on for this wrapper
License
The MIT License (MIT). Please see License File for more information.