diviky / laravel-messenger-people
Value First Notifications driver for sms
v1.0.2
2020-10-12 10:01 UTC
Requires
- illuminate/events: ^5|^6|^7|^8
- illuminate/notifications: ^5|^6|^7|^8
- illuminate/support: ^5|^6|^7|^8
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: 4.*
This package is auto-updated.
Last update: 2024-05-12 18:01:17 UTC
README
Contents
- Installation - Setting up your account
- Usage - Available Message methods
- Changelog
- Testing
- Security
- Contributing
- Credits
- License
Installation
You can install the package via composer:
composer require diviky/laravel-messenger-people
Setting up your account
Add your configuration to your config/services.php
:
// config/services.php ... 'messengerpeople' => [ 'client_id' => env('MP_CLIENT_ID'), 'client_secret' => env('MP_CLIENT_SECRET'), 'number_id' => env('MP_NUMBER_ID'), ], ...
Usage
Now you can use the channel in your via()
method inside the notification:
use NotificationChannels\MessengerPeople\Channel; use NotificationChannels\MessengerPeople\Message; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [Channel::class]; } public function toMessengerPeople($notifiable) { return (new Message()) ->text("Your {$notifiable->service} account was approved!"); } }
In order to let your Notification know which phone are you sending to, the channel will look for the phone_number
attribute and mobile
of the Notifiable model. If you want to override this behaviour, add the routeNotificationForMessengerPeople
method to your Notifiable model.
public function routeNotificationForMobtexting() { return '+1234567890'; }
Available Message methods
from('')
: Accepts a phone to use as the notification sender.text('')
: Accepts a string value for the notification body.to('')
: Accepts a string value for the notification to (over writes default).
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.