README

laravel webpress 核心的通知渠道

Webpress 通知软件包

安装

要将此软件包包含到您的项目中，请运行以下命令。

composer require webpress/notification

配置

运行以下命令以发布配置和迁移文件。

php artisan vendor:publish --provider="VCComponent\Laravel\Notification\Providers\NotificationServiceProvider"

环境

在 .env 文件中，我们需要进行一些配置。

// Communication microservice url
WEBPRESS_NOTIFICATION_BASE_URL=https://api.dev.webpress.vn/communication

通知渠道

Webpress 通知渠道

一个支持通过 Webpress 通信微服务发送电子邮件的通知渠道（目前使用 Mailchimp 交易 API）。

在通知类中使用此渠道，类似于其他默认的 Laravel 通知渠道。

use VCComponent\Laravel\Notification\Notifications\Channels\WebpressChannel;

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

在 toWebpress() 方法中定义消息。

use VCComponent\Laravel\Notification\Notifications\Messages\WebpressMessage;

public function toWebpress($notifiable)
{
    return (new WebpressMessage())
        ->to($notifiable->email)
        ->subject('Reset Password')
        ->template('WEBPRESS 01 - reset your password')
        ->mergeFields([
            [
                'name'    => 'RESET_PASSWORD_URL',
                'content' => "{$reset_password_url}?token={$this->token}",
            ],
        ]);
}

API 列表

以下是软件包提供的 API 列表。

动词	URI	操作
GET	`/api/{namespace}/notification-setting/configable`	获取用户的可配置通知
GET	`/api/{namespace}/notification-setting`	获取用户的通知设置
PUT	`/api/{namespace}/notification-setting/sync`	更新用户的通知设置
------	------	------
GET	`/api/{namespace}/admin/notifications`	获取通知列表
GET	`/api/{namespace}/admin/notifications/{id}`	获取一个通知
POST	`/api/{namespace}/admin/notifications`	创建一个通知
PUT	`/api/{namespace}/admin/notifications/{id}`	更新一个通知
DELETE	`/api/{namespace}/admin/notifications/{id}`	删除一个通知
------	------	------
GET	`/api/{namespace}/admin/template-variables`	获取模板变量列表
GET	`/api/{namespace}/admin/template-variables/{id}`	获取一个模板变量
POST	`/api/{namespace}/admin/template-variables`	创建一个模板变量
PUT	`/api/{namespace}/admin/template-variables/{id}`	更新一个模板变量
DELETE	`/api/{namespace}/admin/template-variables/{id}`	删除一个模板变量
------	------	------
GET	`/api/{namespace}/admin/notification-setting/role/{role_id}`	获取角色通知设置
PUT	`/api/{namespace}/admin/notification-setting`	更新角色模板变量

webpress / notification

维护者

详细信息

README

安装

配置

环境

通知渠道

Webpress 通知渠道

API 列表