basic-usage.md

Basic usage

1. Create template with placeholders using your site dashboard or Gii generator

   Key

   register-notification - this is unique key of this template for using in your code

   Subject

   Notification from {site-name}

   In this example email subject has one placeholder {site-name}

   Body

   Hello, {username}! Welcome to {site-name} :)

   Email body has two placeholders: {username} and {site-name}.

   All keys should be wrapped by {}.

2. Now you can get this template in your code

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

   This method returns a template model object.

3. Then you should parse this template

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

   or use another method

   $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.

4. Now you can use data of this template in your logic

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