Download the PHP package jlorente/laravel-esendex without Composer
On this page you can find all versions of the php package jlorente/laravel-esendex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-esendex
Esendex SDK integration for Laravel
Laravel integration for the Esendex SDK including a notification channel.
Installation
The preferred way to install this extension is through composer.
With Composer installed, you can then install the extension using the following commands:
or add
to the section of your composer.json
file.
Configuration
- Register the ServiceProvider in your config/app.php service provider list.
config/app.php
- If you want, you can add the following facade to the $aliases section.
config/app.php
- Set the reference, username and password of your esendex account in the config/services.php file inside an array with 'esendex' as key.
config/services.php
Usage
You can use the facade alias Esendex to execute services of the esendex sdk. The authentication params will be automaticaly injected.
You can see a full list of the esendex sdk services in this page.
Notification Channel
A notification channel is included in this package and allows you to integrate the Esendex service with the Laravel notifications.
Formatting Notifications
If a notification supports being sent as an SMS through Esendex, you should define a toEsendex method on the notification class. This method will receive a $notifiable entity and should return a Jlorente\Laravel\Esendex\Notifications\Messages\EsendexMessage instance or a string containing the message to send:
Once done, you must add the notification channel in the array of the via() method of the notification:
Customizing The Name of the Sender
If you would like to send some notifications with a sender name that is different from the one specified in your config/services.php file, you may use the from method on a EsendexMessage instance:
Routing the Notifications
When sending notifications via the esendex channel, the notification system will automatically look for a phone_number attribute on the notifiable entity. If you would like to customize the phone number the notification is delivered to, define a routeNotificationForEsendex method on the entity:
You can find more info about Laravel notifications in this page.
License
Copyright © 2018 José Lorente Martín [email protected].
Licensed under the BSD 3-Clause License. See LICENSE.txt for details.