Allow to specify CC and BCC in sender

ecs.php

@@ -2,6 +2,7 @@
 
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
 use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
+use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocTagTypeFixer;
 use SlevomatCodingStandard\Sniffs\Commenting\InlineDocCommentDeclarationSniff;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
@@ -25,6 +26,7 @@
         PhpdocTagTypeFixer::class,
         InlineDocCommentDeclarationSniff::class . '.MissingVariable',
         VisibilityRequiredFixer::class => ['*Spec.php'],
+        NoSuperfluousPhpdocTagsFixer::class => ['src/Component/Sender/SenderInterface.php'],
         '**/var/*',
         'src/Bundle/test/app/AppKernel.php',
     ]);

phpstan.neon

@@ -26,3 +26,5 @@ parameters:
         - '/Method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface::dispatch\(\) invoked with 2 parameters, 1 required\./'
         - '/Cannot call method has\(\) on object\|null/'
         - '/Property Sylius\\Component\\Mailer\\Model\\Email\:\:\$id is never written\, only read\./'
+        - '/PHPDoc tag \@param references unknown parameter\: \$bccRecipients/'
+        - '/PHPDoc tag \@param references unknown parameter\: \$ccRecipients/'

psalm.xml

@@ -17,6 +17,12 @@
     </projectFiles>
 
     <issueHandlers>
+        <InvalidDocblockParamName>
+            <errorLevel type="suppress">
+                <file name="src/Component/Sender/SenderInterface.php" />
+            </errorLevel>
+        </InvalidDocblockParamName>
+
         <PossiblyNullReference>
             <errorLevel type="suppress">
                 <file name="src/Bundle/DependencyInjection/Configuration.php" />

src/Bundle/Sender/Adapter/DefaultAdapter.php

@@ -43,4 +43,22 @@ public function send(
             SymfonyMailerAdapter::class,
         ));
     }
+
+    public function sendWithCC(
+        array $recipients,
+        string $senderAddress,
+        string $senderName,
+        RenderedEmail $renderedEmail,
+        EmailInterface $email,
+        array $data,
+        array $attachments = [],
+        array $replyTo = [],
+        array $ccRecipients = [],
+        array $bccRecipients = [],
+    ): void {
+        throw new \RuntimeException(sprintf(
+            'You need to configure an adapter to send the email. Take a look at %s (requires "symfony/mailer" library).',
+            SymfonyMailerAdapter::class,
+        ));
+    }
 }

src/Bundle/Sender/Adapter/SwiftMailerAdapter.php

@@ -17,13 +17,14 @@
 use Sylius\Component\Mailer\Model\EmailInterface;
 use Sylius\Component\Mailer\Renderer\RenderedEmail;
 use Sylius\Component\Mailer\Sender\Adapter\AbstractAdapter;
+use Sylius\Component\Mailer\Sender\Adapter\CcAwareAdapterInterface;
 use Sylius\Component\Mailer\SyliusMailerEvents;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * @deprecated The Swift Mailer integration is deprecated since sylius/mailer-bundle 1.8. Use the Symfony Mailer integration instead.
  */
