added save copy of sent message to folder

Author: bidi

CHANGELOG.md

@@ -1,3 +1,20 @@
+## 4.1.0 - 2022-08-11
+
+### Changed
+* Nothing
+
+### Added
+* Saving outgoing emails into folders
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
 ## 4.0.0 - 2022-08-10
 
 ### Changed
@@ -16,6 +33,23 @@
 ### Fixed
 * Nothing
 
+## 3.4.0 - 2022-08-10
+
+### Changed
+* Nothing
+
+### Added
+* Saving outgoing emails into folders
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing
+
 ## 3.3.1 - 2022-08-10
 
 ### Changed

README.md

@@ -4,12 +4,12 @@ DotKernel mail component based on [laminas-mail](https://github.com/laminas/lami
 
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-mail)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/3.3.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.1.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/network)
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/stargazers)
-[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/blob/3.0/LICENSE.md)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/blob/4.0/LICENSE.md)
 
 
 
@@ -19,9 +19,8 @@ The `$this->mailService->send()->isValid()` method call will return a boolean va
 If the returned result is `true`, the e-mail was valid, otherwise the e-mail was invalid.
 In case your e-mail was invalid, you can check for any errors using `$this->mailService->send()->getMessage()`.
 
-Using the below logic will let you determinate if a message was valid or not and log it.
-
-The implementor can write it's own custom error log logic.
+Using the below logic will let you determine if a message was valid or not and log it.
+You can implement your own custom error logging logic.
 
 ````
 $result = $this->mailService->send();
@@ -54,3 +53,21 @@ return [
 ];
 ```
 To disable it again, set the value of `sent` to `null`.
+
+### Saving a copy of an outgoing mail into a folder
+First, make sure the `save_sent_message_folder` key is present in config file `mail.local.php` under `dot_mail.default`. Below you can see its placement and default value.
+```php
+<?php
+
+return [
+    'dot_mail' => [
+        'default' => [
+        ...
+            'save_sent_message_folder' => ['INBOX.Sent']
+        ],
+    ],
+];
+```
+Common folder names are `INBOX`, `INBOX.Archive`, `INBOX.Drafts`, `INBOX.Sent`, `INBOX.Spam`, `INBOX.Trash`. If you have `MailService` available in your class, you can call `$this->mailService->getFolderGlobalNames()` to list the folder global names for the email you are using.
+
+Multiple folders can be added to the `save_sent_message_folder` key to save a copy of the outgoing email in each folder.

src/Factory/MailServiceAbstractFactory.php

@@ -19,6 +19,7 @@
 use Dot\Mail\Service\MailServiceInterface;
 use Interop\Container\ContainerInterface;
 use Laminas\Mail\Message;
+use Laminas\Mail\Storage\Imap;
 use Laminas\Mail\Transport\File;
 use Laminas\Mail\Transport\Smtp;
 use Laminas\Mail\Transport\TransportInterface;
@@ -58,8 +59,9 @@ public function __invoke(
         $logService = $container->get(LogServiceInterface::class);
         $message = $this->createMessage();
         $transport = $this->createTransport($container);
+        $storage = $this->createStorage($container);
 
-        $mailService = new MailService($logService, $message, $transport);
+        $mailService = new MailService($logService, $message, $transport, $storage, $this->mailOptions);
 
         //set subject
         $mailService->setSubject($this->mailOptions->getMessageOptions()->getSubject());
@@ -186,6 +188,23 @@ protected function setupTransportConfig(TransportInterface $transport)
         return $transport;
     }
 
+    /**
+     * @param ContainerInterface $container
+     * @return Imap
+     */
+    protected function createStorage(ContainerInterface $container)
+    {
+        $host = $this->mailOptions->getSmtpOptions()->getHost();
+        $connectionConfig = $this->mailOptions->getSmtpOptions()->getConnectionConfig();
+        $storage = new Imap([
+                                'host'     => $host,
+                                'user'     => $connectionConfig['username'],
+                                'password' => $connectionConfig['password'],
+                            ]);
+
+        return $storage;
+    }
+
     /**
      * @param MailEventListenerAwareInterface $service
      * @param ContainerInterface $container

src/Options/MailOptions.php

@@ -47,6 +47,9 @@ class MailOptions extends AbstractOptions
     /** @var array */
     protected $eventListeners = [];
 
+    /** @var array */
+    protected $saveSentMessageFolder;
+
     /**
      * @return array
      */
@@ -164,4 +167,20 @@ public function setEventListeners(array $eventListeners)
     {
         $this->eventListeners = $eventListeners;
     }
+
+    /**
+     * @return array
+     */
+    public function getSaveSentMessageFolder()
+    {
+        return $this->saveSentMessageFolder;
+    }
+
+    /**
+     * @param array $saveSentMessageFolder
+     */
+    public function setSaveSentMessageFolder(array $saveSentMessageFolder): void
+    {
+        $this->saveSentMessageFolder = $saveSentMessageFolder;
+    }
 }

src/Service/MailService.php

@@ -14,9 +14,11 @@
 use Dot\Mail\Event\MailEventListenerAwareTrait;
 use Dot\Mail\Exception\InvalidArgumentException;
 use Dot\Mail\Exception\MailException;
+use Dot\Mail\Options\MailOptions;
 use Dot\Mail\Result\MailResult;
 use Dot\Mail\Result\ResultInterface;
 use Laminas\Mail\Message;
+use Laminas\Mail\Storage\Imap;
 use Laminas\Mail\Transport\TransportInterface;
 use Laminas\Mime\Message as MimeMessage;
 use Laminas\Mime\Mime;
@@ -49,11 +51,15 @@ class MailService implements
     public function __construct(
         LogServiceInterface $logService,
         Message $message,
-        TransportInterface $transport
+        TransportInterface $transport,
+        Imap $storage,
+        MailOptions $mailOptions
     ) {
         $this->logService = $logService;
         $this->message = $message;
         $this->transport = $transport;
+        $this->storage = $storage;
+        $this->mailOptions = $mailOptions;
     }
 
     /**
@@ -87,6 +93,13 @@ public function send(): ResultInterface
             $this->logService->sent($this->message);
         }
 
+        //save copy of sent message to folders
+        if ($this->mailOptions->getSaveSentMessageFolder()) {
+            foreach ($this->mailOptions->getSaveSentMessageFolder() as $folder) {
+                $this->storage->appendMessage($this->message->toString(), $folder);
+            }
+        }
+
         return $result;
     }
 
@@ -268,4 +281,19 @@ public function setTransport(TransportInterface $transport)
     {
         $this->transport = $transport;
     }
+
+    /**
+     * @return array
+     */
+    public function getFolderGlobalNames()
+    {
+        $folderGlobalNames = [];
+        foreach ($this->storage->getFolders() as $folder) {
+            $folderGlobalNames[] = $folder->getGlobalName();
+        }
+        foreach ($this->storage->getFolders()->getChildren() as $folder) {
+            $folderGlobalNames[] = $folder->getGlobalName();
+        }
+        return $folderGlobalNames;
+    }
 }