class.ilMail.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */

use ILIAS\BackgroundTasks\Implementation\Bucket\BasicBucket;

class ilMail
{
    public const ILIAS_HOST = 'ilias';
    public const PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix';

    protected $lng;

    protected $db;

    protected $mfile;

    protected $mail_options;

    protected $mailbox;

    public $user_id;

    protected $table_mail;

    protected $table_mail_saved;

    protected $mail_data = array();

    protected $mail_obj_ref_id;

    protected $save_in_sentbox;

    protected $appendInstallationSignature = false;

    private $eventHandler;

    private $mailAddressTypeFactory;

    private $mailAddressParserFactory;

    protected $contextId = null;

    protected $contextParameters = [];

    protected $logger;

    protected $mailOptionsByUsrIdMap = [];

    protected $userInstancesByIdMap = [];

    protected $usrIdByLoginCallable = null;

    protected $maxRecipientCharacterLength = 998;

    protected $senderFactory;

    public function __construct(
        $a_user_id,
        ilMailAddressTypeFactory $mailAddressTypeFactory = null,
        ilMailRfc822AddressParserFactory $mailAddressParserFactory = null,
        ilAppEventHandler $eventHandler = null,
        ilLogger $logger = null,
        ilDBInterface $db = null,
        ilLanguage $lng = null,
        ilFileDataMail $mailFileData = null,
        ilMailOptions $mailOptions = null,
        ilMailbox $mailBox = null,
        ilMailMimeSenderFactory $senderFactory = null,
        callable $usrIdByLoginCallable = null,
        int $mailAdminNodeRefId = null
    ) {
        global $DIC;

        if ($logger === null) {
            $logger = ilLoggerFactory::getLogger('mail');
        }
        if ($mailAddressTypeFactory === null) {
            $mailAddressTypeFactory = new ilMailAddressTypeFactory(null, $logger);
        }
        if ($mailAddressParserFactory === null) {
            $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
        }
        if ($eventHandler === null) {
            $eventHandler = $DIC->event();
        }
        if ($db === null) {
            $db = $DIC->database();
        }
        if ($lng === null) {
            $lng = $DIC->language();
        }
        if ($mailFileData === null) {
            $mailFileData = new ilFileDataMail($a_user_id);
        }
        if ($mailOptions === null) {
            $mailOptions = new ilMailOptions($a_user_id);
        }
        if ($mailBox === null) {
            $mailBox = new ilMailbox($a_user_id);
        }
        if ($senderFactory === null) {
            $senderFactory = $GLOBALS["DIC"]["mail.mime.sender.factory"];
        }
        if ($usrIdByLoginCallable === null) {
            $usrIdByLoginCallable = function (string $login) {
                return ilObjUser::_lookupId($login);
            };
        }

        $this->user_id = (int) $a_user_id;
        $this->mailAddressParserFactory = $mailAddressParserFactory;
        $this->mailAddressTypeFactory = $mailAddressTypeFactory;
        $this->eventHandler = $eventHandler;
        $this->logger = $logger;
        $this->db = $db;
        $this->lng = $lng;
        $this->mfile = $mailFileData;
        $this->mail_options = $mailOptions;
        $this->mailbox = $mailBox;
        $this->senderFactory = $senderFactory;
        $this->usrIdByLoginCallable = $usrIdByLoginCallable;

        $this->mail_obj_ref_id = $mailAdminNodeRefId;
        if (null === $this->mail_obj_ref_id) {
            $this->readMailObjectReferenceId();
        }

        $this->lng->loadLanguageModule('mail');
        $this->table_mail = 'mail';
        $this->table_mail_saved = 'mail_saved';
        $this->setSaveInSentbox(false);
    }

    public function withContextId(string $contextId) : self
    {
        $clone = clone $this;

        $clone->contextId = $contextId;

        return $clone;
    }

    public function withContextParameters(array $parameters) : self
    {
        $clone = clone $this;

        $clone->contextParameters = $parameters;

        return $clone;
    }

    protected function isSystemMail() : bool
    {
        return $this->user_id == ANONYMOUS_USER_ID;
    }

    public function existsRecipient(string $newRecipient, string $existingRecipients) : bool
    {
        $newAddresses = new ilMailAddressListImpl($this->parseAddresses($newRecipient));
        $addresses = new ilMailAddressListImpl($this->parseAddresses($existingRecipients));

        $list = new ilMailDiffAddressList($newAddresses, $addresses);

        $diffedAddresses = $list->value();

        return count($diffedAddresses) === 0;
    }

    public function setSaveInSentbox(bool $saveInSentbox) : void
    {
        $this->save_in_sentbox = (bool) $saveInSentbox;
    }

    public function getSaveInSentbox() : bool
    {
        return (bool) $this->save_in_sentbox;
    }

    protected function readMailObjectReferenceId() : void
    {
        $this->mail_obj_ref_id = (int) ilMailGlobalServices::getMailObjectRefId();
    }

    public function getMailObjectReferenceId() : int
    {
        return $this->mail_obj_ref_id;
    }

