3 namespace Friendica\Util\EMailer;
6 use Friendica\App\BaseURL;
7 use Friendica\Core\Config\IConfig;
8 use Friendica\Core\L10n;
9 use Friendica\Core\Renderer;
10 use Friendica\Model\User;
11 use Friendica\Network\HTTPException\InternalServerErrorException;
12 use Friendica\Object\Email;
13 use Friendica\Object\EMail\IEmail;
16 * A base class for building new emails
18 abstract class MailBuilder
31 protected $senderName = null;
33 protected $senderAddress = null;
35 protected $senderNoReply = null;
38 protected $recipientAddress = null;
40 protected $recipientUid = null;
42 public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config)
45 $this->baseUrl = $baseUrl;
46 $this->config = $config;
48 $hostname = $baseUrl->getHostname();
49 if (strpos($hostname, ':')) {
50 $hostname = substr($hostname, 0, strpos($hostname, ':'));
54 $this->headers .= "Precedence: list\n";
55 $this->headers .= "X-Friendica-Host: " . $hostname . "\n";
56 $this->headers .= "X-Friendica-Platform: " . FRIENDICA_PLATFORM . "\n";
57 $this->headers .= "X-Friendica-Version: " . FRIENDICA_VERSION . "\n";
58 $this->headers .= "List-ID: <notification." . $hostname . ">\n";
59 $this->headers .= "List-Archive: <" . $baseUrl->get() . "/notifications/system>\n";
63 * Gets the subject of the concrete builder, which inherits this base class
67 abstract protected function getSubject();
70 * Gets the HTML version of the body of the concrete builder, which inherits this base class
74 abstract protected function getHtmlMessage();
77 * Gets the Plaintext version of the body of the concrete builder, which inherits this base class
81 abstract protected function getPlaintextMessage();
84 * Adds the User ID to the email in case the mail sending needs additional properties of this user
86 * @param int $uid The User ID
90 public function forUser(int $uid)
92 $this->recipientUid = $uid;
98 * Adds the sender to the email (if not called/set, the sender will get loaded with the help of the user id)
100 * @param string $name The name of the sender
101 * @param string $address The (email) address of the sender
102 * @param string|null $noReply Optional "no-reply" (email) address (if not set, it's the same as the address)
106 public function withSender(string $name, string $address, string $noReply = null)
108 $this->senderName = $name;
109 $this->senderAddress = $address;
110 $this->senderNoReply = $noReply ?? $this->senderNoReply;
116 * Adds a recipient to the email
118 * @param string $address The (email) address of the recipient
122 public function withRecipient(string $address)
124 $this->recipientAddress = $address;
130 * Build a email based on the given attributes
132 * @param bool $raw True, if the email shouldn't get extended by the default email-template
134 * @return IEmail A new generated email
136 * @throws InternalServerErrorException
139 public function build(bool $raw = false)
141 if ((empty($this->recipientAddress)) &&
142 !empty($this->recipientUid)) {
143 $user = User::getById($this->recipientUid, ['email']);
145 if (!empty($user['email'])) {
146 $this->recipientAddress = $user['email'];
150 if (empty($this->recipientAddress)) {
151 throw new InternalServerErrorException('Recipient address is missing.');
154 if (empty($this->senderAddress) || empty($this->senderName)) {
155 throw new InternalServerErrorException('Sender address or name is missing.');
158 $this->senderNoReply = $this->senderNoReply ?? $this->senderAddress;
160 $msgHtml = $this->getHtmlMessage() ?? '';
163 // load the template for private message notifications
164 $tpl = Renderer::getMarkupTemplate('email/html.tpl');
165 $msgHtml = Renderer::replaceMacros($tpl, [
166 '$banner' => $this->l10n->t('Friendica Notification'),
167 '$product' => FRIENDICA_PLATFORM,
168 '$htmlversion' => $msgHtml,
169 '$sitename' => $this->config->get('config', 'sitename'),
170 '$siteurl' => $this->baseUrl->get(true),
176 $this->senderAddress,
177 $this->senderNoReply,
178 $this->recipientAddress,
179 $this->getSubject() ?? '',
181 $this->getPlaintextMessage() ?? '',
183 $this->recipientUid ?? null);