mailzeet/mailzeet-laravel

这是一个用于与MailZeet API交互的简单PHP包,适用于Laravel。

v0.1.1 2023-11-24 17:41 UTC

This package is auto-updated.

Last update: 2024-08-29 16:38:36 UTC


README

MailZeet website

MailZeet Laravel SDK

网站 · 联系方式 · 文档

PHP Version Build Status Latest Stable Version Total Downloads License

要求

Laravel 9及以后版本。PHP要求:PHP 8.1及以后版本。(未在PHP 8.0上进行测试,但应该可以工作)

对于PHP 7.4和8.0或Laravel 8及以下版本,请使用 mailzeet-php 包。

安装

您可以通过composer安装此包

composer require mailzeet/mailzeet-laravel

配置

通过composer安装包后,您可以运行以下命令

php artisan mailzeet:install

此命令将

  1. 在您的配置目录中发布一个 mailzeet.php 文件
  2. 如果不存在,请将 MONEROO_PUBLIC_KEYMONEROO_SECRET_KEY 变量添加到您的 .env 文件中。

您需要将 'your-public-key' 和 'your-secret-key' 替换为您的实际MailZeet公钥和密钥。

MONEROO_PUBLIC_KEY=your-public-key
MONEROO_SECRET_KEY=your-secret-key

请注意,这些是敏感密钥,不应公开。Laravel .env文件被Git忽略,这使得它是一个存储敏感信息的良好位置。

文档

请参阅Laravel SDK的文档

开发

1- 执行测试

 composer test

2- 在提交和推送之前格式化并分析您的代码。

    composer format # Format your code with the required code style
    composer unused # check if there is an unused dependency
    composer analyze # Analyze your code with phpstan

开发模式

您可以在您的 config/mailzeet.php 文件中将 mailzeet.devMode 设置为 true 以启用开发模式。启用开发模式后,您可以设置 mailzeet.devBaseUrl 以自定义您想要使用的MailZeet API的基础URL。在开发模式下,SDK将使用 mailzeet.devBaseUrl 而不是默认的基础URL https://api.mailzeet.com

注意

  • 项目基于KISS原则。
  • 每次您进行更改时,都必须运行测试并格式化您的代码。
  • 每次您进行更改时,都必须更新文档。
  • 每次您进行更改时,都必须更新更改日志。
  • 每次您进行更改时,都必须添加测试用例。
  • 每次您进行更改时,都必须更新版本号。
  • 每次您进行更改时,都必须更新API文档。
  • 每次您进行更改时,都必须更新README.md文件。

安全漏洞

如果您在MailZeet Laravel SDK中发现了安全漏洞,请通过 hello@mailzeet.com 发送电子邮件给MailZeet安全。所有安全漏洞都将得到及时解决。

许可证

MailZeet Laravel SDK是开源软件,根据MIT许可证许可。