    public function formatNamesForOutput(string $recipients) : string
    {
        global $DIC;

        $recipients = trim($recipients);
        if (0 === strlen($recipients)) {
            return $this->lng->txt('not_available');
        }

        $names = [];

        $recipients = array_filter(array_map('trim', explode(',', $recipients)));
        foreach ($recipients as $recipient) {
            $usrId = ilObjUser::_lookupId($recipient);
            if ($usrId > 0) {
                $pp = ilObjUser::_lookupPref($usrId, 'public_profile');
                if ($pp === 'g' || ($pp === 'y' && !$DIC->user()->isAnonymous())) {
                    $user = $this->getUserInstanceById($usrId);
                    if ($user) {
                        $names[] = $user->getFullname() . ' [' . $recipient . ']';
                        continue;
                    }
                }
            }

            $names[] = $recipient;
        }

        return implode(', ', $names);
    }

    public function getPreviousMail(int $mailId) : ?array
    {
        $this->db->setLimit(1, 0);

        $query = implode(' ', [
            "SELECT b.* FROM {$this->table_mail} a",
            "INNER JOIN {$this->table_mail} b ON b.folder_id = a.folder_id",
            'AND b.user_id = a.user_id AND b.send_time > a.send_time',
            'WHERE a.user_id = %s AND a.mail_id = %s ORDER BY b.send_time ASC',
        ]);
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

    public function getNextMail(int $mailId) : ?array
    {
        $this->db->setLimit(1, 0);

        $query = implode(' ', [
            "SELECT b.* FROM {$this->table_mail} a",
            "INNER JOIN {$this->table_mail} b ON b.folder_id = a.folder_id",
            'AND b.user_id = a.user_id AND b.send_time < a.send_time',
            'WHERE a.user_id = %s AND a.mail_id = %s ORDER BY b.send_time DESC',
        ]);
        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

    public function getMailsOfFolder($a_folder_id, $filter = []) : array
    {
        $mails = [];

        $query =
            "SELECT sender_id, m_subject, mail_id, m_status, send_time " .
            "FROM {$this->table_mail} " .
            "LEFT JOIN object_data ON obj_id = sender_id " .
            "WHERE user_id = %s AND folder_id = %s " .
            "AND ((sender_id > 0 AND sender_id IS NOT NULL AND obj_id IS NOT NULL) OR (sender_id = 0 OR sender_id IS NULL))";

        if (isset($filter['status']) && strlen($filter['status']) > 0) {
            $query .= ' AND m_status = ' . $this->db->quote($filter['status'], 'text');
        }

        $query .= " ORDER BY send_time DESC";

        $res = $this->db->queryF(
            $query,
            ['integer', 'integer'],
            [$this->user_id, $a_folder_id]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $mails[] = $this->fetchMailData($row);
        }

        return array_filter($mails);
    }

    public function countMailsOfFolder(int $folderId) : int
    {
        $res = $this->db->queryF(
            "SELECT COUNT(*) FROM {$this->table_mail} WHERE user_id = %s AND folder_id = %s",
            ['integer', 'integer'],
            [$this->user_id, $folderId]
        );

        return $this->db->numRows($res);
    }

    public function deleteMailsOfFolder(int $folderId) : void
    {
        $mails = $this->getMailsOfFolder($folderId);
        foreach ($mails as $mail_data) {
            $this->deleteMails([$mail_data['mail_id']]);
        }
    }

    public function getMail(int $mailId) : ?array
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->table_mail} WHERE user_id = %s AND mail_id = %s",
            ['integer', 'integer'],
            [$this->user_id, $mailId]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

    public function markRead(array $mailIds) : void
    {
        $values = [];
        $types = [];

        $query = "UPDATE {$this->table_mail} SET m_status = %s WHERE user_id = %s ";
        array_push($types, 'text', 'integer');
        array_push($values, 'read', $this->user_id);

        if (count($mailIds) > 0) {
            $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');
        }

        $this->db->manipulateF($query, $types, $values);
    }

    public function markUnread(array $mailIds) : void
    {
        $values = array();
        $types = array();

        $query = "UPDATE {$this->table_mail} SET m_status = %s WHERE user_id = %s ";
        array_push($types, 'text', 'integer');
        array_push($values, 'unread', $this->user_id);

        if (count($mailIds) > 0) {
            $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');
        }

        $this->db->manipulateF($query, $types, $values);
    }

    public function moveMailsToFolder(array $mailIds, int $folderId) : bool
    {
        $values = [];
        $types = [];

        $mailIds = array_filter(array_map('intval', $mailIds));

        if (0 === count($mailIds)) {
            return false;
        }

        $query =
            "UPDATE {$this->table_mail} " .
            "INNER JOIN mail_obj_data " .
            "ON mail_obj_data.obj_id = %s AND mail_obj_data.user_id = %s " .
            "SET {$this->table_mail}.folder_id = mail_obj_data.obj_id " .
            "WHERE {$this->table_mail}.user_id = %s";
        array_push($types, 'integer', 'integer', 'integer');
        array_push($values, $folderId, $this->user_id, $this->user_id);

        $query .= ' AND ' . $this->db->in('mail_id', $mailIds, false, 'integer');

        $affectedRows = $this->db->manipulateF($query, $types, $values);

        return $affectedRows > 0;
    }

    public function deleteMails(array $mailIds) : void
    {
        $mailIds = array_filter(array_map('intval', $mailIds));
        foreach ($mailIds as $id) {
            $this->db->manipulateF(
                "DELETE FROM {$this->table_mail} WHERE user_id = %s AND mail_id = %s",
                ['integer', 'integer'],
                [$this->user_id, $id]
            );
            $this->mfile->deassignAttachmentFromDirectory($id);
        }
    }

    protected function fetchMailData(?array $row) : ?array
    {
        if (!is_array($row) || empty($row)) {
            return null;
        }

        $row['attachments'] = unserialize(stripslashes($row['attachments']));
        $row['tpl_ctx_params'] = (array) (@json_decode($row['tpl_ctx_params'], true));

        return $row;
    }

    public function getNewDraftId(int $usrId, int $folderId) : int
    {
        $nextId = (int) $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, [
            'mail_id' => ['integer', $nextId],
            'user_id' => ['integer', $usrId],
            'folder_id' => ['integer', $folderId],
            'sender_id' => ['integer', $usrId]
        ]);

        return $nextId;
    }

