io-digital/clickatell

Clickatell notifications driver

1.0.0 2022-12-05 12:47 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.2
• illuminate/notifications: ~5.5 || ~6.0 || ~7.0 || ~8.0 || ~9.0
• illuminate/support: ~5.5 || ~6.0 || ~7.0 || ~8.0 || ~9.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• mockery/mockery: ~1.2
• phpmd/phpmd: ^2.9
• phpunit/phpunit: ~8.3
• squizlabs/php_codesniffer: ^3.5

MIT

• Etienne Marais
• Gareth Nicholson

• sms
• notifications
• laravel
• clickatell

README

This package makes it easy to send notifications using clickatell.com with Laravel 5.5+, 6.x & 7.x.

Contents

• 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 io-digital/clickatell

Setting up the clickatell service

Add your Clickatell user, password and api identifier to your config/services.php:

// config/services.php
...
'clickatell' => [
    'api_key' => env('CLICKATELL_API_KEY'),
],
...

Usage

Number format: [phone]

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 IoDigital\Clickatell\ClickatellMessage;
use IoDigital\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!");
    }
}

Notification::route('clickatell', 'YOUR E164 NUMBER')
        ->notifyNow(new \App\Notifications\MyNotification($model));

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] 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.