Add configurable mailer

docs/reference/advanced_configuration.rst

@@ -53,6 +53,8 @@ Full configuration options:
         profile:
             default_avatar: 'bundles/sonatauser/default_avatar.png' # Default avatar displayed if the user doesn't have one
 
+        mailer: sonata.user.mailer.default # Service used to send emails
+
     # override FOSUser default serialization
     jms_serializer:
         metadata:

docs/reference/installation.rst

@@ -166,6 +166,19 @@ Add these config lines to your FOSUserBundle configuration:
             address: "%mailer_user%"
             sender_name: "%mailer_user%"
 
+Mailer Configuration
+~~~~~~~~~~~~~~~~~~~~
+
+You can define a custom mailer to send reset password emails.
+Your mailer will have to implement ``FOS\UserBundle\Mailer\MailerInterface``.
+
+.. code-block:: yaml
+
+    # config/packages/sonata.yaml
+
+    sonata_user:
+        mailer: custom.mailer.service.id
+
 Integrating the bundle into the Sonata Admin Bundle
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

src/Action/SendEmailAction.php

@@ -13,7 +13,7 @@
 
 namespace Sonata\UserBundle\Action;
 
-use FOS\UserBundle\Model\UserInterface;
+use FOS\UserBundle\Mailer\MailerInterface;
 use FOS\UserBundle\Model\UserManagerInterface;
 use FOS\UserBundle\Util\TokenGeneratorInterface;
 use Sonata\AdminBundle\Admin\Pool;
@@ -52,7 +52,7 @@ final class SendEmailAction
     private $userManager;
 
     /**
-     * @var \Swift_Mailer
+     * @var MailerInterface
      */
     private $mailer;
 
@@ -66,27 +66,15 @@ final class SendEmailAction
      */
     private $resetTtl;
 
-    /**
-     * @var string[]
-     */
-    private $fromEmail;
-
-    /**
-     * @var string
-     */
-    private $template;
-
     public function __construct(
         EngineInterface $templating,
         UrlGeneratorInterface $urlGenerator,
         Pool $adminPool,
         TemplateRegistryInterface $templateRegistry,
         UserManagerInterface $userManager,
-        \Swift_Mailer $mailer,
+        MailerInterface $mailer,
         TokenGeneratorInterface $tokenGenerator,
-        int $resetTtl,
-        array $fromEmail,
-        string $template
+        int $resetTtl
     ) {
         $this->templating = $templating;
         $this->urlGenerator = $urlGenerator;
@@ -96,8 +84,6 @@ public function __construct(
         $this->mailer = $mailer;
         $this->tokenGenerator = $tokenGenerator;
         $this->resetTtl = $resetTtl;
-        $this->fromEmail = $fromEmail;
-        $this->template = $template;
     }
 
     public function __invoke(Request $request): Response
@@ -123,7 +109,7 @@ public function __invoke(Request $request): Response
                 $user->setConfirmationToken($this->tokenGenerator->generateToken());
             }
 
-            $this->sendResettingEmailMessage($user);
+            $this->mailer->sendResettingEmailMessage($user);
             $user->setPasswordRequestedAt(new \DateTime());
             $this->userManager->updateUser($user);
         }
@@ -132,28 +118,4 @@ public function __invoke(Request $request): Response
             'username' => $username,
         ]));
     }
-
-    private function sendResettingEmailMessage(UserInterface $user): void
-    {
-        $url = $this->urlGenerator->generate('sonata_user_admin_resetting_reset', [
-            'token' => $user->getConfirmationToken(),
-        ], UrlGeneratorInterface::ABSOLUTE_URL);
-
-        $rendered = $this->templating->render($this->template, [
-            'user' => $user,
-            'confirmationUrl' => $url,
-        ]);
-
-        // Render the email, use the first line as the subject, and the rest as the body
-        $renderedLines = explode(PHP_EOL, trim($rendered));
-        $subject = array_shift($renderedLines);
-        $body = implode(PHP_EOL, $renderedLines);
-        $message = (new \Swift_Message())
-            ->setSubject($subject)
-            ->setFrom($this->fromEmail)
-            ->setTo((string) $user->getEmail())
-            ->setBody($body);
-
-        $this->mailer->send($message);
-    }
 }

src/DependencyInjection/Configuration.php

@@ -115,6 +115,7 @@ public function getConfigTreeBuilder()
                         ->scalarNode('default_avatar')->defaultValue('bundles/sonatauser/default_avatar.png')->end()
                     ->end()
                 ->end()