-class SwiftMailerAdapter extends AbstractAdapter
+class SwiftMailerAdapter extends AbstractAdapter implements CcAwareAdapterInterface
 {
     /** @var \Swift_Mailer */
     protected $mailer;
@@ -55,6 +56,56 @@ public function send(
         array $data,
         array $attachments = [],
         array $replyTo = [],
+    ): void {
+        $this->sendMessage(
+            $renderedEmail,
+            $senderAddress,
+            $senderName,
+            $recipients,
+            $replyTo,
+            $attachments,
+            $email,
+            $data,
+        );
+    }
+
+    public function sendWithCC(
+        array $recipients,
+        string $senderAddress,
+        string $senderName,
+        RenderedEmail $renderedEmail,
+        EmailInterface $email,
+        array $data,
+        array $attachments = [],
+        array $replyTo = [],
+        array $ccRecipients = [],
+        array $bccRecipients = [],
+    ): void {
+        $this->sendMessage(
+            $renderedEmail,
+            $senderAddress,
+            $senderName,
+            $recipients,
+            $replyTo,
+            $attachments,
+            $email,
+            $data,
+            $ccRecipients,
+            $bccRecipients,
+        );
+    }
+
+    private function sendMessage(
+        RenderedEmail $renderedEmail,
+        string $senderAddress,
+        string $senderName,
+        array $recipients,
+        array $replyTo,
+        array $attachments,
+        EmailInterface $email,
+        array $data,
+        array $ccRecipients = [],
+        array $bccRecipients = [],
     ): void {
         $message = (new \Swift_Message())
             ->setSubject($renderedEmail->getSubject())
@@ -63,6 +114,13 @@ public function send(
             ->setReplyTo($replyTo)
         ;
 
+        if (!empty($ccRecipients)) {
+            $message->setCc($ccRecipients);
+        }
+        if (!empty($bccRecipients)) {
+            $message->setBcc($bccRecipients);
+        }
+
         $message->setBody($renderedEmail->getBody(), 'text/html');
 
         foreach ($attachments as $attachment) {

src/Bundle/Sender/Adapter/SymfonyMailerAdapter.php

@@ -17,12 +17,13 @@
 use Sylius\Component\Mailer\Model\EmailInterface;
 use Sylius\Component\Mailer\Renderer\RenderedEmail;
 use Sylius\Component\Mailer\Sender\Adapter\AbstractAdapter;
+use Sylius\Component\Mailer\Sender\Adapter\CcAwareAdapterInterface;
 use Sylius\Component\Mailer\SyliusMailerEvents;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 
-final class SymfonyMailerAdapter extends AbstractAdapter
+final class SymfonyMailerAdapter extends AbstractAdapter implements CcAwareAdapterInterface
 {
     private MailerInterface $mailer;
 
@@ -43,6 +44,56 @@ public function send(
         array $data,
         array $attachments = [],
         array $replyTo = [],
+    ): void {
+        $this->sendMessage(
+            $renderedEmail,
+            $senderAddress,
+            $senderName,
+            $recipients,
+            $replyTo,
+            $attachments,
+            $email,
+            $data,
+        );
+    }
+
+    public function sendWithCC(
+        array $recipients,
+        string $senderAddress,
+        string $senderName,
+        RenderedEmail $renderedEmail,
+        EmailInterface $email,
+        array $data,
+        array $attachments = [],
+        array $replyTo = [],
+        array $ccRecipients = [],
+        array $bccRecipients = [],
+    ): void {
+        $this->sendMessage(
+            $renderedEmail,
+            $senderAddress,
+            $senderName,
+            $recipients,
+            $replyTo,
+            $attachments,
+            $email,
+            $data,
+            $ccRecipients,
+            $bccRecipients,
+        );
+    }
+
+    private function sendMessage(
+        RenderedEmail $renderedEmail,
+        string $senderAddress,
+        string $senderName,
+        array $recipients,
+        array $replyTo,
+        array $attachments,
+        EmailInterface $email,
+        array $data,
+        array $ccRecipients = [],
+        array $bccRecipients = [],
     ): void {
         $message = (new Email())
             ->subject($renderedEmail->getSubject())
@@ -52,6 +103,9 @@ public function send(
             ->html($renderedEmail->getBody())
         ;
 
+        $message->addCc(...$ccRecipients);
+        $message->addBcc(...$bccRecipients);
+
         foreach ($attachments as $attachment) {
             $message->attachFromPath($attachment);
         }

src/Bundle/spec/Sender/Adapter/DefaultAdapterSpec.php

@@ -37,5 +37,13 @@ function it_throws_an_exception_about_not_configured_email_sender_adapter(
             )))
             ->during('send', [['[email protected]'], '[email protected]', 'arnaud', $renderedEmail, $email, []])
         ;
+
+        $this
+            ->shouldThrow(new \RuntimeException(sprintf(
+                'You need to configure an adapter to send the email. Take a look at %s (requires "symfony/mailer" library).',
+                SymfonyMailerAdapter::class,
+            )))
+            ->during('sendWithCc', [['[email protected]'], '[email protected]', 'arnaud', $renderedEmail, $email, [], [], [], ['[email protected]'], ['[email protected]']])
+        ;
     }
 }

src/Bundle/spec/Sender/Adapter/SwiftMailerAdapterSpec.php

@@ -50,7 +50,14 @@ function it_sends_an_email(
             ->shouldBeCalled()
         ;
 
-        $mailer->send(Argument::type('\Swift_Message'))->shouldBeCalled();
+        $mailer->send(Argument::that(function (\Swift_Message $message): bool {
+            return
+                $message->getSubject() === 'subject' &&
+                $message->getBody() === 'body' &&
+                $message->getFrom() === ['[email protected]' => 'arnaud'] &&
+                $message->getTo() === ['[email protected]' => null]
+            ;
+        }))->shouldBeCalled();
 
         $dispatcher
             ->dispatch(Argument::type(EmailSendEvent::class), SyliusMailerEvents::EMAIL_POST_SEND)
@@ -66,4 +73,50 @@ function it_sends_an_email(
             [],
         );
     }
+
+    function it_sends_an_email_with_cc_and_bcc_emails(
+        \Swift_Mailer $mailer,
+        EmailInterface $email,
+        EventDispatcherInterface $dispatcher,
+        RenderedEmail $renderedEmail,
+    ): void {
+        $this->setEventDispatcher($dispatcher);
+
+        $renderedEmail->getSubject()->shouldBeCalled()->willReturn('subject');
+        $renderedEmail->getBody()->shouldBeCalled()->willReturn('body');
+
+        $dispatcher
+            ->dispatch(Argument::type(EmailSendEvent::class), SyliusMailerEvents::EMAIL_PRE_SEND)
+            ->shouldBeCalled()
+        ;
+
+        $mailer->send(Argument::that(function (\Swift_Message $message): bool {
+            return
+                $message->getSubject() === 'subject' &&
+                $message->getBody() === 'body' &&
+                $message->getFrom() === ['[email protected]' => 'arnaud'] &&
+                $message->getTo() === ['[email protected]' => null] &&
+                $message->getCc() === ['[email protected]' => null] &&
+                $message->getBcc() === ['[email protected]' => null]
+            ;
+        }))->shouldBeCalled();
+
+        $dispatcher
+            ->dispatch(Argument::type(EmailSendEvent::class), SyliusMailerEvents::EMAIL_POST_SEND)
+            ->shouldBeCalled()
+        ;
+
+        $this->sendWithCC(
+            ['[email protected]'],
+            '[email protected]',
+            'arnaud',
+            $renderedEmail,
+            $email,
+            [],
+            [],
+            [],
+            ['[email protected]'],
+            ['[email protected]'],
+        );
+    }
 }

src/Bundle/spec/Sender/Adapter/SymfonyMailerAdapterSpec.php

@@ -22,6 +22,7 @@
 use Sylius\Component\Mailer\SyliusMailerEvents;
 use Symfony\Component\Mailer\Exception\TransportException;
 use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
@@ -53,7 +54,14 @@ function it_sends_an_email_with_events(
             ->shouldBeCalled()
         ;
 
-        $mailer->send(Argument::type(Email::class))->shouldBeCalled();
+        $mailer->send(Argument::that(function (Email $message): bool {
+            return
+                $message->getSubject() === 'subject' &&
+                $message->getBody()->bodyToString() === 'body' &&
+                $message->getFrom()[0] == new Address('[email protected]', 'arnaud') &&
+                $message->getTo()[0] == new Address('[email protected]')
+            ;
+        }))->shouldBeCalled();
 
         $dispatcher
             ->dispatch(Argument::type(EmailSendEvent::class), SyliusMailerEvents::EMAIL_POST_SEND)
@@ -70,6 +78,39 @@ function it_sends_an_email_with_events(
         );
     }
 
+    function it_sends_an_email_with_cc_and_bcc(
+        MailerInterface $mailer,
+        EmailInterface $email,
+        RenderedEmail $renderedEmail,
+    ): void {
+        $renderedEmail->getSubject()->willReturn('subject');
+        $renderedEmail->getBody()->willReturn('body');
+
+        $mailer->send(Argument::that(function (Email $message): bool {
+            return
+                $message->getSubject() === 'subject' &&
+                $message->getBody()->bodyToString() === 'body' &&
+                $message->getFrom()[0] == new Address('[email protected]', 'arnaud') &&
+                $message->getTo()[0] == new Address('[email protected]') &&
+                $message->getCc()[0] == new Address('[email protected]') &&
+                $message->getBcc()[0] == new Address('[email protected]')
+            ;
+        }))->shouldBeCalled();
+
+        $this->sendWithCC(
+            ['[email protected]'],
+            '[email protected]',
+            'arnaud',
+            $renderedEmail,
+            $email,
+            [],
+            [],
+            [],
+            ['[email protected]'],
+            ['[email protected]'],
+        );
+    }
+
     function it_sends_an_email_with_attachments(
         MailerInterface $mailer,
         EmailInterface $email,