Merge pull request #11129 from urbalazs/copyright-2022

[friendica.git] / src / Util / EMailer / MailBuilder.php

diff --git a/src/Util/EMailer/MailBuilder.php b/src/Util/EMailer/MailBuilder.php
index cc774f4fb462464fa78aacf4cb3a687cb9f83226..6e892cf254575e5f6c4d2165ceeb133a058e961c 100644 (file)
--- a/src/Util/EMailer/MailBuilder.php
+++ b/src/Util/EMailer/MailBuilder.php
@@ -1,14 +1,33 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Util\EMailer;
 
 use Exception;
 use Friendica\App\BaseURL;
-use Friendica\Core\Config\IConfig;
+use Friendica\Core\Config\Capability\IManageConfigValues;
 use Friendica\Core\L10n;
 use Friendica\Core\Renderer;
 use Friendica\Model\User;
-use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Network\HTTPException\UnprocessableEntityException;
 use Friendica\Object\Email;
 use Friendica\Object\EMail\IEmail;
 use Psr\Log\LoggerInterface;
@@ -23,14 +42,14 @@ abstract class MailBuilder
 
        /** @var L10n */
        protected $l10n;
-       /** @var IConfig */
+       /** @var IManageConfigValues */
        protected $config;
        /** @var BaseURL */
        protected $baseUrl;
        /** @var LoggerInterface */
        protected $logger;
 
-       /** @var string */
+       /** @var string[][] */
        protected $headers;
 
        /** @var string */
@@ -45,7 +64,7 @@ abstract class MailBuilder
        /** @var int */
        protected $recipientUid = null;
 
-       public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, LoggerInterface $logger)
+       public function __construct(L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, LoggerInterface $logger)
        {
                $this->l10n    = $l10n;
                $this->baseUrl = $baseUrl;
@@ -57,13 +76,14 @@ abstract class MailBuilder
                        $hostname = substr($hostname, 0, strpos($hostname, ':'));
                }
 
-               $this->headers = "";
-               $this->headers .= "Precedence: list\n";
-               $this->headers .= "X-Friendica-Host: " . $hostname . "\n";
-               $this->headers .= "X-Friendica-Platform: " . FRIENDICA_PLATFORM . "\n";
-               $this->headers .= "X-Friendica-Version: " . FRIENDICA_VERSION . "\n";
-               $this->headers .= "List-ID: <notification." . $hostname . ">\n";
-               $this->headers .= "List-Archive: <" . $baseUrl->get() . "/notifications/system>\n";
+               $this->headers = [
+                       'Precedence'           => ['list'],
+                       'X-Friendica-Host'     => [$hostname],
+                       'X-Friendica-Platform' => [FRIENDICA_PLATFORM],
+                       'X-Friendica-Version'  => [FRIENDICA_VERSION],
+                       'List-ID'              => ['<notification.' . $hostname . '>'],
+                       'List-Archive'         => ['<' . $baseUrl->get() . '/notifications/system>'],
+               ];
        }
 
        /**
@@ -140,15 +160,61 @@ abstract class MailBuilder
        }
 
        /**
-        * Adds new headers to the default headers
+        * Returns the current headers
+        *
+        * @return string[][]
+        */
+       public function getHeaders()
+       {
+               return $this->headers;
+       }
+
+       /**
+        * Sets the headers
+        *
+        * Expected format is
+        * [
+        *   'Header1' => ['value1', 'value2', ...],
+        *   'Header2' => ['value3', 'value4', ...],
+        *   ...
+        * ]
+        *
+        * @param string[][] $headers
+        * @return $this
+        */
+       public function withHeaders(array $headers)
+       {
+               $this->headers = $headers;
+
+               return $this;
+       }
+
+       /**
+        * Adds a value to a header
+        *
+        * @param string $name The header name
+        * @param string $value The value of the header to add
+        *
+        * @return static
+        */
+       public function addHeader(string $name, string $value)
+       {
+               $this->headers[$name][] = $value;
+
+               return $this;
+       }
+
+       /**
+        * Sets a value to a header (overwrites existing values)
         *
-        * @param string $headers New headers
+        * @param string $name The header name
+        * @param string $value The value to set
         *
         * @return static
         */
-       public function addHeaders(string $headers)
+       public function setHeader(string $name, string $value)
        {
-               $this->headers .= $headers;
+               $this->headers[$name] = [$value];
 
                return $this;
        }
@@ -160,7 +226,7 @@ abstract class MailBuilder
         *
         * @return IEmail A new generated email
         *
-        * @throws InternalServerErrorException
+        * @throws UnprocessableEntityException
         * @throws Exception
         */
        public function build(bool $raw = false)
@@ -175,11 +241,11 @@ abstract class MailBuilder
                }
 
                if (empty($this->recipientAddress)) {
-                       throw new InternalServerErrorException('Recipient address is missing.');
+                       throw new UnprocessableEntityException('Recipient address is missing.');
                }
 
                if (empty($this->senderAddress) || empty($this->senderName)) {
-                       throw new InternalServerErrorException('Sender address or name is missing.');
+                       throw new UnprocessableEntityException('Sender address or name is missing.');
                }
 
                $this->senderNoReply = $this->senderNoReply ?? $this->senderAddress;