Merge pull request #1125 from pmagictech/develop

feat: Updated email templates with user information
codeigniter4 · Jun 15, 2024 · 4507f1b · 4507f1b
2 parents 22a8b3b + 2c806ed
commit 4507f1b
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 3 deletions.
diff --git a/docs/customization/views.md b/docs/customization/views.md
@@ -37,3 +37,5 @@ to the **app/Views/Shield/** folder.
 ## Customize Content
 
 Customize the content of the view file in **app/Views/Shield/** as you like.
+
+When customizing email templates in **app/Views/Shield/Email**, you have access to the User Entity object through the `$user` variable. Utilize `$user` to personalize the email messages according to individual user details.
diff --git a/src/Authentication/Actions/Email2FA.php b/src/Authentication/Actions/Email2FA.php
@@ -94,7 +94,7 @@ public function handle(IncomingRequest $request)
         $email->setSubject(lang('Auth.email2FASubject'));
         $email->setMessage($this->view(
             setting('Auth.views')['action_email_2fa_email'],
-            ['code'  => $identity->secret, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
+            ['code'  => $identity->secret, 'user' => $user, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
             ['debug' => false]
         ));
 

diff --git a/src/Authentication/Actions/EmailActivator.php b/src/Authentication/Actions/EmailActivator.php
@@ -71,7 +71,7 @@ public function show(): string
         $email->setSubject(lang('Auth.emailActivateSubject'));
         $email->setMessage($this->view(
             setting('Auth.views')['action_email_activate_email'],
-            ['code'  => $code, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
+            ['code'  => $code, 'user' => $user, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
             ['debug' => false]
         ));
 

diff --git a/src/Controllers/MagicLinkController.php b/src/Controllers/MagicLinkController.php
@@ -127,7 +127,7 @@ public function loginAction()
         $email->setSubject(lang('Auth.magicLinkSubject'));
         $email->setMessage($this->view(
             setting('Auth.views')['magic-link-email'],
-            ['token' => $token, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
+            ['token' => $token, 'user' => $user, 'ipAddress' => $ipAddress, 'userAgent' => $userAgent, 'date' => $date],
             ['debug' => false]
         ));
 

diff --git a/src/Views/Email/email_2fa_email.php b/src/Views/Email/email_2fa_email.php
@@ -23,6 +23,7 @@
         </tbody>
     </table>
     <b><?= lang('Auth.emailInfo') ?></b>
+    <p><?= lang('Auth.username') ?>: <?= esc($user->username) ?></p>
     <p><?= lang('Auth.emailIpAddress') ?> <?= esc($ipAddress) ?></p>
     <p><?= lang('Auth.emailDevice') ?> <?= esc($userAgent) ?></p>
     <p><?= lang('Auth.emailDate') ?> <?= esc($date) ?></p>

diff --git a/src/Views/Email/email_activate_email.php b/src/Views/Email/email_activate_email.php
@@ -23,6 +23,7 @@
         </tbody>
     </table>
     <b><?= lang('Auth.emailInfo') ?></b>
+    <p><?= lang('Auth.username') ?>: <?= esc($user->username) ?></p>
     <p><?= lang('Auth.emailIpAddress') ?> <?= esc($ipAddress) ?></p>
     <p><?= lang('Auth.emailDevice') ?> <?= esc($userAgent) ?></p>
     <p><?= lang('Auth.emailDate') ?> <?= esc($date) ?></p>

diff --git a/src/Views/Email/magic_link_email.php b/src/Views/Email/magic_link_email.php
@@ -28,6 +28,7 @@
         </tbody>
     </table>
     <b><?= lang('Auth.emailInfo') ?></b>
+    <p><?= lang('Auth.username') ?>: <?= esc($user->username) ?></p>
     <p><?= lang('Auth.emailIpAddress') ?> <?= esc($ipAddress) ?></p>
     <p><?= lang('Auth.emailDevice') ?> <?= esc($userAgent) ?></p>
     <p><?= lang('Auth.emailDate') ?> <?= esc($date) ?></p>

diff --git a/tests/Controllers/ActionsTest.php b/tests/Controllers/ActionsTest.php
@@ -134,6 +134,9 @@ public function testEmail2FAHandleSendsEmail(): void
 
         // Should have sent an email with the code....
         $this->assertStringContainsString('Your authentication code is:', service('email')->archive['body']);
+
+        // Should have included the username in the email
+        $this->assertStringContainsString($this->user->username, service('email')->archive['body']);
     }
 
     public function testEmail2FAVerifyFails(): void
@@ -248,6 +251,9 @@ public function testEmailActivateShow(): void
             '!<h1>[0-9]{6}</h1>!',
             service('email')->archive['body']
         );
+
+        // Should have included the username in the email
+        $this->assertStringContainsString($this->user->username, service('email')->archive['body']);
     }
 
     public function testEmailActivateVerify(): void