3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Object\EMail;
24 use Friendica\Util\Emailer;
28 * Interface for a single mail, which can be send through Emailer::send()
30 * @see Emailer::send()
32 interface IEmail extends JsonSerializable
35 * Gets the senders name for this email
39 function getFromName();
42 * Gets the senders email address for this email
46 function getFromAddress();
49 * Gets the UID of the sender of this email
53 function getRecipientUid();
56 * Gets the reply-to address for this email
60 function getReplyTo();
63 * Gets the senders email address
67 function getToAddress();
70 * Gets the subject of this email
74 function getSubject();
77 * Gets the message body of this email (either html or plaintext)
79 * @param boolean $plain True, if returned as plaintext
83 function getMessage(bool $plain = false): string;
86 * Gets the additional mail header array
90 function getAdditionalMailHeader();
93 * Gets the additional mail header as string - EOL separated
97 function getAdditionalMailHeaderString();
100 * Returns the current email with a new recipient
102 * @param string $address The email of the recipient
103 * @param int $uid The (optional) UID of the recipient for further infos
107 function withRecipient(string $address, int $uid);
110 * @param string $plaintext a new plaintext message for this email
111 * @param string $html a new html message for this email (optional)
115 function withMessage(string $plaintext, string $html = null);
120 function __toString();