<?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\Util\EMailer;
use Exception;
+use Friendica\App;
use Friendica\App\BaseURL;
-use Friendica\Core\Config\IConfig;
+use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\L10n;
use Friendica\Core\Renderer;
use Friendica\Model\User;
-use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Network\HTTPException\UnprocessableEntityException;
use Friendica\Object\Email;
use Friendica\Object\EMail\IEmail;
+use Psr\Log\LoggerInterface;
/**
* A base class for building new emails
/** @var L10n */
protected $l10n;
- /** @var IConfig */
+ /** @var IManageConfigValues */
protected $config;
/** @var BaseURL */
protected $baseUrl;
+ /** @var LoggerInterface */
+ protected $logger;
- /** @var string */
+ /** @var string[][] */
protected $headers;
/** @var string */
/** @var int */
protected $recipientUid = null;
- public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config)
+ public function __construct(L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, LoggerInterface $logger)
{
$this->l10n = $l10n;
$this->baseUrl = $baseUrl;
$this->config = $config;
+ $this->logger = $logger;
- $hostname = $baseUrl->getHostname();
+ $hostname = $baseUrl->getHost();
if (strpos($hostname, ':')) {
$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' => [App::PLATFORM],
+ 'X-Friendica-Version' => [App::VERSION],
+ 'List-ID' => ['<notification.' . $hostname . '>'],
+ 'List-Archive' => ['<' . $baseUrl . '/notifications/system>'],
+ ];
}
/**
/**
* Adds the User ID to the email in case the mail sending needs additional properties of this user
*
- * @todo Once the user array is replaced with a user entity, replace this array parameter as well
* @param array $user The user entity/array, for which the email should be sent
*
* @return static
+ * @todo Once the user array is replaced with a user entity, replace this array parameter as well
*/
public function forUser(array $user)
{
$this->recipientUid = $user['uid'] ?? 0;
try {
- $this->l10n = $user['language'] ? $this->l10n->withLang($user['language']) : $this->l10n;
+ $this->l10n = isset($user['language']) ? $this->l10n->withLang($user['language']) : $this->l10n;
} catch (Exception $e) {
+ $this->logger->warning('cannot use language.', ['user' => $user, 'exception' => $e]);
}
return $this;
return $this;
}
+ /**
+ * Returns the current headers
+ *
+ * @return string[][]
+ */
+ public function getHeaders(): array
+ {
+ return $this->headers;
+ }
+
+ /**
+ * Sets the headers
+ *
+ * Expected format is
+ * [
+ * 'Header1' => ['value1', 'value2', ...],
+ * 'Header2' => ['value3', 'value4', ...],
+ * ...
+ * ]
+ *
+ * @param string[][] $headers
+ * @return $this
+ */
+ public function withHeaders(array $headers): MailBuilder
+ {
+ $this->headers = $headers;
+
+ 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] = [$value];
+
+ return $this;
+ }
+
/**
* Build a email based on the given attributes
*
*
* @return IEmail A new generated email
*
- * @throws InternalServerErrorException
+ * @throws UnprocessableEntityException
* @throws Exception
*/
public function build(bool $raw = false)
}
if (empty($this->recipientAddress)) {
- throw new InternalServerErrorException('Recipient address is missing.');
+ throw new UnprocessableEntityException('Recipient address is missing.');
}
if (empty($this->senderAddress) || empty($this->senderName)) {
- throw new InternalServerErrorException('Sender address or name is missing.');
+ throw new UnprocessableEntityException('Sender address or name is missing.');
}
$this->senderNoReply = $this->senderNoReply ?? $this->senderAddress;
$tpl = Renderer::getMarkupTemplate('email/html.tpl');
$msgHtml = Renderer::replaceMacros($tpl, [
'$title' => $this->l10n->t('Friendica Notification'),
- '$product' => FRIENDICA_PLATFORM,
+ '$product' => App::PLATFORM,
'$htmlversion' => $msgHtml,
'$sitename' => $this->config->get('config', 'sitename'),
'$banner' => $this->config->get('system', 'email_banner',
- $this->baseUrl->get(true) . DIRECTORY_SEPARATOR . self::DEFAULT_EMAIL_BANNER),
+ $this->baseUrl . DIRECTORY_SEPARATOR . self::DEFAULT_EMAIL_BANNER),
]);
}