alaninchika / messenger
A PHP library for sending email or sms messages.
1.1.1
2018-12-01 13:01 UTC
Requires
- php: >=7.0.0
- aws/aws-sdk-php: ^3.52
- twilio/sdk: 5.0
Requires (Dev)
- phpunit/phpunit: ^6.0
- scrutinizer/ocular: ~1.1
README
A PHP library for sending messages.
Installation
$ composer require alaninchika/messenger
Or add to composer.json
:
"require": {
"alaninchika/messenger": "^1.0.0"
}
and then run composer update.
Alternatively you can clone or download the library files.
SMS Configuration (register a provider)
use Messenger\SMSMessenger; $smsMessenger = new SMSMessenger(); // Your Account SID and Auth Token from twilio.com/console $account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; $auth_token = 'your_auth_token'; $twilio_number = "+15017122661"; $twilio = new TwilioSMS($account_sid, $auth_token, $twilio_number); $smsMessenger->registerSMSProvider('twilio', $twilio);
use Messenger\SMSMessenger; $smsMessenger = new SMSMessenger(); $sns_client = new SnsClient([ 'region' => 'eu-west-1', 'version' => 'latest', 'credentials' => [ 'key' => 'AWS_ACCESS_KEY_ID', 'secret' => 'AWS_SECRET_ACCESS_KEY', ] ]); $sns = new SnsSMS($sns_client, 'SNS_TOPIC'); $smsMessenger->registerSMSProvider('sns', $sns);
SMS Usages
// Sending sms message with any registered provider $result = $smsMessenger->sendMessage('15017122664', 'test message'); // Sending sms message with a specific registered provider $result = $smsMessenger->sendMessageWith('sns', '15017122662', 'test message'); // Success result ['provider' => 'sns', 'result' => ['message_id' => 'e234-11e8', 'sent' => true]] // Failed result ['provider' => 'sns', 'result' => ['error' => 'error message', 'sent' => false]]
Contribute
- Guide: CONTRIBUTING.md
- Issue Tracker: github.com/alaninchika/messenger
- Source Code: github.com/alaninchika/messenger
You can find more about contributing in CONTRIBUTING.md.