    public function updateDraft(
        $a_folder_id,
        $a_attachments,
        $a_rcp_to,
        $a_rcp_cc,
        $a_rcp_bcc,
        $a_m_email,
        $a_m_subject,
        $a_m_message,
        $a_draft_id = 0,
        $a_use_placeholders = 0,
        $a_tpl_context_id = null,
        $a_tpl_context_params = []
    ) {
        $this->db->update(
            $this->table_mail,
            [
                'folder_id' => ['integer', $a_folder_id],
                'attachments' => ['clob', serialize($a_attachments)],
                'send_time' => ['timestamp', date('Y-m-d H:i:s', time())],
                'rcp_to' => ['clob', $a_rcp_to],
                'rcp_cc' => ['clob', $a_rcp_cc],
                'rcp_bcc' => ['clob', $a_rcp_bcc],
                'm_status' => ['text', 'read'],
                'm_email' => ['integer', $a_m_email],
                'm_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', @json_encode((array) $a_tpl_context_params)]
            ],
            [
                'mail_id' => ['integer', $a_draft_id]
            ]
        );

        return $a_draft_id;
    }

    private function sendInternalMail(
        $folderId,
        $senderUsrId,
        $attachments,
        $to,
        $cc,
        $bcc,
        $status,
        $email,
        $subject,
        $message,
        $usrId = 0,
        $usePlaceholders = 0,
        $templateContextId = null,
        $templateContextParameters = []
    ) : int {
        $usrId = $usrId ? $usrId : $this->user_id;

        if ($usePlaceholders) {
            $message = $this->replacePlaceholders($message, $usrId);
        }
        $message = $this->formatLinebreakMessage((string) $message);
        $message = str_ireplace(["<br />", "<br>", "<br/>"], "\n", $message);

        if (!$usrId) {
            $usrId = '0';
        }
        if (!$folderId) {
            $folderId = '0';
        }
        if (!$senderUsrId) {
            $senderUsrId = null;
        }
        if (!$attachments) {
            $attachments = null;
        }
        if (!$to) {
            $to = null;
        }
        if (!$cc) {
            $cc = null;
        }
        if (!$bcc) {
            $bcc = null;
        }
        if (!$status) {
            $status = null;
        }
        if (!$email) {
            $email = null;
        }
        if (!$subject) {
            $subject = null;
        }
        if (!$message) {
            $message = null;
        }

        $nextId = (int) $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, array(
            'mail_id' => array('integer', $nextId),
            'user_id' => array('integer', $usrId),
            'folder_id' => array('integer', $folderId),
            'sender_id' => array('integer', $senderUsrId),
            'attachments' => array('clob', serialize($attachments)),
            'send_time' => array('timestamp', date('Y-m-d H:i:s', time())),
            'rcp_to' => array('clob', $to),
            'rcp_cc' => array('clob', $cc),
            'rcp_bcc' => array('clob', $bcc),
            'm_status' => array('text', $status),
            'm_email' => array('integer', $email),
            'm_subject' => array('text', $subject),
            'm_message' => array('clob', $message),
            'tpl_ctx_id' => array('text', $templateContextId),
            'tpl_ctx_params' => array('blob', @json_encode((array) $templateContextParameters))
        ));

        $raiseEvent = (int) $usrId !== $this->mailbox->getUsrId();
        if (!$raiseEvent) {
            $raiseEvent = (int) $folderId !== $this->mailbox->getSentFolder();
        }

        if ($raiseEvent) {
            $this->eventHandler->raise('Services/Mail', 'sentInternalMail', [
                'id' => $nextId,
                'subject' => (string) $subject,
                'body' => (string) $message,
                'from_usr_id' => (int) $senderUsrId,
                'to_usr_id' => (int) $usrId,
                'rcp_to' => (string) $to,
                'rcp_cc' => (string) $cc,
                'rcp_bcc' => (string) $bcc,
            ]);
        }

        return $nextId;
    }

    protected function replacePlaceholders(
        string $message,
        int $usrId = 0,
        bool $replaceEmptyPlaceholders = true
    ) : string {
        try {
            if ($this->contextId) {
                $context = ilMailTemplateContextService::getTemplateContextById($this->contextId);
            } else {
                $context = new ilMailTemplateGenericContext();
            }

            $user = $usrId > 0 ? $this->getUserInstanceById($usrId) : null;

            $processor = new ilMailTemplatePlaceholderResolver($context, $message);
            $message = $processor->resolve($user, $this->contextParameters, $replaceEmptyPlaceholders);
        } catch (Exception $e) {
            $this->logger->error(__METHOD__ . ' has been called with invalid context.');
        }

        return $message;
    }

    protected function distributeMail(
        string $to,
        string $cc,
        string $bcc,
        string $subject,
        string $message,
        array $attachments,
        int $sentMailId,
        bool $usePlaceholders = false
    ) : bool {
        if ($usePlaceholders) {
            $toUsrIds = $this->getUserIds([$to]);
            $this->logger->debug(sprintf(
                "Parsed TO user ids from given recipients for serial letter notification: %s",
                implode(', ', $toUsrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $toUsrIds,
                $subject,
                $message,
                $attachments,
                $sentMailId,
                true
            );

            $otherUsrIds = $this->getUserIds([$cc, $bcc]);
            $this->logger->debug(sprintf(
                "Parsed CC/BCC user ids from given recipients for serial letter notification: %s",
                implode(', ', $otherUsrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $otherUsrIds,
                $subject,
                $this->replacePlaceholders($message, 0, false),
                $attachments,
                $sentMailId,
                false
            );
        } else {
            $usrIds = $this->getUserIds([$to, $cc, $bcc]);
            $this->logger->debug(sprintf(
                "Parsed TO/CC/BCC user ids from given recipients: %s",
                implode(', ', $usrIds)
            ));

            $this->sendChanneledMails(
                $to,
                $cc,
                $bcc,
                $usrIds,
                $subject,
                $message,
                $attachments,
                $sentMailId,
                false
            );
        }

        return true;
    }

    protected function sendChanneledMails(
        string $to,
        string $cc,
        string $bcc,
        array $usrIds,
        string $subject,
        string $message,
        array $attachments,
        int $sentMailId,
        bool $usePlaceholders = false
    ) : void {
        $usrIdToExternalEmailAddressesMap = [];
        $usrIdToMessageMap = [];

        foreach ($usrIds as $usrId) {
            $user = $this->getUserInstanceById($usrId);
            if (!($user instanceof ilObjUser)) {
                $this->logger->critical(sprintf(
                    "Skipped recipient with id %s (User not found)",
                    $usrId
                ));
                continue;
            }

            $mailOptions = $this->getMailOptionsByUserId($user->getId());

            $canReadInternalMails = !$user->hasToAcceptTermsOfService() && $user->checkTimeLimit();

            if ($this->isSystemMail() && !$canReadInternalMails) {
                $this->logger->debug(sprintf(
                    "Skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                    $usrId,
                    var_export(!$user->hasToAcceptTermsOfService(), true),
                    var_export(!$user->checkTimeLimit(), true)
                ));
                continue;
            }

            $individualMessage = $message;
            if ($usePlaceholders) {
                $individualMessage = $this->replacePlaceholders($message, $user->getId());
                $usrIdToMessageMap[$user->getId()] = $individualMessage;
            }

            if ($user->getActive()) {
                $wantsToReceiveExternalEmail = (
                    $mailOptions->getIncomingType() == ilMailOptions::INCOMING_EMAIL ||
                    $mailOptions->getIncomingType() == ilMailOptions::INCOMING_BOTH
                );

                if (!$canReadInternalMails || $wantsToReceiveExternalEmail) {
                    $emailAddresses = $mailOptions->getExternalEmailAddresses();
                    $usrIdToExternalEmailAddressesMap[$user->getId()] = $emailAddresses;

                    if ($mailOptions->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                        $this->logger->debug(sprintf(
                            "Recipient with id %s will only receive external emails sent to: %s",
                            $user->getId(),
                            implode(', ', $emailAddresses)
                        ));
                        continue;
                    } else {
                        $this->logger->debug(sprintf(
                            "Recipient with id %s will additionally receive external emails " .
                            "(because the user wants to receive it externally, or the user cannot access " .
                            "the internal mail system) sent to: %s",
                            $user->getId(),
                            implode(', ', $emailAddresses)
                        ));
                    }
                } else {
                    $this->logger->debug(sprintf(
                        "Recipient with id %s is does not want to receive external emails",
                        $user->getId()
                    ));
                }
            } else {
                $this->logger->debug(sprintf(
                    "Recipient with id %s is inactive and will not receive external emails",
                    $user->getId()
                ));
            }

            $mbox = clone $this->mailbox;
            $mbox->setUsrId((int) $user->getId());
            $recipientInboxId = $mbox->getInboxFolder();

            $internalMailId = $this->sendInternalMail(
                $recipientInboxId,
                $this->user_id,
                $attachments,
                $to,
                $cc,
                '',
                'unread',
                0,
                $subject,
                $individualMessage,
                $user->getId(),
                0
            );

            if (count($attachments) > 0) {
                $this->mfile->assignAttachmentsToDirectory($internalMailId, $sentMailId);
            }
        }

        $this->delegateExternalEmails(
            $subject,
            $message,
            $attachments,
            $usePlaceholders,
            $usrIdToExternalEmailAddressesMap,
            $usrIdToMessageMap
        );
    }

    protected function delegateExternalEmails(
        string $subject,
        string $message,
        array $attachments,
        bool $usePlaceholders,
        array $usrIdToExternalEmailAddressesMap,
        array $usrIdToMessageMap
    ) : void {
        if (1 === count($usrIdToExternalEmailAddressesMap)) {
            if ($usePlaceholders) {
                $message = array_values($usrIdToMessageMap)[0];
            }

            $usrIdToExternalEmailAddressesMap = array_values($usrIdToExternalEmailAddressesMap);
            $firstAddresses = current($usrIdToExternalEmailAddressesMap);

            $this->sendMimeMail(
                implode(',', $firstAddresses),
                '',
                '',
                $subject,
                $this->formatLinebreakMessage($message),
                (array) $attachments
            );
        } elseif (count($usrIdToExternalEmailAddressesMap) > 1) {
            if ($usePlaceholders) {
                foreach ($usrIdToExternalEmailAddressesMap as $usrId => $addresses) {
                    if (0 === count($addresses)) {
                        continue;
                    }

                    $this->sendMimeMail(
                        implode(',', $addresses),
                        '',
                        '',
                        $subject,
                        $this->formatLinebreakMessage($usrIdToMessageMap[$usrId]),
                        (array) $attachments
                    );
                }
            } else {
                $flattenEmailAddresses = iterator_to_array(new RecursiveIteratorIterator(new RecursiveArrayIterator(
                    $usrIdToExternalEmailAddressesMap
                )), false);

                $flattenEmailAddresses = array_unique($flattenEmailAddresses);

                // https://mantis.ilias.de/view.php?id=23981 and https://www.ietf.org/rfc/rfc2822.txt
                $remainingAddresses = '';
                foreach ($flattenEmailAddresses as $emailAddress) {
                    $sep = '';
                    if (strlen($remainingAddresses) > 0) {
                        $sep = ',';
                    }

                    $recipientsLineLength = ilStr::strLen($remainingAddresses) + ilStr::strLen($sep . $emailAddress);
                    if ($recipientsLineLength >= $this->maxRecipientCharacterLength) {
                        $this->sendMimeMail(
                            '',
                            '',
                            $remainingAddresses,
                            $subject,
                            $this->formatLinebreakMessage($message),
                            (array) $attachments
                        );

                        $remainingAddresses = '';
                        $sep = '';
                    }

                    $remainingAddresses .= ($sep . $emailAddress);
                }

                if ('' !== $remainingAddresses) {
                    $this->sendMimeMail(
                        '',
                        '',
                        $remainingAddresses,
                        $subject,
                        $this->formatLinebreakMessage($message),
                        (array) $attachments
                    );
                }
            }
        }
    }

    protected function getUserIds(array $recipients) : array
    {
        $usrIds = array();

        $joinedRecipients = implode(',', array_filter(array_map('trim', $recipients)));

        $addresses = $this->parseAddresses($joinedRecipients);
        foreach ($addresses as $address) {
            $addressType = $this->mailAddressTypeFactory->getByPrefix($address);
            $usrIds = array_merge($usrIds, $addressType->resolve());
        }

        return array_unique($usrIds);
    }

    protected function checkMail(string $to, string $cc, string $bcc, string $subject) : array
    {
        $errors = [];

        foreach ([
                     $subject => 'mail_add_subject',
                     $to => 'mail_add_recipient'
                 ] as $string => $error
        ) {
            if (0 === strlen($string)) {
                $errors[] = new ilMailError($error);
            }
        }

        return $errors;
    }

    protected function checkRecipients(string $recipients) : array
    {
        $errors = [];

        try {
            $addresses = $this->parseAddresses($recipients);
            foreach ($addresses as $address) {
                $addressType = $this->mailAddressTypeFactory->getByPrefix($address);
                if (!$addressType->validate($this->user_id)) {
                    $newErrors = $addressType->getErrors();
                    $errors = array_merge($errors, $newErrors);
                }
            }
        } catch (ilException $e) {
            $colonPosition = strpos($e->getMessage(), ':');
            throw new ilMailException(
                ($colonPosition === false) ? $e->getMessage() : substr($e->getMessage(), $colonPosition + 2)
            );
        }

        return $errors;
    }

    public function savePostData(
        $a_user_id,
        $a_attachments,
        $a_rcp_to,
        $a_rcp_cc,
        $a_rcp_bcc,
        $a_m_email,
        $a_m_subject,
        $a_m_message,
        $a_use_placeholders,
        $a_tpl_context_id = null,
        $a_tpl_ctx_params = array()
    ) {
        if (!$a_attachments) {
            $a_attachments = null;
        }
        if (!$a_rcp_to) {
            $a_rcp_to = null;
        }
        if (!$a_rcp_cc) {
            $a_rcp_cc = null;
        }
        if (!$a_rcp_bcc) {
            $a_rcp_bcc = null;
        }
        if (!$a_m_email) {
            $a_m_email = null;
        }
        if (!$a_m_message) {
            $a_m_message = null;
        }
        if (!$a_use_placeholders) {
            $a_use_placeholders = '0';
        }

        $this->db->replace(
            $this->table_mail_saved,
            [
                'user_id' => ['integer', $this->user_id]
            ],
            [
                'attachments' => ['clob', serialize($a_attachments)],
                'rcp_to' => ['clob', $a_rcp_to],
                'rcp_cc' => ['clob', $a_rcp_cc],
                'rcp_bcc' => ['clob', $a_rcp_bcc],
                'm_email' => ['integer', $a_m_email],
                'm_subject' => ['text', $a_m_subject],
                'm_message' => ['clob', $a_m_message],
                'use_placeholders' => ['integer', $a_use_placeholders],
                'tpl_ctx_id' => ['text', $a_tpl_context_id],
                'tpl_ctx_params' => ['blob', json_encode((array) $a_tpl_ctx_params)]
            ]
        );

        $this->getSavedData();

        return true;
    }

    public function getSavedData() : ?array
    {
        $res = $this->db->queryF(
            "SELECT * FROM {$this->table_mail_saved} WHERE user_id = %s",
            ['integer'],
            [$this->user_id]
        );

        $this->mail_data = $this->fetchMailData($this->db->fetchAssoc($res));

        return $this->mail_data;
    }

    public function enqueue(
        $a_rcp_to,
        $a_rcp_cc,
        $a_rcp_bcc,
        $a_m_subject,
        $a_m_message,
        $a_attachment,
        $a_use_placeholders = 0
    ) : array {
        global $DIC;

        $this->logger->info(
            "New mail system task:" .
            " To: " . $a_rcp_to .
            " | CC: " . $a_rcp_cc .
            " | BCC: " . $a_rcp_bcc .
            " | Subject: " . $a_m_subject .
            " | Attachments: " . print_r($a_attachment, true)
        );

        if ($a_attachment && !$this->mfile->checkFilesExist($a_attachment)) {
            return [new ilMailError('mail_attachment_file_not_exist', [$a_attachment])];
        }

        $errors = $this->checkMail((string) $a_rcp_to, (string) $a_rcp_cc, (string) $a_rcp_bcc, (string) $a_m_subject);
        if (count($errors) > 0) {
            return $errors;
        }

        $errors = $this->validateRecipients((string) $a_rcp_to, (string) $a_rcp_cc, (string) $a_rcp_bcc);
        if (count($errors) > 0) {
            return $errors;
        }

        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bcc = $a_rcp_bcc;

        if (null === $rcp_cc) {
            $rcp_cc = '';
        }

        if (null === $rcp_bcc) {
            $rcp_bcc = '';
        }

        $numberOfExternalAddresses = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bcc, true);
        if (
            $numberOfExternalAddresses > 0 &&
            !$this->isSystemMail() &&
            !$DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'smtp_mail', $this->mail_obj_ref_id)
        ) {
            return [new ilMailError('mail_no_permissions_write_smtp')];
        }

        if ($this->appendInstallationSignature()) {
            $a_m_message .= self::_getInstallationSignature();
        }

        if (ilContext::getType() == ilContext::CONTEXT_CRON) {
            return $this->sendMail(
                (string) $rcp_to,
                (string) $rcp_cc,
                (string) $rcp_bcc,
                (string) $a_m_subject,
                (string) $a_m_message,
                (array) $a_attachment,
                (bool) $a_use_placeholders
            );
        }

        $taskFactory = $DIC->backgroundTasks()->taskFactory();
        $taskManager = $DIC->backgroundTasks()->taskManager();

        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);

        $task = $taskFactory->createTask(ilMailDeliveryJob::class, [
            (int) $this->user_id,
            (string) $rcp_to,
            (string) $rcp_cc,
            (string) $rcp_bcc,
            (string) $a_m_subject,
            (string) $a_m_message,
            (string) serialize($a_attachment),
            (bool) $a_use_placeholders,
            (bool) $this->getSaveInSentbox(),
            (string) $this->contextId,
            (string) serialize($this->contextParameters)
        ]);
        $interaction = $taskFactory->createTask(ilMailDeliveryJobUserInteraction::class, [
            $task,
            (int) $this->user_id
        ]);

        $bucket->setTask($interaction);
        $bucket->setTitle($this->lng->txt('mail_bg_task_title'));
        $bucket->setDescription(sprintf($this->lng->txt('mail_bg_task_desc'), $a_m_subject));

        $this->logger->info('Delegated delivery to background task');
        $taskManager->run($bucket);

        return [];
    }

    public function sendMail(
        string $to,
        string $cc,
        string $bcc,
        string $subject,
        string $message,
        array $attachments,
        bool $usePlaceholders
    ) : array {
        $internalMessageId = $this->saveInSentbox(
            $attachments,
            $to,
            $cc,
            $bcc,
            $subject,
            $message
        );

        if (count($attachments) > 0) {
            $this->mfile->assignAttachmentsToDirectory($internalMessageId, $internalMessageId);
            $this->mfile->saveFiles($internalMessageId, $attachments);
        }

        $numberOfExternalAddresses = $this->getCountRecipients($to, $cc, $bcc, true);

        if ($numberOfExternalAddresses > 0) {
            $externalMailRecipientsTo = $this->getEmailRecipients($to);
            $externalMailRecipientsCc = $this->getEmailRecipients($cc);
            $externalMailRecipientsBcc = $this->getEmailRecipients($bcc);

            $this->logger->debug(
                "Parsed external email addresses from given recipients /" .
                " To: " . $externalMailRecipientsTo .
                " | CC: " . $externalMailRecipientsCc .
                " | BCC: " . $externalMailRecipientsBcc .
                " | Subject: " . $subject
            );

            $this->sendMimeMail(
                $externalMailRecipientsTo,
                $externalMailRecipientsCc,
                $externalMailRecipientsBcc,
                $subject,
                $this->formatLinebreakMessage(
                    $usePlaceholders ? $this->replacePlaceholders($message, 0, false) : $message
                ),
                $attachments
            );
        } else {
            $this->logger->debug('No external email addresses given in recipient string');
        }

        $errors = [];

        if (!$this->distributeMail(
            $to,
            $cc,
            $bcc,
            $subject,
            $message,
            $attachments,
            $internalMessageId,
            $usePlaceholders
        )) {
            $errors['mail_send_error'] = new ilMailError('mail_send_error');
        }

        if (!$this->getSaveInSentbox()) {
            $this->deleteMails([$internalMessageId]);
        }

        return array_values($errors);
    }

    public function validateRecipients(string $to, string $cc, string $bcc) : array
    {
        try {
            $errors = [];
            $errors = array_merge($errors, $this->checkRecipients($to));
            $errors = array_merge($errors, $this->checkRecipients($cc));
            $errors = array_merge($errors, $this->checkRecipients($bcc));

            if (count($errors) > 0) {
                return array_merge([new ilMailError('mail_following_rcp_not_valid')], $errors);
            }
        } catch (ilMailException $e) {
            return [new ilMailError('mail_generic_rcp_error', [$e->getMessage()])];
        }

        return [];
    }

    protected function saveInSentbox(
        array $attachment,
        string $to,
        string $cc,
        string $bcc,
        string $subject,
        string $message
    ) : int {
        return $this->sendInternalMail(
            $this->mailbox->getSentFolder(),
            $this->user_id,
            $attachment,
            $to,
            $cc,
            $bcc,
            'read',
            0,
            $subject,
            $message,
            $this->user_id,
            0
        );
    }

    private function sendMimeMail(string $to, string $cc, string $bcc, $subject, $message, array $attachments) : void
    {
        $mailer = new ilMimeMail();
        $mailer->From($this->senderFactory->getSenderByUsrId((int) $this->user_id));
        $mailer->To($to);
        $mailer->Subject($subject, true, (string) ($this->contextParameters[self::PROP_CONTEXT_SUBJECT_PREFIX] ?? ''));
        $mailer->Body($message);

        if ($cc) {
            $mailer->Cc($cc);
        }

        if ($bcc) {
            $mailer->Bcc($bcc);
        }

        foreach ($attachments as $attachment) {
            $mailer->Attach(
                $this->mfile->getAbsoluteAttachmentPoolPathByFilename($attachment),
                '',
                'inline',
                $attachment
            );
        }

        $mailer->Send();
    }

    public function saveAttachments(array $attachments) : void
    {
        $this->db->update(
            $this->table_mail_saved,
            [
                'attachments' => ['clob', serialize($attachments)]
            ],
            [
                'user_id' => ['integer', $this->user_id]
            ]
        );
    }

    protected function parseAddresses($addresses) : array
    {
        if (strlen($addresses) > 0) {
            $this->logger->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }

        $parser = $this->mailAddressParserFactory->getParser((string) $addresses);
        $parsedAddresses = $parser->parse();

        if (strlen($addresses) > 0) {
            $this->logger->debug(sprintf(
                "Parsed addresses: %s",
                implode(',', array_map(function (ilMailAddress $address) {
                    return (string) $address;
                }, $parsedAddresses))
            ));
        }

        return $parsedAddresses;
    }

    protected function getCountRecipient(string $recipients, $onlyExternalAddresses = true) : int
    {
        $addresses = new ilMailAddressListImpl($this->parseAddresses($recipients));
        if ($onlyExternalAddresses) {
            $addresses = new ilMailOnlyExternalAddressList(
                $addresses,
                self::ILIAS_HOST,
                $this->usrIdByLoginCallable
            );
        }

        return count($addresses->value());
    }

    protected function getCountRecipients(
        string $toRecipients,
        string $ccRecipients,
        string $bccRecipients,
        $onlyExternalAddresses = true
    ) : int {
        return (
            $this->getCountRecipient($toRecipients, $onlyExternalAddresses) +
            $this->getCountRecipient($ccRecipients, $onlyExternalAddresses) +
            $this->getCountRecipient($bccRecipients, $onlyExternalAddresses)
        );
    }

    protected function getEmailRecipients(string $recipients) : string
    {
        $addresses = new ilMailOnlyExternalAddressList(
            new ilMailAddressListImpl($this->parseAddresses($recipients)),
            self::ILIAS_HOST,
            $this->usrIdByLoginCallable
        );

        $emailRecipients = array_map(function (ilMailAddress $address) {
            return (string) $address;
        }, $addresses->value());

        return implode(',', $emailRecipients);
    }

    public static function _getAutoGeneratedMessageString(ilLanguage $lang = null) : string
    {
        global $DIC;

        if (!($lang instanceof ilLanguage)) {
            $lang = ilLanguageFactory::_getLanguage();
        }

        $lang->loadLanguageModule('mail');

        return sprintf(
            $lang->txt('mail_auto_generated_info'),
            $DIC->settings()->get('inst_name', 'ILIAS ' . ((int) ILIAS_VERSION_NUMERIC)),
            ilUtil::_getHttpPath()
        ) . "\n\n";
    }

    public static function _getIliasMailerName() : string
    {
        $senderFactory = $GLOBALS["DIC"]["mail.mime.sender.factory"];

        return $senderFactory->system()->getFromName();
    }

    public function appendInstallationSignature(bool $a_flag = null)
    {
        if (null === $a_flag) {
            return $this->appendInstallationSignature;
        }

        $this->appendInstallationSignature = $a_flag;
        return $this;
    }

    public static function _getInstallationSignature() : string
    {
        global $DIC;

        $signature = $DIC->settings()->get('mail_system_sys_signature');

        $clientUrl = ilUtil::_getHttpPath();
        $clientdirs = glob(ILIAS_WEB_DIR . '/*', GLOB_ONLYDIR);
        if (is_array($clientdirs) && count($clientdirs) > 1) {
            $clientUrl .= '/login.php?client_id=' . CLIENT_ID; // #18051
        }

        $signature = str_ireplace('[CLIENT_NAME]', $DIC['ilClientIniFile']->readVariable('client', 'name'), $signature);
        $signature = str_ireplace(
            '[CLIENT_DESC]',
            $DIC['ilClientIniFile']->readVariable('client', 'description'),
            $signature
        );
        $signature = str_ireplace('[CLIENT_URL]', $clientUrl, $signature);

        if (!preg_match('/^[\n\r]+/', $signature)) {
            $signature = "\n" . $signature;
        }

        return $signature;
    }

    public static function getSalutation($a_usr_id, ilLanguage $a_language = null) : string
    {
        global $DIC;

        $lang = ($a_language instanceof ilLanguage) ? $a_language : $DIC->language();
        $lang->loadLanguageModule('mail');

        $gender = ilObjUser::_lookupGender($a_usr_id);
        $gender = $gender ? $gender : 'n';
        $name = ilObjUser::_lookupName($a_usr_id);

        if (!strlen($name['firstname'])) {
            return $lang->txt('mail_salutation_anonymous') . ',';
        }

        return
            $lang->txt('mail_salutation_' . $gender) . ' ' .
            ($name['title'] ? $name['title'] . ' ' : '') .
            ($name['firstname'] ? $name['firstname'] . ' ' : '') .
            $name['lastname'] . ',';
    }

    protected function getUserInstanceById(int $usrId) : ?ilObjUser
    {
        if (!array_key_exists($usrId, $this->userInstancesByIdMap)) {
            try {
                $user = new ilObjUser($usrId);
            } catch (Exception $e) {
                $user = null;
            }

            $this->userInstancesByIdMap[$usrId] = $user;
        }

        return $this->userInstancesByIdMap[$usrId];
    }

    public function setUserInstanceById(array $userInstanceByIdMap) : void
    {
        $this->userInstancesByIdMap = $userInstanceByIdMap;
    }

    protected function getMailOptionsByUserId(int $usrId) : ilMailOptions
    {
        if (!isset($this->mailOptionsByUsrIdMap[$usrId])) {
            $this->mailOptionsByUsrIdMap[$usrId] = new ilMailOptions($usrId);
        }

        return $this->mailOptionsByUsrIdMap[$usrId];
    }

    public function setMailOptionsByUserIdMap(array $mailOptionsByUsrIdMap) : void
    {
        $this->mailOptionsByUsrIdMap = $mailOptionsByUsrIdMap;
    }

    public function formatLinebreakMessage(string $message) : string
    {
        return $message;
    }
}