nordsoftware/lumen-sparkpost

此包已被弃用且不再维护。未建议替代包。

Lumen PHP 框架的 SparkPost 模块。

1.0.0 2017-04-24 10:22 UTC

This package is auto-updated.

Last update: 2023-03-22 06:04:38 UTC


README

Test Coverage Status Code Climate Scrutinizer Code Quality Latest Stable Version Total Downloads License

SparkPost 模块,用于 Lumen PHP 框架

要求

安装

配置

运行以下命令通过 Composer 安装包

composer require nordsoftware/lumen-sparkpost

配置

config/sparkpost.php 中的配置模板复制到您应用的 config 目录,并根据需要修改。有关更多信息,请参阅 Lumen 文档中的配置文件部分。

唯一必需的配置是 API key,您可以在 SparkPost 账户页面获取。请注意,默认配置使用同步发送模式。如果您想更改它,将 async 选项设置为 true

启动

将以下行添加到 bootstrap/app.php

$app->register(Nord\Lumen\SparkPost\SparkPostServiceProvider::class);

使用

现在您可以在应用中的任何地方使用 Nord\Lumen\SparkPost\SparkPostService 访问 SparkPost。

public function sendEmail(SparkPostService $sparkpost) {
    $results = $sparkpost->send([
        'from' => [
            'name' => 'From Envelope',
            'email' => 'from@sparkpostbox.com',
        ],
        'recipients' => [
            [
                'address' => [
                    'email' => 'john.doe@example.com',
                ],
            ],
        ],
        'template' => 'my-first-email',
    ]);
}

贡献

请阅读 指南

运行测试

克隆项目并运行以下命令以安装其依赖项

composer install

运行以下命令以运行测试套件

vendor/bin/codecept run unit

许可证

MIT,请参阅 LICENSE