Merge pull request #12591 from MrPetovan/task/2023-licence

[friendica.git] / src / Object / Email.php

diff --git a/src/Object/Email.php b/src/Object/Email.php
index 23e1fcfcd585f702a9f05b753dcefee5df7505c7..f6a72985231af6b58c42518f5664a5069fc1edc4 100644 (file)
--- a/src/Object/Email.php
+++ b/src/Object/Email.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2023, 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\Object;
 
@@ -23,19 +42,19 @@ class Email implements IEmail
 
        /** @var string */
        private $subject;
-       /** @var string */
+       /** @var string|null */
        private $msgHtml;
        /** @var string */
        private $msgText;
 
-       /** @var string */
-       private $additionalMailHeader = '';
+       /** @var string[][] */
+       private $additionalMailHeader;
        /** @var int|null */
-       private $toUid = null;
+       private $toUid;
 
        public function __construct(string $fromName, string $fromAddress, string $replyTo, string $toAddress,
                                    string $subject, string $msgHtml, string $msgText,
-                                   string $additionalMailHeader = '', int $toUid = null)
+                                   array $additionalMailHeader = [], int $toUid = null)
        {
                $this->fromName             = $fromName;
                $this->fromAddress          = $fromAddress;
@@ -91,12 +110,12 @@ class Email implements IEmail
        /**
         * {@inheritDoc}
         */
-       public function getMessage(bool $plain = false)
+       public function getMessage(bool $plain = false): string
        {
                if ($plain) {
                        return $this->msgText;
                } else {
-                       return $this->msgHtml;
+                       return $this->msgHtml ?? '';
                }
        }
 
@@ -108,6 +127,26 @@ class Email implements IEmail
                return $this->additionalMailHeader;
        }
 
+       /**
+        * {@inheritDoc}
+        */
+       public function getAdditionalMailHeaderString()
+       {
+               $headerString = '';
+
+               foreach ($this->additionalMailHeader as $name => $values) {
+                       if (!is_array($values)) {
+                               $values = [$values];
+                       }
+
+                       foreach ($values as $value) {
+                               $headerString .= "$name: $value\r\n";
+                       }
+               }
+
+               return $headerString;
+       }
+
        /**
         * {@inheritDoc}
         */
@@ -117,19 +156,53 @@ class Email implements IEmail
        }
 
        /**
-        * Returns the current email with a new recipient
-        *
-        * @param string $email The email of the recipient
-        * @param int    $uid   The (optional) UID of the recipient for further infos
-        *
-        * @return static
+        * {@inheritDoc}
         */
-       public function withRecipient(string $email, int $uid = null)
+       public function withRecipient(string $address, int $uid = null)
        {
                $newEmail            = clone $this;
-               $newEmail->toAddress = $email;
+               $newEmail->toAddress = $address;
                $newEmail->toUid     = $uid;
 
                return $newEmail;
        }
+
+       /**
+        * {@inheritDoc}
+        */
+       public function withMessage(string $plaintext, string $html = null)
+       {
+               $newMail          = clone $this;
+               $newMail->msgText = $plaintext;
+               $newMail->msgHtml = $html;
+
+               return $newMail;
+       }
+
+       /**
+        * Returns the properties of the email as an array
+        *
+        * @return array
+        */
+       private function toArray()
+       {
+               return get_object_vars($this);
+       }
+
+       /**
+        * @inheritDoc
+        */
+       public function __toString()
+       {
+               return json_encode($this->toArray());
+       }
+
+       /**
+        * @inheritDoc
+        */
+       #[\ReturnTypeWillChange]
+       public function jsonSerialize()
+       {
+               return $this->toArray();
+       }
 }