grafstorm/laravel-46elks-notification-channel

46 Elks Laravel 通知通道

0.2.0-alpha 2021-03-29 16:46 UTC

This package is auto-updated.

Last update: 2024-09-29 06:14:27 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

免责声明:这不是一个完整的包!如果你正在寻找一个用于 46elks 的完整包,也许可以考虑:https://github.com/laravel-notification-channels/46elks

Laravel SMS 通知通道,适用于 46elks.se 短信服务提供商。

安装

您可以通过 composer 安装此包

composer require grafstorm/laravel-46elks-notification-channel

请确保在您的 .env 文件中设置用户、密码和发送者。发送者限制为最大 11 个字符的字母数字字符串([A-Za-z0-9]) 或正确格式化的 E.164 电话号码。

FORTY_SIX_ELKS_USER=::username::
FORTY_SIX_ELKS_PASS=::password::
FORTY_SIX_ELKS_FROM=::sender::

如果您想覆盖默认设置,可以发布配置文件。

return [
    'user' => env('FORTY_SIX_ELKS_USER'),
    'pass' => env('FORTY_SIX_ELKS_PASS'),
    'from' => env('FORTY_SIX_ELKS_FROM', '46ELKS'),
    'base_url' => env('FORTY_SIX_ELKS_BASE_URL', 'https://api.46elks.com/a1/')
];

您可以使用以下命令发布配置文件:

php artisan vendor:publish --provider="Grafstorm\FortySixElksChannel\FortySixElksChannelServiceProvider" --tag="46elks-notification-channel-config"

使用方法

在您的通知中的 via 方法中添加 Grafstorm\FortySixElksChannel\FortySixElksChannel::class。并且确保添加一个返回包含手机号码和消息的数组的 toFortySixElks 方法。

    use Grafstorm\FortySixElksChannel\FortySixElksChannel;
    use Grafstorm\FortySixElksChannel\SmsMessage;
    
    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [FortySixElksChannel::class];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return string[]
     */
    public function toFortySixElks($notifiable): SmsMessage
    {
        // Return a SmsMessage. Needs to and message.
        // To needs to be formatted as a [E.164](https://en.wikipedia.org/wiki/E.164) phonenumber. (Eg. +4612345678)
        return (new SmsMessage())
                ->from('developer')
                ->to($notifiable->mobile)
                ->line('Hello World')
                ->line('')
                ->line('Bye world.');
    }

发送一次性短信

您还可以使用 FortySixElks 门面在您的应用程序中直接发送消息。

use Grafstorm\FortySixElksChannel\SmsMessage;
use Grafstorm\FortySixElksChannel\Facades\FortySixElks;

$message = (new SmsMessage())
                ->to('+461')
                ->line('Hello World');
                
$sms = FortySixElks::create($message)->send();

// Use dryRun() to test sending the message.
$sms = FortySixElks::create($message)->dryRun()->send();

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件