utopia-php/messaging

一个简单、轻量且高级的PHP消息库

0.12.0 2024-05-30 14:58 UTC

README

Build Status Total Downloads Discord

Utopia消息库是一个简单、轻量级的库,用于使用多种消息适配器发送消息。这个库旨在简单易学易用。此库由Appwrite团队维护。

尽管这个库是Utopia框架项目的一部分,但它没有依赖项,可以与其他任何PHP项目或框架独立使用。

入门

使用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: ['[email protected]'],
    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);

短信

<?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);

推送

<?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);

适配器

想要实现任何缺失的适配器或有任何其他想法?我们很乐意听取您的意见!请查看我们的贡献指南新适配器指南以获取更多信息。

电子邮件

短信

推送

系统要求

Utopia Messaging需要PHP 8.0或更高版本。我们建议在可能的情况下使用最新版本的PHP。

测试

要运行所有单元测试,请使用以下Docker命令

composer test

要运行静态代码分析,请使用以下Psalm命令

composer lint

版权和许可证

MIT许可证(MIT) http://www.opensource.org/licenses/mit-license.php