Skip to content

Latest commit

 

History

History
82 lines (68 loc) · 2.31 KB

README-CN.md

File metadata and controls

82 lines (68 loc) · 2.31 KB
Raw

SendCloud服务的Yii2组件

English Guide

这是一个Yii2框架的组件，该组件可以替代Yii2的SwiftMailer实现发送邮件。 利用SendCloud的API，用户可以在SMTP端口被封的情况下发送邮件， 也可以利用SendCloud的模版和联系人列表实现更更复杂的邮件推送功能。 另外，这个组件也重构了SendCloud的短信发送的SDK，触发短信更为简洁。 这个组件是看到yii2-sendgrid而得到的启发。

安装

添加 yii-sendcloud 到你的composer配置文件 composer.json :

{
    "require": {
        "softbread/yii2-sendcloud": "@dev"
    }
}

如何使用

先把这个组件添加到web.conf的mailer:

return [
    //....
    'components' => [
        'mailer' => [
            'class' => 'SendCloud\Mail\Mailer',
            'api_user' => '<your sendcloud api-user>',
            'api_key'  => '<your sendcloud api-key>'
        ],
        'sendSms' => [
            'class'  => 'SendCloud\Sms\SendSms',
            'apiUser => '<your SMS api-user>',
            'apiKey  => '<your SMS api-key>'
        ],
    ],
];

你就可以用Yii2的发邮件功能了实现真正的邮件功能了：

Yii::$app->mailer->compose('contact/html')
     ->setFrom('from@domain.com')
     ->setTo($form->email)
     ->setSubject($form->subject)
     ->send();

Yii2 Mailer更详细的用法参见：Yii2文档发送邮件部分

当然，这个扩展也支持SendCloud的模版生成的邮件：

Yii::$app->mailer->compose('contact/html')
     ->setFrom('from@domain.com')
     ->setTo([email1, email2])
     ->setSubject($form->subject)
     ->setTemplateName('revoke-name')
     ->setTemplateVars([
            '%name%' => ['X1', 'X2'],
            '%money%'=> [12.5, 1.9]
        ])
     ->send();

利用这个扩展发送短信也非常简单，但需要你的SendCloud帐户余额不为0：

Yii::$app->sendSms->setTo(['13700000000', '13011111111'])
    ->setTemplate('1001')
    ->setVars(['code' => '000111'])
    ->send();

SMS的发送规则及限制参见：SendCloud SMS API 文档