ereminmdev/yii2-unisendermailer

The Unisender integration for the Yii framework

v1.0.29 2024-04-28 10:22 UTC

Requires

• php: >=7.4
• unisender/api-wrapper: ^1.6.3
• yiisoft/yii2: ~2.0.8

MIT

• Michael Eremin

• mail
• mailer
• email
• yii2
• unisender

README

Installation

The preferred way to install this extension is through composer.

Either run

composer require --prefer-dist ereminmdev/yii2-unisendermailer

or add

"ereminmdev/yii2-unisendermailer": "~1.0"

to the require section of your composer.json.

Usage

To use this extension, simply add the following code in your application configuration:

return [
    //....
    'components' => [
        'uniMailer' => [
            'class' => 'ereminmdev\yii2\unisendermailer\Mailer',
            'viewPath' => '@common/mail',
            'platform' => 'Yii',
            'apiKey' => '...',
            'listId' => ...,
            'maxSimpleCount' => 0,
            'senderName' => '...',
            'senderEmail' => '...',
            'smsSenderName' => '...',
        ],
    ],
];

You can then send an e-mail as follows:

Yii::$app->uniMailer->compose('contact/html')
    ->setTo($form->email)
    ->setSubject($form->subject)
    ->send(); // or ->sendEmail();

To send sms:

Yii::$app->uniMailer->compose('contact/html')
    ->setTo($form->phone)
    ->setSubject($form->subject)
    ->setType(Message::TYPE_SMS)
    ->send(); // or ->sendSms();

To set sender name and e-mail:

$mailer = Yii::$app->uniMailer;
// for e-mail
$mailer->senderName = 'Sender Name';
$mailer->senderEmail = '[e-mail]';
// for sms
$mailer->smsSenderName = 'Sender';

For further instructions refer to the related section in the Yii Definitive Guide.