+                ->scalarNode('mailer')->defaultValue('sonata.user.mailer.default')->info('Custom mailer used to send reset password emails')->end()
             ->end()
         ;
 

src/DependencyInjection/SonataUserExtension.php

@@ -81,6 +81,7 @@ class_exists('Sonata\GoogleAuthenticator\GoogleAuthenticator')) {
         $loader->load('twig.xml');
         $loader->load('command.xml');
         $loader->load('actions.xml');
+        $loader->load('mailer.xml');
 
         if ('orm' === $config['manager_type'] && isset(
             $bundles['FOSRestBundle'],
@@ -105,6 +106,7 @@ class_exists('Sonata\GoogleAuthenticator\GoogleAuthenticator')) {
 
         $this->configureTranslationDomain($config, $container);
         $this->configureController($config, $container);
+        $this->configureMailer($config, $container);
 
         $container->setParameter('sonata.user.default_avatar', $config['profile']['default_avatar']);
 
@@ -114,8 +116,6 @@ class_exists('Sonata\GoogleAuthenticator\GoogleAuthenticator')) {
     }
 
     /**
-     * @param array $config
-     *
      * @throws \RuntimeException
      *
      * @return array
@@ -264,7 +264,7 @@ public function registerDoctrineMapping(array $config): void
      * Adds aliases for user & group managers depending on $managerType.
      *
      * @param ContainerBuilder $container
-     * @param                  $managerType
+     * @param string           $managerType
      */
     protected function aliasManagers(ContainerBuilder $container, $managerType): void
     {
@@ -276,9 +276,6 @@ protected function aliasManagers(ContainerBuilder $container, $managerType): voi
         $container->getAlias('sonata.user.group_manager')->setPublic(true);
     }
 
-    /**
-     * @param array $config
-     */
     private function checkManagerTypeToModelTypeMapping(array $config): void
     {
         $managerType = $config['manager_type'];
@@ -320,4 +317,9 @@ private function checkManagerTypeToModelTypeMapping(array $config): void
             }
         }
     }
+
+    private function configureMailer(array $config, ContainerBuilder $container): void
+    {
+        $container->setAlias('sonata.user.mailer', $config['mailer']);
+    }
 }

src/Mailer/Mailer.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\UserBundle\Mailer;
+
+use FOS\UserBundle\Mailer\MailerInterface;
+use FOS\UserBundle\Model\UserInterface;
+use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final class Mailer implements MailerInterface
+{
+    /**
+     * @var UrlGeneratorInterface
+     */
+    private $urlGenerator;
+
+    /**
+     * @var EngineInterface
+     */
+    private $templating;
+
+    /**
+     * @var \Swift_Mailer
+     */
+    private $mailer;
+
+    /**
+     * @var array
+     */
+    private $fromEmail;
+
+    /**
+     * @var string
+     */
+    private $emailTemplate;
+
+    public function __construct(UrlGeneratorInterface $urlGenerator, EngineInterface $templating, \Swift_Mailer $mailer, array $fromEmail, string $emailTemplate)
+    {
+        $this->urlGenerator = $urlGenerator;
+        $this->templating = $templating;
+        $this->mailer = $mailer;
+        $this->fromEmail = $fromEmail;
+        $this->emailTemplate = $emailTemplate;
+    }
+
+    public function sendResettingEmailMessage(UserInterface $user): void
+    {
+        $url = $this->urlGenerator->generate('sonata_user_admin_resetting_reset', [
+            'token' => $user->getConfirmationToken(),
+        ], UrlGeneratorInterface::ABSOLUTE_URL);
+
+        $rendered = $this->templating->render($this->emailTemplate, [
+            'user' => $user,
+            'confirmationUrl' => $url,
+        ]);
+
+        // Render the email, use the first line as the subject, and the rest as the body
+        $renderedLines = explode(PHP_EOL, trim($rendered));
+        $subject = array_shift($renderedLines);
+        $body = implode(PHP_EOL, $renderedLines);
+        $message = (new \Swift_Message())
+            ->setSubject($subject)
+            ->setFrom($this->fromEmail)
+            ->setTo((string) $user->getEmail())
+            ->setBody($body);
+
+        $this->mailer->send($message);
+    }
+
+    public function sendConfirmationEmailMessage(UserInterface $user): void
+    {
+        throw new \LogicException('This method is not implemented.');
+    }
+}

src/Resources/config/actions.xml

@@ -15,11 +15,9 @@
             <argument type="service" id="sonata.admin.pool"/>
             <argument type="service" id="sonata.admin.global_template_registry"/>
             <argument type="service" id="fos_user.user_manager"/>
