utopia-php / messaging
A simple, light and advanced PHP messaging library
Installs: 39 267
Dependents: 1
Suggesters: 0
Security: 0
Stars: 15
Watchers: 6
Forks: 61
Open Issues: 35
Requires
- php: >=8.0.0
- ext-curl: *
- ext-openssl: *
- giggsey/libphonenumber-for-php-lite: 8.13.36
- phpmailer/phpmailer: 6.9.1
Requires (Dev)
- laravel/pint: 1.13.11
- phpstan/phpstan: 1.10.58
- phpunit/phpunit: 10.5.10
- dev-main
- 0.12.2
- 0.12.1
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.9.0
- 0.8.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.1
- 0.1.0
- dev-fix-fcm-expiry
- dev-feat-get-all-codes
- dev-review-1
- dev-abnegate-patch-1
- dev-feat-benchmarking
- dev-feat-clicksend
- dev-feat-push
- dev-fix-xxx-form-urlencoded
- dev-feat-base
- dev-feat-apple-push
This package is auto-updated.
Last update: 2024-10-22 01:04:41 UTC
README
Utopia Messaging library is simple and lite library for sending messages using multiple messaging adapters. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.
Although this library is part of the Utopia Framework project it is dependency free, and can be used as standalone with any other PHP project or framework.
Getting Started
Install using composer:
composer require utopia-php/messaging
<?php use \Utopia\Messaging\Messages\Email; use \Utopia\Messaging\Adapter\Email\SendGrid; use \Utopia\Messaging\Adapter\Email\Mailgun; $message = new Email( to: ['team@appwrite.io'], subject: 'Hello World', content: '<h1>Hello World</h1>' ); $messaging = new Sendgrid('YOUR_API_KEY'); $messaging->send($message); $messaging = new Mailgun('YOUR_API_KEY', 'YOUR_DOMAIN'); $messaging->send($message);
SMS
<?php use \Utopia\Messaging\Messages\SMS; use \Utopia\Messaging\Adapter\SMS\Twilio; use \Utopia\Messaging\Adapter\SMS\Telesign; $message = new SMS( to: ['+12025550139'], content: 'Hello World' ); $messaging = new Twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN'); $messaging->send($message); $messaging = new Telesign('YOUR_USERNAME', 'YOUR_PASSWORD'); $messaging->send($message);
Push
<?php use \Utopia\Messaging\Messages\Push; use \Utopia\Messaging\Adapter\Push\FCM; $message = new Push( to: ['eyJhGc...ssw5c'], content: 'Hello World' ); $messaging = new FCM('YOUR_SERVICE_ACCOUNT_JSON'); $messaging->send($message);
Adapters
Want to implement any of the missing adapters or have an idea for another? We would love to hear from you! Please check out our contribution guide and new adapter guide for more information.
SMS
- Twilio
- Twilio Notify
- Telesign
- Textmagic
- Msg91
- Vonage
- Plivo
- Infobip
- Clickatell
- AfricasTalking
- Sinch
- Seven
- SmsGlobal
Push
System Requirements
Utopia Messaging requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
Tests
To run all unit tests, use the following Docker command:
composer test
To run static code analysis, use the following Psalm command:
composer lint
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php