<?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\Object\EMail;
use Friendica\Util\Emailer;
+use JsonSerializable;
/**
* Interface for a single mail, which can be send through Emailer::send()
*
* @see Emailer::send()
*/
-interface IEmail
+interface IEmail extends JsonSerializable
{
/**
* Gets the senders name for this email
*
* @return string
*/
- function getFromEmail();
+ function getFromAddress();
/**
* Gets the UID of the sender of this email
*
* @return string
*/
- function getToEmail();
+ function getToAddress();
/**
* Gets the subject of this email
/**
* Gets the message body of this email (either html or plaintext)
*
- * @param boolean $text True, if returned as plaintext
+ * @param boolean $plain True, if returned as plaintext
*
* @return string
*/
- function getMessage(bool $text = false);
+ function getMessage(bool $plain = false);
/**
* Gets any additional mail header
* @return string
*/
function getAdditionalMailHeader();
+
+ /**
+ * Returns the current email with a new recipient
+ *
+ * @param string $address The email of the recipient
+ * @param int $uid The (optional) UID of the recipient for further infos
+ *
+ * @return static
+ */
+ function withRecipient(string $address, int $uid);
+
+ /**
+ * @param string $plaintext a new plaintext message for this email
+ * @param string $html a new html message for this email (optional)
+ *
+ * @return static
+ */
+ function withMessage(string $plaintext, string $html = null);
+
+ /**
+ * @return string
+ */
+ function __toString();
}