sweelix / yii2-sendgrid

PHP 5.6+ 为 Yii 框架提供的 Sendgrid 集成

1.1.0 2017-07-11 09:40 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:53:11 UTC


README

此扩展允许开发者将 Sendgrid 用作邮件传输工具。

Latest Stable Version Build Status Scrutinizer Code Quality Code Coverage License

Latest Development Version Build Status Scrutinizer Code Quality Code Coverage

安装

如果您使用 Packagist 安装包,则可以像这样更新您的 composer.json

{
    "require": {
        "sweelix/yii2-sendgrid": "*"
    }
}

如何使用它

将扩展添加到您的配置中

return [
    //....
    'components' => [
        'mailer' => [
            'class' => 'sweelix\sendgrid\Mailer',
            'token' => '<your sendgrid token>',
        ],
    ],
];

您可以按照以下方式发送电子邮件(使用 Postmark 模板)

Yii::$app->mailer->compose('contact/html')
     ->setFrom('from@domain.com')
     ->setTo($form->email)
     ->setSubject($form->subject)
     ->setTemplateId(12345)
     ->setTemplateModel([
         'firstname' => $form->firstname,
         'lastname' => $form->lastname,
     ->send();

更多说明请参阅 Yii 官方指南的相关章节

运行测试

在运行测试之前,您应该编辑文件 tests/_bootstrap.php 并更改定义

// ...
define('SENDGRID_FROM', '<sender>');
define('SENDGRID_TOKEN', '<token>');
define('SENDGRID_TO', '<target>');
define('SENDGRID_TEMPLATE', 575741);

define('SENDGRID_TEST_SEND', false);
// ...

以匹配您的 Sendgrid 配置。

贡献

所有代码贡献(包括具有提交权限的人的贡献)都必须通过 pull request 进行,并由核心开发者审核后才能合并。这是为了确保对所有代码进行适当的审查。

将项目 Fork,创建一个 功能分支,并向我们发送 pull request。