为 46Elks 提供的 Laravel 通知通道包。

v1.10 2023-09-12 08:48 UTC

This package is auto-updated.

Last update: 2024-09-08 14:10:43 UTC


README

Latest Version on Packagist Software License Build Status

Quality Score Code Coverage Total Downloads

此包使您能够使用 Laravel 通过 46Elks 发送通知。

46Elks 提供了许多面向手机的服务。此包负责

  • 短信

更多端点即将推出。欢迎贡献力量。

内容

安装

composer require laravel-notification-channels/46elks

设置 46Elks 服务

将以下内容添加到您的 config/services.php

	'46elks' => [
		'username' => env('FORTY_SIX_ELKS_USERNAME'),
		'password' => env('FORTY_SIX_ELKS_PASSWORD'),
	],

同时,请记住更新您的 .env 文件,使用正确的信息

FORTY_SIX_ELKS_USERNAME=
FORTY_SIX_ELKS_PASSWORD=

您可以在 https://46elks.se/account 找到您的用户名和密码

用法

要使用此通道,只需创建一个包含以下内容的通知

    use NotificationChannels\FortySixElks\FortySixElksChannel;
    use NotificationChannels\FortySixElks\FortySixElksSMS;

    public function via($notifiable)
    {
        return [FortySixElksChannel::class];
    }

 
    public function to46Elks($notifiable)
    {
        return (new FortySixElksSMS())
	        ->line('Testsms')
	        ->line('Olle')
	        ->to('+46762216234')
	        ->from('Emil')
            	// -dry()
    }

可用的媒体

短信

FortySixElksSMS 具有以下方法,都是可链式的。

短信的可用的消息方法

from($mixed) 接受最多 11 个字符的字符串或号码。短信将使用该名称发送。

to($number) 国际电话号码。

line($string) 每行的字符串都将独占一行。

flash() 将消息类型设置为闪存。不会出现在短信收件箱中。请参阅 此推文 了解在 iPhone 上的外观。

dry() 在您想验证 API 请求而不实际向手机发送短信时启用。启用时不会发送短信。要检查 dry() 请求,您需要将消息发送到 +4670000000,然后您可以在 https://46elks.com/logs 中检查它。

whendelivered('http://localhost') 此 webhook URL 将在交付状态更改时接收 POST 请求。

dontlog() 启用以避免将消息文本存储在您的历史记录中。其他参数仍将被存储。

MMS

要使用 MMS,只需使用 new FortySixElksMMS() 替代 new FortySixElksSMS()

FortySixElksMMS 具有以下方法,都是可链式的。

可用的消息方法

from($mixed). 接受 'noreply' 作为字符串或 MMS 激活号码

to($number). 国际电话号码。

line($string). 每行的字符串都将独占一行。

image(). 要发送在 MMS 中的图片的 URL。

错误处理

如何处理通知发送错误

如果发送通知时出现任何错误,它将触发 Illuminate\Notifications\Events\NotificationFailed 事件。然后您可以监听该事件。

示例

Event::listen(NotificationFailed::class, function($event){
    info('Error while sending sms');
});

事件具有 $event->notifiable$event->notification$event->channel$event->data(其中在 $event->data['exception'] 中有异常)

变更日志

请参阅 CHANGELOG 了解最近更改了什么。

测试

$ composer test

安全

如果您发现任何与安全相关的问题,请通过电子邮件发送至 emil@dalnix.se 而不是使用问题跟踪器。

贡献力量

有关详细信息,请参阅 CONTRIBUTING

致谢

许可

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