Allow disable log saving

Author: natanfelles

.phpstorm.meta.php

@@ -11,6 +11,7 @@
 
 registerArgumentsSet(
     'config_keys',
+    'add_logs',
     'charset',
     'connection_timeout',
     'crlf',

guide/index.rst

@@ -162,6 +162,7 @@ The default configs for connecting to the mail server are as follows:
         'response_timeout' => 5,
         'hostname' => gethostname(),
         'keep_alive' => false,
+        'add_logs' => true,
     ];
 
     $mailer = new SMTPMailer($config);
@@ -177,6 +178,13 @@ If you are going to send more than one message on the same connection, set
 **keep_alive** to ``true``. 
 This will use the same connection for all submissions.
 
+Add Logs
+########
+
+It is possible to clear the logs after each submission using the ``resetLogs`` method.
+
+Also, you can disable log saving, to save memory, by setting **add_logs** to ``false``.
+
 Conclusion
 ----------
 

src/Mailer.php

@@ -75,6 +75,7 @@ public function __construct(
         'response_timeout' => 'int',
         'hostname' => 'string',
         'keep_alive' => 'bool',
+        'add_logs' => 'bool',
     ])]
     protected function makeConfig(array $config) : array
     {
@@ -90,6 +91,7 @@ protected function makeConfig(array $config) : array
             'response_timeout' => 5,
             'hostname' => \gethostname(),
             'keep_alive' => false,
+            'add_logs' => true,
         ], $config);
     }
 
@@ -120,6 +122,7 @@ protected function getConfig(string $key) : mixed
         'response_timeout' => 'int',
         'hostname' => 'string',
         'keep_alive' => 'bool',
+        'add_logs' => 'bool',
     ])]
     public function getConfigs() : array
     {
@@ -167,6 +170,9 @@ public function resetLogs() : static
      */
     protected function addLog(string $command, string $response) : static
     {
+        if ( ! $this->getConfig('add_logs')) {
+            return $this;
+        }
         $this->logs[] = [
             'command' => $command,
             'responses' => \explode(\PHP_EOL, $response),

tests/Mailers/SMTPMailerTest.php

@@ -90,6 +90,7 @@ public function testLogs() : void
     {
         \sleep(5);
         $this->smtp->send($this->getMessage());
+        self::assertNotEmpty($this->smtp->getLogs());
         $log = $this->smtp->getLogs()[0];
         self::assertSame('', $log['command']);
         self::assertStringStartsWith('220 ', $log['responses'][0]);
@@ -128,6 +129,19 @@ public function testLogs() : void
         self::assertEmpty($this->smtp->getLogs());
     }
 
+    public function testLogsDisabled() : void
+    {
+        \sleep(5);
+        $smtp = new SMTPMailer([
+            'host' => \getenv('SMTP_HOST'),
+            'username' => \getenv('SMTP_USERNAME'),
+            'password' => \getenv('SMTP_PASSWORD'),
+            'add_logs' => false,
+        ]);
+        $smtp->send($this->getMessage());
+        self::assertEmpty($smtp->getLogs());
+    }
+
     public function testConfigs() : void
     {
         foreach ($this->smtp->getConfigs() as $key => $value) {