README

用于即时邮件报警的 Filament 插件，简化了网站错误的监控和应用稳定性。

安装

您可以通过 composer 安装此包

composer require hugomyb/filament-error-mailer

然后，使用以下命令发布配置文件

php artisan vendor:publish --tag="error-mailer-config"

这将在您的 Laravel 项目中创建一个 config/error-mailer.php 文件。

这是发布配置文件的 内容

return [
    'email' => [
        'recipient' => ['recipient1@example.com'],
        'bcc' => [],
        'cc' => [],
        'subject' => 'An error was occured - ' . env('APP_NAME'),
    ],

    'disabledOn' => [
        //
    ],

    'cacheCooldown' => 10, // in minutes
];

可选地，您可以使用以下命令发布邮件视图

php artisan vendor:publish --tag="error-mailer-views"

配置

发布配置文件后，您可以根据需要修改它。打开 config/error-mailer.php 并自定义以下选项

• 'recipient': 设置错误通知将发送到的电子邮件地址。

• 'bcc': 设置将使用 BCC 发送错误通知的电子邮件地址。

• 'cc': 设置将使用 CC 发送错误通知的电子邮件地址。

• 'subject': 定义错误通知电子邮件的主题行。您可以使用如 env('APP_NAME') 这样的占位符动态包含您的应用程序名称。

• 'cacheCooldown': 设置错误通知的冷却时间（以分钟为单位）。如果在同一时间段内发生多次相同的错误

• 'disabledOn': 您可以指定一个环境列表（基于 APP_ENV），在这些环境中错误邮件将禁用。例如，如果您想在本地环境中禁用邮件发送，将 'local' 添加到数组中

'disabledOn' => [
    'local',
],

⚠️ 重要！请确保在您的 .env 文件中配置邮件服务器：

MAIL_MAILER=smtp
MAIL_HOST=your-smtp-host.com
MAIL_PORT=587
MAIL_USERNAME=your-smtp-username
MAIL_PASSWORD=your-smtp-password
MAIL_ENCRYPTION=tls

如果未在 .env 文件中配置邮件服务器，则不会发送电子邮件通知。

最后，别忘了在您的 AdminPanelProvider 中注册插件

...
->plugins([
    FilamentErrorMailerPlugin::make()
])

更多信息

此插件还适用于没有 FilamentPHP 的经典 Laravel 项目：LaravelErrorMailer

贡献

有关详细信息，请参阅 CONTRIBUTING

安全漏洞

请查看我们如何报告安全漏洞的 安全策略

致谢

• Mayonobe Hugo
• 所有贡献者

许可证

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