From 5308f5011ab521e6ca50427a623b69271ce22a21 Mon Sep 17 00:00:00 2001
From: Paul Klimov <klimov.paul@gmail.com>
Date: Fri, 10 May 2024 12:01:51 +0300
Subject: [PATCH] add docs

---
 README.md      | 116 ++++++++++++++++++++++++++++++++++++++++++++++++-
 src/Mailer.php |   4 +-
 2 files changed, 117 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index a79723b..b18d047 100644
--- a/README.md
+++ b/README.md
@@ -38,4 +38,118 @@ to the "require" section of your composer.json.
 Usage
 -----
 
-This extension 
\ No newline at end of file
+This extension provides integration of [Symfony Mailer](https://symfony.com/doc/current/mailer.html) in the Yii1 application.
+Application configuration example:
+
+```php
+<?php
+
+return [
+    'components' => [
+        'mailer' => [
+            'class' => yii1tech\mailer\Mailer,
+            'dsn' => 'smtp://user:pass@smtp.example.com:25',
+        ],
+    ],
+    // ...
+];
+```
+
+Usage example:
+
+```php
+<?php
+
+use Symfony\Component\Mime\Email;
+
+$email = (new Email())
+    ->addFrom('noreply@example.com')
+    ->addTo('johndoe@example.com')
+    ->subject('Greetings')
+    ->text('Welcome to our application')
+    ->html('<h1>Welcome to our application</h1>');
+
+Yii::app()->mailer->send($email);
+```
+
+
+### Configuring Emails Globally <span id="configuring-emails-globally"></span>
+
+Application configuration example:
+
+```php
+<?php
+
+return [
+    'components' => [
+        'mailer' => [
+            'class' => yii1tech\mailer\Mailer,
+            'defaultHeaders' => [
+                'From' => 'My Application<noreply@example.com>',
+                'Bcc' => 'test-via-bcc@example.com',
+                'X-Custom-Header' => 'foobar',
+            ],
+            // ...
+        ],
+    ],
+    // ...
+];
+```
+
+
+### Template rendering <span id="template-rendering"></span>
+
+```php
+<?php
+
+use yii1tech\mailer\TemplatedEmail;
+
+$email = (new TemplatedEmail())
+    ->addFrom('noreply@example.com')
+    ->addTo('johndoe@example.com')
+    ->subject('Greetings')
+    ->textTemplate('greetings-text')
+    ->htmlTemplate('greetings-html')
+    ->context([
+        'name' => 'John Doe',
+    ]);
+
+Yii::app()->mailer->send($email);
+```
+
+
+### Writing unit tests <span id="writing-unit-tests"></span>
+
+```php
+<?php
+
+return [
+    'components' => [
+        'mailer' => [
+            'class' => yii1tech\mailer\Mailer,
+            'dsn' => 'array://',
+            // ...
+        ],
+    ],
+    // ...
+];
+```
+
+```php
+<?php
+
+class MailTest extends TestCase
+{
+    public function testMail(): void
+    {
+        // code under test here
+        
+        /** @var \Symfony\Component\Mime\Email $sentMessage */
+        $sentMessage = Yii::app()->mailer->getTransport()->getLastSentMessage();
+        
+        $this->assetNotNull($sentMessage);
+        $this->assertSame('johndoe@example.com', $sentMessage->getTo()[0]->getAddress());
+        // ...
+    }
+}
+```
diff --git a/src/Mailer.php b/src/Mailer.php
index 0e95a9e..edbf220 100644
--- a/src/Mailer.php
+++ b/src/Mailer.php
@@ -73,8 +73,8 @@ class Mailer extends CApplicationComponent
      *
      * ```
      * [
-     *     'From' => 'My App<noreply@example.com>',
-     *     'Bcc' => 'test-bcc@example.com',
+     *     'From' => 'My Application<noreply@example.com>',
+     *     'Bcc' => 'test-via-bcc@example.com',
      *     'X-Custom-Header' => 'foobar',
      * ]
      * ```