yiimaker/yii2-email-templates

Extension for creating of email templates and manage using your site dashboard

, _(*1)

, _(*2)

Email templates module

Extension for creating email templates and managing by using your site dashboard. You can create email templates with CRUD module in your backend or Gii generator., _(*3)

Documentation is at docs/guide/README.md., _(*4)

, _(*5)

Installation

The preferred way to install this extension is through composer., _(*6)

Either run, _(*7)

$ composer require yiimaker/yii2-email-templates

or add, _(*8)

"yiimaker/yii2-email-templates": "~4.1"

to the require section of your composer.json., _(*9)

Usage

1. Create template with placeholders using your site dashboard or Gii generator, _(*10)

   Key

   register-notification - this is unique key of this template for using in your code, _(*11)

   Subject

   Notification from {site-name}, _(*12)

   In this example email subject has one placeholder {site-name}, _(*13)

   Body

   Hello, {username}! Welcome to {site-name} :), _(*14)

   Email body has two placeholders: {username} and {site-name}., _(*15)

   All keys should be wrapped by {}., _(*16)

2. Now you can get this template in your code, _(*17)

   $template = Yii::$app->get('templateManager')->getTemplate('register-notification');
   

   This method returns a template model object., _(*18)

3. Then you should parse this template, _(*19)

   $template->parseSubject([
      'site-name' => Yii::$app->name,
   ]);
   
   $template->parseBody([
      'username' => Yii::$app->getIdentity()->username,
      'site-name' => Yii::$app->name,
   ]);
   

   or use another method, _(*20)

   $template->parse([
      'subject' => [
          'site-name' => Yii::$app->name,
      ],
      'body' => [
          'username' => Yii::$app->getIdentity()->username,
          'site-name' => Yii::$app->name,
      ],
   ]);
   

   this methods replace placeholders in template with real data., _(*21)

4. Now you can use data of this template in your logic, _(*22)

   Yii::$app->get('mailer')->compose()
       ->setSubject($template->subject)
       ->setHtmlBody($template->body)
       // ...
   

Tests

You can run tests with composer command, _(*23)

$ composer test

or using following command, _(*24)

$ codecept build && codecept run

Contributing

For information about contributing please read CONTRIBUTING.md., _(*25)

Sponsoring

, _(*26)

License

, _(*27)

This project is released under the terms of the BSD-3-Clause license., _(*28)

Copyright (c) 2017-2022, Yii Maker, _(*29)