Replaced Swiftmailer with PHPMailer.

nomadicjosh · nomadicjosh · commit 65a0ec446e23 · 2023-11-07T22:39:15.000-07:00
diff --git a/Factory/FileLoggerSmtpFactory.php b/Factory/FileLoggerSmtpFactory.php
@@ -12,7 +12,7 @@
 use Qubus\Exception\Exception;
 use Qubus\Log\Logger;
 use Qubus\Log\Loggers\FileLogger;
-use Qubus\Log\Loggers\SwiftMailerLogger;
+use Qubus\Log\Loggers\PHPMailerLogger;
 use ReflectionException;
 use SplObjectStorage;
 
@@ -36,10 +36,10 @@ public static function getLogger(): LoggerInterface
             object: new FileLogger(filesystem: $filesystem, threshold: LogLevel::INFO)
         );
 
-        $mail = SwiftMailerSmtpFactory::create();
+        $mail = PHPMailerSmtpFactory::create();
 
         if (env(key: 'LOGGER_FROM_EMAIL') !== null && env(key: 'LOGGER_TO_EMAIL') !== null) {
-            $storage->attach(object: new SwiftMailerLogger(mailer: $mail, threshold: LogLevel::INFO, params: [
+            $storage->attach(object: new PHPMailerLogger(mailer: $mail, threshold: LogLevel::INFO, params: [
                 'from' => env(key: 'LOGGER_FROM_EMAIL'),
                 'to' => env(key: 'LOGGER_TO_EMAIL'),
                 'subject' => env(key: 'LOGGER_EMAIL_SUBJECT'),
diff --git a/Helpers/core.php b/Helpers/core.php
@@ -5,12 +5,16 @@
 namespace Codefy\Framework\Helpers;
 
 use Codefy\Framework\Codefy;
+use Codefy\Framework\Factory\FileLoggerFactory;
+use Codefy\Framework\Support\CodefyMailer;
 use Qubus\Config\Collection;
 use Qubus\Dbal\Connection;
 use Qubus\Exception\Exception;
 use Qubus\Expressive\OrmBuilder;
+use ReflectionException;
 
 use function file_exists;
+use function Qubus\Security\Helpers\__observer;
 use function Qubus\Support\Helpers\is_false__;
 use function Qubus\Support\Helpers\is_null__;
 use function rtrim;
@@ -106,3 +110,103 @@ function dbal(): Connection
 {
     return Codefy::$PHP->getDbConnection();
 }
+
+/**
+ * Alternative to PHP's native mail function with SMTP support.
+ *
+ * This is a simple mail function to see for testing or for
+ * sending simple email messages.
+ *
+ * @param string|array $to Recipient(s)
+ * @param string $subject Subject of the email.
+ * @param string $message The email body.
+ * @param array $headers An array of headers.
+ * @param array $attachments An array of attachments.
+ * @return bool
+ * @throws Exception|ReflectionException|\PHPMailer\PHPMailer\Exception
+ */
+function mail(string|array $to, string $subject, string $message, array $headers = [], array $attachments = []): bool
+{
+    // Instantiate CodefyMailer.
+    $instance = new CodefyMailer(config: app(name: 'codefy.config'));
+
+    // Set the mailer transport.
+    $instance = config(key: 'mailer.mail_transport') === 'smtp' ? $instance->withSmtp() : $instance->withIsMail();
+
+    // Detect HTML markdown.
+    if (substr_count(haystack: $message, needle: '</') >= 1) {
+        $instance = $instance->withHtml(isHtml: true);
+    }
+
+    // Build recipient(s).
+    $instance = $instance->withTo(address: $to);
+
+    // Set from name and from email from environment variables.
+    __observer()->filter->addFilter('mail.from.name', fn() => env(key: 'MAILER_FROM_NAME'));
+    __observer()->filter->addFilter('mail.from.email', fn() => env(key: 'MAILER_FROM_EMAIL'));
+    // Set charset
+    __observer()->filter->addFilter('mail.charset', fn() => 'utf-8');
+
+    // Loop through the filters.
+    foreach (__observer()->filter->getHooks() as $hook) {
+        if ($hook['hook'] === 'mail.from.name') {
+            $fromName = $hook['callback']();
+        }
+
+        if ($hook['hook'] === 'mail.from.email') {
+            $fromEmail = $hook['callback']();
+        }
+
+        if ($hook['hook'] === 'mail.charset') {
+            $charset = $hook['callback']();
+        }
+    }
+
+    // Set email subject and body.
+    $instance = $instance->withSubject(subject: $subject)->withBody(data: $message);
+
+    // Check for other headers and loop through them.
+    if (!empty($headers)) {
+        foreach ($headers as $name => $content) {
+            if ($name === 'cc') {
+                $instance = $instance->withCc(address: $content);
+            }
+
+            if ($name === 'bcc') {
+                $instance = $instance->withBcc(address: $content);
+            }
+
+            if ($name === 'replyTo') {
+                $instance = $instance->withReplyTo(address: $content);
+            }
+
+            if (! in_array(needle: $name, haystack: ['MIME-Version','to','cc','bcc','replyTo'], strict: true)) {
+                $instance = $instance->withCustomHeader(name: $name, value: $content);
+            }
+        }
+    }
+
+    // Set X-Mailer header
+    $instance = $instance->withXMailer(xmailer: 'CodefyPHP Framework ' . Application::APP_VERSION);
+
+    // Set email charset
+    $instance = $instance->withCharset(charset: $charset ?? 'utf-8');
+
+    // Check if there are attachments and loop through them.
+    if (!empty($attachments)) {
+        foreach ($attachments as $filename => $filepath) {
+            $filename = is_string(value: $filename) ? $filename : '';
+            $instance = $instance->withAttachment(path: $filepath, name: $filename);
+        }
+    }
+
+    // Set sender.
+    $instance = $instance->withFrom(address: $fromEmail ?? '', name: $fromName ?? '');
+
+    try {
+        return $instance->send();
+    } catch (\PHPMailer\PHPMailer\Exception $e) {
+        FileLoggerFactory::getLogger()->error($e->getMessage(), ['function' => '\Codefy\Framework\Helpers\mail']);
+        return false;
+    }
+}
diff --git a/Support/CodefyMailer.php b/Support/CodefyMailer.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codefy\Framework\Support;
+
+use Codefy\Framework\Application;
+use Qubus\Mail\QubusMailer;
+
+final class CodefyMailer extends QubusMailer
+{
+    public const VERSION = Application::APP_VERSION;
+}