-            <argument type="service" id="mailer"/>
+            <argument type="service" id="sonata.user.mailer"/>
             <argument type="service" id="fos_user.util.token_generator"/>
             <argument>%fos_user.resetting.retry_ttl%</argument>
-            <argument>%fos_user.resetting.email.from_email%</argument>
-            <argument>%fos_user.resetting.email.template%</argument>
         </service>
         <service id="Sonata\UserBundle\Action\CheckEmailAction" class="Sonata\UserBundle\Action\CheckEmailAction" public="true">
             <argument type="service" id="templating"/>

src/Resources/config/mailer.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="sonata.user.mailer.default" class="Sonata\UserBundle\Mailer\Mailer">
+            <argument type="service" id="router"/>
+            <argument type="service" id="sonata.templating"/>
+            <argument type="service" id="mailer"/>
+            <argument>%fos_user.resetting.email.from_email%</argument>
+            <argument>%fos_user.resetting.email.template%</argument>
+        </service>
+    </services>
+</container>

tests/Action/SendEmailActionTest.php

@@ -13,6 +13,7 @@
 
 namespace Sonata\UserBundle\Tests\Action;
 
+use FOS\UserBundle\Mailer\MailerInterface;
 use FOS\UserBundle\Model\User;
 use FOS\UserBundle\Model\UserManagerInterface;
 use FOS\UserBundle\Util\TokenGeneratorInterface;
@@ -50,7 +51,7 @@ class SendEmailActionTest extends TestCase
     protected $userManager;
 
     /**
-     * @var \Swift_Mailer|\PHPUnit_Framework_MockObject_MockObject
+     * @var MailerInterface|\PHPUnit_Framework_MockObject_MockObject
      */
     protected $mailer;
 
@@ -91,7 +92,7 @@ public function setUp(): void
         $this->pool = $this->createMock(Pool::class);
         $this->templateRegistry = $this->createMock(TemplateRegistryInterface::class);
         $this->userManager = $this->createMock(UserManagerInterface::class);
-        $this->mailer = $this->createMock(\Swift_Mailer::class);
+        $this->mailer = $this->createMock(MailerInterface::class);
         $this->tokenGenerator = $this->createMock(TokenGeneratorInterface::class);
         $this->resetTtl = 60;
         $this->fromEmail = 'noreply@sonata-project.org';
@@ -146,7 +147,7 @@ public function testPasswordRequestNonExpired(): void
             ->willReturn($user);
 
         $this->mailer->expects($this->never())
-            ->method('send');
+            ->method('sendResettingEmailMessage');
 
         $this->urlGenerator->expects($this->any())
             ->method('generate')
@@ -178,7 +179,7 @@ public function testAccountLocked(): void
             ->willReturn($user);
 
         $this->mailer->expects($this->never())
-            ->method('send');
+            ->method('sendResettingEmailMessage');
 
         $this->urlGenerator->expects($this->any())
             ->method('generate')
@@ -229,38 +230,17 @@ public function testEmailSent(): void
             ->willReturn('user-token');
 
         $this->mailer->expects($this->once())
-            ->method('send');
+            ->method('sendResettingEmailMessage');
 
         $this->urlGenerator->expects($this->any())
             ->method('generate')
             ->withConsecutive(
-                ['sonata_user_admin_resetting_reset', ['token' => 'user-token']],
                 ['sonata_user_admin_resetting_check_email', ['username' => 'bar']]
             )
             ->willReturnOnConsecutiveCalls(
-                '/reset',
                 '/check-email'
             );
 
-        $parameters = [
-            'user' => $user,
-            'confirmationUrl' => '/reset',
-        ];
-
-        $this->templating->expects($this->once())
-            ->method('render')
-            ->with($this->template, $parameters)
-            ->willReturn("Subject\nMail content");
-
-        $this->mailer->expects($this->once())
-            ->method('send')
-            ->willReturnCallback(function (\Swift_Message $message): void {
-                $this->assertEquals('Subject', $message->getSubject());
-                $this->assertEquals('Mail content', $message->getBody());
-                $this->assertArrayHasKey($this->fromEmail, $message->getFrom());
-                $this->assertArrayHasKey('user@sonata-project.org', $message->getTo());
-            });
-
         $action = $this->getAction();
         $result = $action($request);
 
@@ -278,9 +258,7 @@ private function getAction(): SendEmailAction
             $this->userManager,
             $this->mailer,
             $this->tokenGenerator,
-            $this->resetTtl,
-            [$this->fromEmail],
-            $this->template
+            $this->resetTtl
         );
     }
 }