Merge pull request #9261 from annando/relay-distribution

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

diff --git a/src/Util/EMailer/MailBuilder.php b/src/Util/EMailer/MailBuilder.php
index c640c96b94925894c56cf7c260e926e55ae7d64b..38970a612d590c2078b5f50c5d3fe350f0af145f 100644 (file)
--- a/src/Util/EMailer/MailBuilder.php
+++ b/src/Util/EMailer/MailBuilder.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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;
 
@@ -30,7 +49,7 @@ abstract class MailBuilder
        /** @var LoggerInterface */
        protected $logger;
 
-       /** @var string */
+       /** @var string[][] */
        protected $headers;
 
        /** @var string */
@@ -50,20 +69,21 @@ abstract class MailBuilder
                $this->l10n    = $l10n;
                $this->baseUrl = $baseUrl;
                $this->config  = $config;
-               $this->logger = $logger;
+               $this->logger  = $logger;
 
                $hostname = $baseUrl->getHostname();
                if (strpos($hostname, ':')) {
                        $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>'],
+               ];
        }
 
        /**
@@ -90,10 +110,10 @@ abstract class MailBuilder
        /**
         * Adds the User ID to the email in case the mail sending needs additional properties of this user
         *
-        * @todo Once the user array is replaced with a user entity, replace this array parameter as well
         * @param array $user The user entity/array, for which the email should be sent
         *
         * @return static
+        * @todo Once the user array is replaced with a user entity, replace this array parameter as well
         */
        public function forUser(array $user)
        {
@@ -139,6 +159,66 @@ abstract class MailBuilder
                return $this;
        }
 
+       /**
+        * 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 $name The header name
+        * @param string $value The value to set
+        *
+        * @return static
+        */
+       public function setHeader(string $name, string $value)
+       {
+               $this->headers[$name] = [$value];
+
+               return $this;
+       }
+
        /**
         * Build a email based on the given attributes
         *