naffiq/yii2-mailin

为 Yii2 框架提供的 SendinBlue Mailin 包装器

1.1.0 2017-04-03 09:02 UTC

This package is auto-updated.

Last update: 2024-09-05 22:02:11 UTC


README

Build Status Test Coverage Code Climate

为 Yii2 框架提供的 SendinBlue Mailin 包装器。

安装

推荐通过 composer 进行安装

$ composer require naffiq/yii2-mailin

配置

SendinBlue 账户页面 获取您的 API 密钥,并将其按如下方式插入配置文件

<?php

return [
    // Your config 
    'components' => [
        // ...
        'mailin' => [
            'class' => 'naffiq\mailin\Mailin',
            'apiKey' => SENDINBLUE_API_KEY,
            // 'apiUrl' => ''
        ]
    ]
]

?>

使用方法

要获取 官方 SendinBlue 库 的 Mailin 对象实例,请使用组件的 getClient() 方法

<?php 
$mailin = \Yii::$app->mailin->getClient();

// Use $mailin object 
?>

有关进一步的使用,请参阅 API 文档(PHP 部分)。

测试

在运行 PHPUnit 测试之前,请通过环境变量提供您的 SendInBlue API 密钥,例如

$ MAILIN_API_KEY=your_key phpunit