stidges/laravel-sparkpost-transport

Laravel 11.x 的 Sparkpost 传输组件

v3.0.0 2024-09-01 13:02 UTC

This package is auto-updated.

Last update: 2024-09-01 13:03:43 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Laravel 11.x 的 Sparkpost 传输组件

注意: 使用此包的 v1 版本以支持 Laravel 9.x 注意: 使用此包的 v2 版本以支持 Laravel 10.x

安装

您可以通过 composer 安装此包

composer require stidges/laravel-sparkpost-transport

用法

1. 配置

要开始使用,请将您的 Sparkpost 密钥更新到 config/services.php,如下所示

<?php

return [
    // ...
    'sparkpost' => [
        'secret' => env('SPARKPOST_SECRET'),
    ],
];

接下来,将 Sparkpost 传输添加到您的 config/mail.php 文件的 mailers 部分

<?php

return [
    // ...
    'mailers' => [
        // ...
        'sparkpost' => [
            'transport' => 'sparkpost',
        ],
    ],
    // ...
];

最后,更新您的 .env 文件以添加 SPARKPOST_SECRET 并更新 MAIL_MAILER

MAIL_MAILER=sparkpost

SPARKPOST_SECRET=YourSecretKey

2. 自定义 Sparkpost API 域名

如果您想使用 Sparkpost 的欧盟域名,可以将 domain 添加到您的 config/services.php 文件

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'domain' => 'api.eu.sparkpost.com',
],

3. 自定义 Sparkpost 传输 API 选项

您可以在 config/services.php 中添加一个 options 数组来添加您想要发送到 Sparkpost API 的任何数据。任何在 options 数组中的数据将被合并到 API 请求体中。有关如何自定义传输的详细信息,请参阅 Sparkpost API 文档

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'options' => [
        'campaign_id' => 'my_campaign_id',
        'options' => [
            'click_tracking' => false,
        ],
    ],
],

4. 自定义 Guzzle 客户端

您可以通过在 config/services.php 文件中添加一个 guzzle 数组来添加任何选项到 Guzzle 客户端

'sparkpost' => [
    'secret' => env('SPARKPOST_SECRET'),
    'guzzle' => [
        'timeout' => 10,
    ],
],

致谢

许可协议

MIT 许可协议 (MIT)。有关更多信息,请参阅 许可文件