Laravel notification channel package for 46Elks.
Installs: 51 707
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 7
Forks: 10
Open Issues: 3
Requires
- php: >=7.0
- guzzlehttp/guzzle: ^6.3 || ^6.5 || ^7.0
- illuminate/events: ~5.5 || ~6.0 || ~7.0 || ~8.0 || ~9.0 || ~10.0
- illuminate/notifications: ~5.5 || ~6.0 || ~7.0 || ~8.0 || ~9.0 || ~10.0
- illuminate/support: ~5.5 || ~6.0 || ~7.0 || ~8.0 || ~9.0 || ~10.0
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: 4.*
This package is auto-updated.
Last update: 2024-10-26 12:28:39 UTC
README
This package makes it easy to send notifications using 46Elks with Laravel.
46Elks has a whole bunch of phone oriented services. This package takes care of:
- SMS
With more endpoints to come. Feel free to contribute.
Contents
Installation
composer require laravel-notification-channels/46elks
Setting up the 46Elks service
add the following to your config/services.php
'46elks' => [ 'username' => env('FORTY_SIX_ELKS_USERNAME'), 'password' => env('FORTY_SIX_ELKS_PASSWORD'), ],
Also remember to update your .env with correct information:
FORTY_SIX_ELKS_USERNAME=
FORTY_SIX_ELKS_PASSWORD=
You will find your username and password at https://46elks.se/account
Usage
To use this channel simply create a notification that has the following content:
use NotificationChannels\FortySixElks\FortySixElksChannel; use NotificationChannels\FortySixElks\FortySixElksSMS; public function via($notifiable) { return [FortySixElksChannel::class]; } public function to46Elks($notifiable) { return (new FortySixElksSMS()) ->line('Testsms') ->line('Olle') ->to('+46701234567') ->from('Emil') // ->flash() - Optional // ->whenDelivered(URL) - Optional // ->dontLog() - Optional // ->dry() - Optional }
Another example without the notification implementation.
use NotificationChannels\FortySixElks\FortySixElksSMS; (new FortySixElksSMS()) ->line('Testsms') ->line('Olle') ->to('+46701234567') ->from('Emil') // ->flash() - Optional // ->whenDelivered(URL) - Optional // ->dontLog() - Optional // ->dry() - Optional ->send();
Available mediums
SMS
The FortySixElksSMS have the following methods, all chainable.
Available Message methods for sms
from($mixed)
Accepts a string containing A-Z, a-z, 0-9 up to 11 characters or numbers. Space is not supported. Sms will be sent with that name.
to($number)
International phone number.
line($string)
Every string in a line will be on its own row.
flash()
Will set the message type to flash. Will not endup in sms inbox. See This tweet to find out how it looks on an iphone.
dry()
Enable when you want to verify your API request without actually sending an SMS to a mobile phone.
No SMS message will be sent when this is enabled. To be able inspect a dry() request you need to
send your message to +4670000000 then you can inspect it at https://46elks.com/logs
whenDelivered('http://localhost.se/ping')
This webhook URL will receive a POST request every time the delivery status changes.
dontLog()
Enable to avoid storing the message text in your history.
The other parameters will still be stored.
MMS
To use MMS simply use new FortySixElksMMS()
instead of new FortySixElksSMS()
The FortySixElksMMS have the following methods, all chainable.
Available Message methods
from($mixed)
. Accepts 'noreply' as a string or a MMS activated number
to($number)
. International phone number.
line($string)
. Every string in a line will be on its own row.
image()
. URL to the image to send in mms.
Error handling
How to handle notification send errors
If for any reason there would be an error when sending a notification it will fire a
Illuminate\Notifications\Events\NotificationFailed
event. You can then listen for that.
Example:
Event::listen(NotificationFailed::class, function($event){ info('Error while sending sms'); });
And the event has $event->notifiable
, $event->notification
, $event->channel
and $event->data
(where you have the exception at $event->data['exception']
)
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Security
If you discover any security related issues, please email emil@dalnix.se instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.