rf1705/messagebird

Laravel 5.x 的 MessageBird 通知通道

v4.0.0 2022-03-17 08:10 UTC

This package is not auto-updated.

Last update: 2024-09-27 22:18:33 UTC


README

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

此包可以轻松使用 Laravel 发送 Messagebird 短信通知

内容

要求

安装

您可以通过 composer 安装此包

composer require laravel-notification-channels/messagebird

对于 Laravel 5.4 或更低版本,您必须将服务提供程序添加到您的配置中

// config/app.php
'providers' => [
    ...
    NotificationChannels\Messagebird\MessagebirdServiceProvider::class,
],

设置您的 Messagebird 账户

将环境变量添加到您的 config/services.php

// config/services.php
...
'messagebird' => [
    'access_key' => env('MESSAGEBIRD_ACCESS_KEY'),
    'originator' => env('MESSAGEBIRD_ORIGINATOR'),
    'recipients' => env('MESSAGEBIRD_RECIPIENTS'),
],
...

将您的 Messagebird Access Key、默认发送者(名称或发送者号码)和默认接收者添加到您的 .env

// .env
...
MESSAGEBIRD_ACCESS_KEY=
MESSAGEBIRD_ORIGINATOR=
MESSAGEBIRD_RECIPIENTS=
],
...

注意:发送者最多可包含 11 个字母数字字符。

用法

现在您可以在通知的 via() 方法中使用此通道

use NotificationChannels\Messagebird\MessagebirdChannel;
use NotificationChannels\Messagebird\MessagebirdMessage;
use Illuminate\Notifications\Notification;

class VpsServerOrdered extends Notification
{
    public function via($notifiable)
    {
        return [MessagebirdChannel::class];
    }

    public function toMessagebird($notifiable)
    {
        return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"));
    }
}

此外,您还可以添加接收者(单个值或数组)

return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"))->setRecipients($recipients);

为了处理状态报告,您还可以设置一个引用

return (new MessagebirdMessage("Your {$notifiable->service} was ordered!"))->setReference($id);

变更日志

请参阅 变更日志 了解最近的变化。

测试

$ composer test

安全性

如果您发现任何安全相关的问题,请通过电子邮件 psteenbergen@gmail.com 而不是使用问题跟踪器。

贡献

请参阅 贡献指南 获取详细信息。

鸣谢

许可

MIT 许可证(MIT)。请参阅 许可文件 了解更多信息。