[Feature] Email Manager

.github/workflows/tests.yml

@@ -15,10 +15,9 @@ jobs:
       fail-fast: false
       matrix:
         php-versions:
-          - '7.3'
-          - '7.4'
-          - '8.0'
           - '8.1'
+          - '8.2'
+          - '8.3'
     steps:
       - uses: actions/checkout@v2
 
@@ -52,10 +51,9 @@ jobs:
       fail-fast: false
       matrix:
         php-versions:
-          - '7.3'
-          - '7.4'
-          - '8.0'
           - '8.1'
+          - '8.2'
+          - '8.3'
     steps:
       - uses: actions/checkout@v2
 
@@ -90,10 +88,9 @@ jobs:
       fail-fast: false
       matrix:
         php-versions:
-          - '7.3'
-          - '7.4'
-          - '8.0'
           - '8.1'
+          - '8.2'
+          - '8.3'
 
     services:
       mysql:

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
+- Add an `EmailManager` to configure `PHPMailer` via environment variables ([#22](https://github.com/studiometa/wp-toolkit/pull/22))
 - Add a `Plugin::disable` method to the `Plugin` helper class ([#26](https://github.com/studiometa/wp-toolkit/pull/26))
 - Add a `request` helper function  ([#26](https://github.com/studiometa/wp-toolkit/pull/26))
 - Add a `Request` helper class ([#26](https://github.com/studiometa/wp-toolkit/pull/26))

composer.json

@@ -6,10 +6,12 @@
   "type": "library",
   "require": {
     "php": "^8.1",
-    "symfony/yaml": "^6.4|^7.0",
+    "monolog/monolog": "^2.9|^3.0",
+    "psr/log": "^1.1",
     "studiometa/webpack-config": "^5.0",
-    "wecodemore/wordpress-early-hook": "^1.2",
-    "symfony/http-foundation": "^6.4|^7.0"
+    "symfony/http-foundation": "^6.4|^7.0",
+    "symfony/yaml": "^6.4|^7.0",
+    "wecodemore/wordpress-early-hook": "^1.2"
   },
   "require-dev": {
     "squizlabs/php_codesniffer": "^3.4",
@@ -46,6 +48,7 @@
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true,
       "phpstan/extension-installer": true
-    }
+    },
+    "sort-packages": true
   }
 }

src/Managers/EmailManager.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * Configure emails.
+ *
+ * @package Studiometa\WPToolkit
+ */
+
+namespace Studiometa\WPToolkit\Managers;
+
+use WP_Error;
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+use Psr\Log\LoggerInterface;
+use PHPMailer\PHPMailer\PHPMailer;
+use function Studiometa\WPToolkit\env;
+
+/** Class **/
+class EmailManager implements ManagerInterface
+{
+    /**
+     * Logger instance.
+     *
+     * @var LoggerInterface|null;
+     */
+    private $logger;
+
+    /**
+     * Class constructor.
+     *
+     * @param LoggerInterface|null $logger A logger instance to log mail actions.
+     */
+    public function __construct(?LoggerInterface $logger = null)
+    {
+        if (! is_null($logger)) {
+            $this->logger = $logger;
+        } elseif (env('MAIL_LOG')) {
+            $this->logger = new Logger('email');
+            $this->logger->pushHandler(new StreamHandler(env('MAIL_LOG')));
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function run()
+    {
+        if ('smtp' === env('MAIL_MAILER')) {
+            add_action('phpmailer_init', array( $this, 'configure_smtp' ));
+        }
+
+        if ($this->logger) {
+            add_action('wp_mail_succeeded', array( $this, 'log_success' ));
+            add_action('wp_mail_failed', array( $this, 'log_failure' ));
+        }
+    }
+
+    /**
+     * Configure SMTP server to send mails.
+     *
+     * @param  PHPMailer $mailer The PHPMailer instance.
+     * @return void
+     */
+    public function configure_smtp(PHPMailer $mailer): void
+    {
+		// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $mailer->Host       = env('MAIL_HOST');
+        $mailer->Port       = (int) env('MAIL_PORT');
+        $mailer->Username   = env('MAIL_USERNAME');
+        $mailer->Password   = env('MAIL_PASSWORD');
+        $mailer->SMTPAuth   = 'true' === env('MAIL_AUTH');
+        $mailer->SMTPSecure = env('MAIL_ENCRYPTION');
+        $mailer->IsSMTP();
+		// phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+    }
+
+    /**
+     * Log successfully sent mails.
+     *
+     * @param array{
+     *   to: string[],
+     *   subject: string,
+     *   message: string,
+     *   headers: string[],
+     *   attachments: string[]
+     * } $mail_data An array containing the email recipient(s), subject, message, headers, and attachments.
+     *
+     * @return void
+     */
+    public function log_success(array $mail_data): void
+    {
+        if ($this->logger) {
+            $this->logger->info('Mail sent', $mail_data);
+        }
+    }
+
+    /**
+     * Log failure happening when sending mails.
+     *
+     * @param  WP_Error $error The error sent.
+     *
+     * @return void
+     */
+    public function log_failure(WP_Error $error): void
+    {
+        if ($this->logger) {
+            /**
+             * Mail data.
+             *
+             * @var array
+             */
+            $mail_data = $error->get_error_data();
+            $this->logger->error($error->get_error_message(), $mail_data);
+        }
+    }
+}