README

This package makes it easy to send notifications using clickatell.com with Laravel 5.3+.

Installation
- Setting up the Clickatell service
Usage
- Available Message methods
Changelog
Testing
Security
Contributing
Credits
License

Installation

You can install the package via composer:

composer require laravel-notification-channels/clickatell

You must install the service provider:

// config/app.php
'providers' => [
    ...
    NotificationChannels\Clickatell\ClickatellServiceProvider::class,
],

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

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.

wavorster / clickatell

Maintainers

Details