Transform email header string to header array & replace it at various situations.
[friendica.git/.git] / src / Util / EMailer / MailBuilder.php
index c47d22d..6a7412f 100644 (file)
@@ -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 */
@@ -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>'],
+               ];
        }
 
        /**
@@ -139,6 +159,37 @@ abstract class MailBuilder
                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] = [];
+               $this->headers[$name][] = $value;
+
+               return $this;
+       }
+
        /**
         * Build a email based on the given attributes
         *