class.ilMail.php

Go to the documentation of this file.

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

require_once 'Services/User/classes/class.ilObjUser.php';
require_once 'Services/Mail/exceptions/class.ilMailException.php';

class ilMail
{
    const ILIAS_HOST = 'ilias';

    const MAIL_SUBJECT_PREFIX = '[ILIAS]';

    protected $lng;

    protected $db;

    protected $mfile;

    protected $mail_options;

    public $user_id;

    protected $table_mail;

    protected $table_mail_saved;

    protected $mail_data = array();

    protected $mail_obj_ref_id;

    protected $save_in_sentbox;

    protected $soap_enabled = true;
    protected $mail_to_global_roles = 0;
    protected $appendInstallationSignature = false;

    protected $properties = array();
    
    protected static $userInstances = array();

    private $mailAddressTypeFactory;

    private $mailAddressParserFactory;

    public function __construct(
        $a_user_id,
        ilMailAddressTypeFactory $mailAddressTypeFactory = null,
        ilMailRfc822AddressParserFactory $mailAddressParserFactory = null
    ) {
        global $DIC;

        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
        require_once 'Services/Mail/classes/class.ilMailOptions.php';

        if ($mailAddressTypeFactory === null) {
            $mailAddressTypeFactory = new ilMailAddressTypeFactory();
        }

        if ($mailAddressParserFactory === null) {
            $mailAddressParserFactory = new ilMailRfc822AddressParserFactory();
        }

        $this->mailAddressParserFactory = $mailAddressParserFactory;
        $this->mailAddressTypeFactory = $mailAddressTypeFactory;

        $this->lng              = $DIC->language();
        $this->db               = $DIC->database();

        $this->lng->loadLanguageModule('mail');

        $this->table_mail       = 'mail';
        $this->table_mail_saved = 'mail_saved';

        $this->user_id          = $a_user_id;

        $this->mfile            = new ilFileDataMail($this->user_id);
        $this->mail_options     = new ilMailOptions($a_user_id);

        $this->setSaveInSentbox(false);
        $this->readMailObjectReferenceId();
    }

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

    public function __get($name)
    {
        global $DIC;

        if (isset($this->properties[$name])) {
            return $this->properties[$name];
        }

        if ($name == 'mlists') {
            if (is_object($DIC->user())) {
                require_once 'Services/Contact/classes/class.ilMailingLists.php';
                $this->properties[$name] = new ilMailingLists($DIC->user());
                return $this->properties[$name];
            }
        }
    }

    public function existsRecipient($a_recipient, $a_existing_recipients)
    {
        $recipients = $this->parseAddresses($a_existing_recipients);
        foreach ($recipients as $rcp) {
            if (substr($rcp->getMailbox(), 0, 1) != '#') {
                if (trim($rcp->getMailbox()) == trim($a_recipient) || trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            } elseif (substr($rcp->getMailbox(), 0, 7) == '#il_ml_') {
                if (trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            } else {
                if (trim($rcp->getMailbox() . '@' . $rcp->getHost()) == trim($a_recipient)) {
                    return true;
                }
            }
        }

        return false;
    }

    public function enableSOAP($a_status)
    {
        $this->soap_enabled = (bool) $a_status;
    }

    public function isSOAPEnabled()
    {
        global $DIC;

        if (!extension_loaded('curl') || !$DIC->settings()->get('soap_user_administration')) {
            return false;
        }

        if (ilContext::getType() == ilContext::CONTEXT_CRON) {
            return false;
        }

        return (bool) $this->soap_enabled;
    }

    public function setSaveInSentbox($a_save_in_sentbox)
    {
        $this->save_in_sentbox = (bool) $a_save_in_sentbox;
    }

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

    protected function readMailObjectReferenceId()
    {
        require_once 'Services/Mail/classes/class.ilMailGlobalServices.php';
        $this->mail_obj_ref_id = ilMailGlobalServices::getMailObjectRefId();
    }

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

    public function formatNamesForOutput($a_recipients)
    {
        global $DIC;

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

        $names = array();

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

            $names[] = $recipient;
        }

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

    public function getPreviousMail($a_mail_id)
    {
        $this->db->setLimit(1);

        $res = $this->db->queryF(
            "
                        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",
            array('integer', 'integer'),
            array($this->user_id, $a_mail_id)
        );

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

        return $this->mail_data;
    }

    public function getNextMail($a_mail_id)
    {
        $this->db->setLimit(1);

        $res = $this->db->queryF(
            "
                        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",
            array('integer', 'integer'),
            array($this->user_id, $a_mail_id)
        );

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

        return $this->mail_data;
    }

    public function getMailsOfFolder($a_folder_id, $filter = array())
    {
        $output = array();

        $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');
        }

        if (isset($filter['type']) && strlen($filter['type']) > 0) {
            $query .= ' AND ' . $this->db->like('m_type', 'text', '%%:"' . $filter['type'] . '"%%', false);
        }

        $query .= " ORDER BY send_time DESC";

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

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

        return $output;
    }

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

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

    public function deleteMailsOfFolder($a_folder_id)
    {
        if ($a_folder_id) {
            $mails = $this->getMailsOfFolder($a_folder_id);
            foreach ((array) $mails as $mail_data) {
                $this->deleteMails(array($mail_data['mail_id']));
            }

            return true;
        }

        return false;
    }

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

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

        return $this->mail_data;
    }

    public function markRead(array $a_mail_ids)
    {
        $data       = array();
        $data_types = array();

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

        if (count($a_mail_ids) > 0) {
            $in      = 'mail_id IN (';
            $counter = 0;
            foreach ($a_mail_ids as $a_mail_id) {
                array_push($data, $a_mail_id);
                array_push($data_types, 'integer');

                if ($counter > 0) {
                    $in .= ',';
                }
                $in .= '%s';
                ++$counter;
            }
            $in .= ')';

            $query .= ' AND ' . $in;
        }

        $this->db->manipulateF($query, $data_types, $data);

        return true;
    }

    public function markUnread(array $a_mail_ids)
    {
        $data       = array();
        $data_types = array();

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

        if (count($a_mail_ids) > 0) {
            $in = 'mail_id IN (';
            $counter = 0;
            foreach ($a_mail_ids as $a_mail_id) {
                array_push($data, $a_mail_id);
                array_push($data_types, 'integer');

                if ($counter > 0) {
                    $in .= ',';
                }
                $in .= '%s';
                ++$counter;
            }
            $in .= ')';

            $query .= ' AND ' . $in;
        }

        $this->db->manipulateF($query, $data_types, $data);

        return true;
    }

    public function moveMailsToFolder(array $a_mail_ids, $a_folder_id)
    {
        $data       = array();
        $data_types = array();

        $query = "UPDATE {$this->table_mail} SET folder_id = %s WHERE user_id = %s ";
        array_push($data_types, 'text', 'integer');
        array_push($data, $a_folder_id, $this->user_id);

        if (count($a_mail_ids) > 0) {
            $in = 'mail_id IN (';
            $counter = 0;
            foreach ($a_mail_ids as $a_mail_id) {
                array_push($data, $a_mail_id);
                array_push($data_types, 'integer');

                if ($counter > 0) {
                    $in .= ',';
                }
                $in .= '%s';
                ++$counter;
            }
            $in .= ')';

            $query .= ' AND ' . $in;
        }

        $this->db->manipulateF($query, $data_types, $data);

        return true;
    }

    public function deleteMails(array $a_mail_ids)
    {
        foreach ($a_mail_ids as $id) {
            $this->db->manipulateF(
                "
                                DELETE FROM {$this->table_mail}
                                WHERE user_id = %s AND mail_id = %s ",
                array('integer', 'integer'),
                array($this->user_id, $id)
            );
            $this->mfile->deassignAttachmentFromDirectory($id);
        }

        return true;
    }

    protected function fetchMailData($a_row)
    {
        if (!is_array($a_row) || empty($a_row)) {
            return null;
        }

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

        return $a_row;
    }

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

        return $next_id;
    }

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

        return $a_draft_id;
    }

    public function sendInternalMail(
        $a_folder_id,
        $a_sender_id,
        $a_attachments,
        $a_rcp_to,
        $a_rcp_cc,
        $a_rcp_bcc,
        $a_status,
        $a_m_type,
        $a_m_email,
        $a_m_subject,
        $a_m_message,
        $a_user_id = 0,
        $a_use_placeholders = 0,
        $a_tpl_context_id = null,
        $a_tpl_context_params = array()
    ) {
        $a_user_id = $a_user_id ? $a_user_id : $this->user_id;

        if ($a_use_placeholders) {
            $a_m_message = $this->replacePlaceholders($a_m_message, $a_user_id);
        }
        $a_m_message = $this->formatLinebreakMessage($a_m_message);

        if (!$a_user_id) {
            $a_user_id = '0';
        }
        if (!$a_folder_id) {
            $a_folder_id = '0';
        }
        if (!$a_sender_id) {
            $a_sender_id = null;
        }
        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_status) {
            $a_status = null;
        }
        if (!$a_m_type) {
            $a_m_type = null;
        }
        if (!$a_m_email) {
            $a_m_email = null;
        }
        if (!$a_m_subject) {
            $a_m_subject = null;
        }
        if (!$a_m_message) {
            $a_m_message = null;
        }

        $next_id = $this->db->nextId($this->table_mail);
        $this->db->insert($this->table_mail, array(
            'mail_id'        => array('integer', $next_id),
            'user_id'        => array('integer', $a_user_id),
            'folder_id'      => array('integer', $a_folder_id),
            'sender_id'      => array('integer', $a_sender_id),
            'attachments'    => array('clob', serialize($a_attachments)),
            'send_time'      => array('timestamp', date('Y-m-d H:i:s', time())),
            'rcp_to'         => array('clob', $a_rcp_to),
            'rcp_cc'         => array('clob', $a_rcp_cc),
            'rcp_bcc'        => array('clob', $a_rcp_bcc),
            'm_status'       => array('text', $a_status),
            'm_type'         => array('text', serialize($a_m_type)),
            'm_email'        => array('integer', $a_m_email),
            'm_subject'      => array('text', $a_m_subject),
            'm_message'      => array('clob', $a_m_message),
            'tpl_ctx_id'     => array('text', $a_tpl_context_id),
            'tpl_ctx_params' => array('blob', @json_encode((array) $a_tpl_context_params))
        ));

        return $next_id;
    }

    protected function replacePlaceholders($a_message, $a_user_id = 0, $replace_empty = true)
    {
        try {
            include_once 'Services/Mail/classes/class.ilMailFormCall.php';

            if (ilMailFormCall::getContextId()) {
                require_once 'Services/Mail/classes/class.ilMailTemplateService.php';
                $context = ilMailTemplateService::getTemplateContextById(ilMailFormCall::getContextId());
            } else {
                require_once 'Services/Mail/classes/class.ilMailTemplateGenericContext.php';
                $context = new ilMailTemplateGenericContext();
            }

            $user = $a_user_id > 0 ? self::getCachedUserInstance($a_user_id) : null;

            require_once 'Services/Mail/classes/class.ilMailTemplatePlaceholderResolver.php';
            $processor = new ilMailTemplatePlaceholderResolver($context, $a_message);
            $a_message = $processor->resolve($user, ilMailFormCall::getContextParameters(), $replace_empty);
        } catch (Exception $e) {
            require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
            ilLoggerFactory::getLogger('mail')->error(__METHOD__ . ' has been called with invalid context.');
        }

        return $a_message;
    }

    protected function distributeMail($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_subject, $a_message, $a_attachments, $sent_mail_id, $a_type, $a_action, $a_use_placeholders = 0)
    {
        require_once 'Services/Mail/classes/class.ilMailbox.php';
        require_once 'Services/User/classes/class.ilObjUser.php';

        $mbox = new ilMailbox();
        if (!$a_use_placeholders) {
            $rcp_ids = $this->getUserIds(array($a_rcp_to, $a_rcp_cc, $a_rcp_bcc));

            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed TO/CC/BCC user ids from given recipients: %s",
                implode(', ', $rcp_ids)
            ));

            $as_email = array();

            foreach ($rcp_ids as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user                     = self::getCachedUserInstance($id);
                $user_is_active               = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                    ilLoggerFactory::getLogger('mail')->debug(sprintf(
                        "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                        $id,
                        var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                        var_export(!$tmp_user->checkTimeLimit(), 1)
                    ));
                    continue;
                }

                if ($user_is_active) {
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $newEmailAddresses = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
                        $as_email = array_unique(array_merge($newEmailAddresses, $as_email));

                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $a_message,
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            $to  = array();
            $bcc = array();

            $as_email = array_values(array_unique($as_email));
            if (count($as_email) == 1) {
                $to[] = $as_email[0];
            } else {
                foreach ($as_email as $email) {
                    $bcc[] = $email;
                }
            }

            if (count($to) > 0 || count($bcc) > 0) {
                $this->sendMimeMail(implode(',', $to), '', implode(',', $bcc), $a_subject, $this->formatLinebreakMessage($a_message), $a_attachments);
            }
        } else {
            $rcp_ids_replace    = $this->getUserIds(array($a_rcp_to));
            $rcp_ids_no_replace = $this->getUserIds(array($a_rcp_cc, $a_rcp_bcc));

            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed TO user ids from given recipients for serial letter notification: %s",
                implode(', ', $rcp_ids_replace)
            ));
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed CC/BCC user ids from given recipients for serial letter notification: %s",
                implode(', ', $rcp_ids_no_replace)
            ));

            $as_email          = array();
            $id_to_message_map = array();

            foreach ($rcp_ids_replace as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user                     = self::getCachedUserInstance($id);
                $user_is_active               = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                    ilLoggerFactory::getLogger('mail')->debug(sprintf(
                        "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                        $id,
                        var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                        var_export(!$tmp_user->checkTimeLimit(), 1)
                    ));
                    continue;
                }

                $id_to_message_map[$id] = $this->replacePlaceholders($a_message, $id);

                if ($user_is_active) {
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $as_email[$tmp_user->getId()] = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
    
                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $as_email[$tmp_user->getId()])
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $as_email[$tmp_user->getId()])
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $id_to_message_map[$id],
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            if (count($as_email)) {
                foreach ($as_email as $id => $emails) {
                    if (0 == count($emails)) {
                        continue;
                    }

                    $toEmailAddresses = implode(',', $emails);
                    $this->sendMimeMail($toEmailAddresses, '', '', $a_subject, $this->formatLinebreakMessage($id_to_message_map[$id]), $a_attachments);
                }
            }

            $as_email = array();

            $cc_and_bcc_message = $this->replacePlaceholders($a_message, 0, false);

            foreach ($rcp_ids_no_replace as $id) {
                $tmp_mail_options = new ilMailOptions($id);

                $tmp_user                     = self::getCachedUserInstance($id);
                $user_is_active               = $tmp_user->getActive();
                $user_can_read_internal_mails = !$tmp_user->hasToAcceptTermsOfService() && $tmp_user->checkTimeLimit();

                if ($user_is_active) {
                    if (in_array('system', $a_type) && !$user_can_read_internal_mails) {
                        ilLoggerFactory::getLogger('mail')->debug(sprintf(
                            "Message is marked as 'system', skipped recipient with id %s (Accepted User Agreement:%s|Expired Account:%s)",
                            $id,
                            var_export(!$tmp_user->hasToAcceptTermsOfService(), 1),
                            var_export(!$tmp_user->checkTimeLimit(), 1)
                        ));
                        continue;
                    }
                    
                    
                    if (!$user_can_read_internal_mails
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL
                        || $tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_BOTH) {
                        $newEmailAddresses = ilMailOptions::getExternalEmailsByUser($tmp_user, $tmp_mail_options);
                        $as_email = array_unique(array_merge($newEmailAddresses, $as_email));

                        if ($tmp_mail_options->getIncomingType() == ilMailOptions::INCOMING_EMAIL) {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will only receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                            continue;
                        } else {
                            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                                "Recipient with id %s will additionally receive external emails sent to: %s",
                                $id,
                                implode(', ', $newEmailAddresses)
                            ));
                        }
                    }
                }

                $mbox->setUserId($id);
                $inbox_id = $mbox->getInboxFolder();

                $mail_id = $this->sendInternalMail(
                    $inbox_id,
                    $this->user_id,
                    $a_attachments,
                    $a_rcp_to,
                    $a_rcp_cc,
                    '',
                    'unread',
                    $a_type,
                    0,
                    $a_subject,
                    $cc_and_bcc_message,
                    $id,
                    0
                );

                if ($a_attachments) {
                    $this->mfile->assignAttachmentsToDirectory($mail_id, $sent_mail_id);
                }
            }

            if (count($as_email)) {
                $this->sendMimeMail('', '', implode(',', $as_email), $a_subject, $this->formatLinebreakMessage($cc_and_bcc_message), $a_attachments);
            }
        }

        return true;
    }

    protected function getUserIds(array $a_recipients)
    {
        $usr_ids = array();

        $a_recipients = implode(',', array_filter(array_map('trim', $a_recipients)));

        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            $address_type = $this->mailAddressTypeFactory->getByPrefix($recipient);
            $usr_ids = array_merge($usr_ids, $address_type->resolve());
        }

        return array_unique($usr_ids);
    }

    protected function checkMail($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject)
    {
        $errors =  array();
        foreach (array(
            $a_m_subject => array('mail_add_subject'),
            $a_rcp_to    => array('mail_add_recipient')
        ) as $string => $e) {
            if (strlen($string) === 0) {
                $errors[] = $e;
            }
        }

        return $errors;
    }

    protected function checkRecipients($a_recipients)
    {
        $errors = array();

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

        return $errors;
    }

    public function savePostData(
        $a_user_id,
        $a_attachments,
        $a_rcp_to,
        $a_rcp_cc,
        $a_rcp_bcc,
        $a_m_type,
        $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_type) {
            $a_m_type = 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,
            array(
                'user_id' => array('integer', $this->user_id)
            ),
            array(
                'attachments'      => array('clob', serialize($a_attachments)),
                'rcp_to'           => array('clob', $a_rcp_to),
                'rcp_cc'           => array('clob', $a_rcp_cc),
                'rcp_bcc'          => array('clob', $a_rcp_bcc),
                'm_type'           => array('text', serialize($a_m_type)),
                'm_email'          => array('integer', $a_m_email),
                'm_subject'        => array('text', $a_m_subject),
                'm_message'        => array('clob', $a_m_message),
                'use_placeholders' => array('integer', $a_use_placeholders),
                'tpl_ctx_id'       => array('text', $a_tpl_context_id),
                'tpl_ctx_params'   => array('blob', json_encode((array) $a_tpl_ctx_params))
            )
        );

        $this->getSavedData();

        return true;
    }

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

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

        return $this->mail_data;
    }

    public function sendMail($a_rcp_to, $a_rcp_cc, $a_rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $a_type, $a_use_placeholders = 0)
    {
        global $DIC;

        ilLoggerFactory::getLogger('mail')->debug(
            "New mail system task:" .
            " To: " . $a_rcp_to .
            " | CC: " . $a_rcp_cc .
            " | BCC: " . $a_rcp_bc .
            " | Subject: " . $a_m_subject
        );

        $this->mail_to_global_roles = true;
        if (!$this->isSystemMail()) {
            $this->mail_to_global_roles = $DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'mail_to_global_roles', $this->mail_obj_ref_id);
        }

        if (in_array('system', $a_type)) {
            $a_type = array('system');
        }

        if ($a_attachment && !$this->mfile->checkFilesExist($a_attachment)) {
            return array(array('mail_attachment_file_not_exist', $a_attachment));
        }

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

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

        $rcp_to = $a_rcp_to;
        $rcp_cc = $a_rcp_cc;
        $rcp_bc = $a_rcp_bc;

        $c_emails = $this->getCountRecipients($rcp_to, $rcp_cc, $rcp_bc, true);

        if (
            $c_emails && !$this->isSystemMail() &&
            !$DIC->rbac()->system()->checkAccessOfUser($this->user_id, 'smtp_mail', $this->mail_obj_ref_id)
        ) {
            return array(array('mail_no_permissions_write_smtp'));
        }

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

        $sent_id = $this->saveInSentbox($a_attachment, $a_rcp_to, $a_rcp_cc, $a_rcp_bc, $a_type, $a_m_subject, $a_m_message);

        if ($a_attachment) {
            $this->mfile->assignAttachmentsToDirectory($sent_id, $sent_id);
            $this->mfile->saveFiles($sent_id, $a_attachment);
        }

        if ($c_emails) {
            $externalMailRecipientsTo  = $this->getEmailRecipients($rcp_to);
            $externalMailRecipientsCc  = $this->getEmailRecipients($rcp_cc);
            $externalMailRecipientsBcc = $this->getEmailRecipients($rcp_bc);

            ilLoggerFactory::getLogger('mail')->debug(
                "Parsed external email addresses from given recipients:" .
                " To: " . $externalMailRecipientsTo .
                " | CC: " . $externalMailRecipientsCc .
                " | BCC: " . $externalMailRecipientsBcc .
                " | Subject: " . $a_m_subject
            );

            $this->sendMimeMail(
                $externalMailRecipientsTo,
                $externalMailRecipientsCc,
                $externalMailRecipientsBcc,
                $a_m_subject,
                $this->formatLinebreakMessage($a_use_placeholders ? $this->replacePlaceholders($a_m_message, 0, false) : $a_m_message),
                $a_attachment,
                0
            );
        } else {
            ilLoggerFactory::getLogger('mail')->debug("No external email addresses given in recipient string");
        }

        if (in_array('system', $a_type) && !$this->distributeMail($rcp_to, $rcp_cc, $rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $sent_id, $a_type, 'system', $a_use_placeholders)) {
            return array(array('mail_send_error'));
        }

        if (in_array('normal', $a_type) && !$this->distributeMail($rcp_to, $rcp_cc, $rcp_bc, $a_m_subject, $a_m_message, $a_attachment, $sent_id, $a_type, 'normal', $a_use_placeholders)) {
            return array(array('mail_send_error'));
        }

        if (!$this->getSaveInSentbox()) {
            $this->deleteMails(array($sent_id));
        }

        return array();
    }

    public function validateRecipients($a_rcp_to, $a_rcp_cc, $a_rcp_bc)
    {
        try {
            $errors = array();
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_to));
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_cc));
            $errors = array_merge($errors, $this->checkRecipients($a_rcp_bc));

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

        return array();
    }

    protected function saveInSentbox($a_attachment, $a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_type, $a_m_subject, $a_m_message)
    {
        require_once 'Services/Mail/classes/class.ilMailbox.php';

        $mbox           = new ilMailbox($this->user_id);
        $sent_folder_id = $mbox->getSentFolder();

        return $this->sendInternalMail(
            $sent_folder_id,
            $this->user_id,
            $a_attachment,
            $a_rcp_to,
            $a_rcp_cc,
            $a_rcp_bcc,
            'read',
            $a_type,
            0,
            $a_m_subject,
            $a_m_message,
            $this->user_id,
            0
        );
    }

    public function sendMimeMail($a_rcp_to, $a_rcp_cc, $a_rcp_bcc, $a_m_subject, $a_m_message, $a_attachments, $a_no_soap = false)
    {
        require_once 'Services/Mail/classes/class.ilMimeMail.php';

        $a_m_subject = self::getSubjectPrefix() . ' ' . $a_m_subject;

        // #10854
        if ($this->isSOAPEnabled() && !$a_no_soap) {
            require_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
            $soap_client = new ilSoapClient();
            $soap_client->setResponseTimeout(5);
            $soap_client->enableWSDL(true);
            $soap_client->init();

            $attachments   = array();
            $a_attachments = $a_attachments ? $a_attachments : array();
            foreach ($a_attachments as $attachment) {
                $attachments[] = $this->mfile->getAbsolutePath($attachment);
            }

            // mjansen: switched separator from "," to "#:#" because of mantis bug #6039
            $attachments = implode('#:#', $attachments);
            // mjansen: use "#:#" as leading delimiter
            if (strlen($attachments)) {
                $attachments = "#:#" . $attachments;
            }

            $soap_client->call('sendMail', array(
                session_id() . '::' . $_COOKIE['ilClientId'],
                $a_rcp_to,
                $a_rcp_cc,
                $a_rcp_bcc,
                $this->user_id,
                $a_m_subject,
                $a_m_message,
                $attachments
            ));
        } else {
            $senderFactory = $GLOBALS["DIC"]["mail.mime.sender.factory"];

            $mmail = new ilMimeMail();
            $mmail->From($senderFactory->getSenderByUsrId($this->user_id));
            $mmail->To($a_rcp_to);
            $mmail->Subject($a_m_subject);
            $mmail->Body($a_m_message);

            if ($a_rcp_cc) {
                $mmail->Cc($a_rcp_cc);
            }

            if ($a_rcp_bcc) {
                $mmail->Bcc($a_rcp_bcc);
            }

            if (is_array($a_attachments)) {
                foreach ($a_attachments as $attachment) {
                    $mmail->Attach($this->mfile->getAbsolutePath($attachment), '', 'inline', $attachment);
                }
            }

            $mmail->Send();
        }
    }

    public function saveAttachments($a_attachments)
    {
        $this->db->update(
            $this->table_mail_saved,
            array(
                'attachments' => array('clob', serialize($a_attachments))
            ),
            array(
                'user_id' => array('integer', $this->user_id)
            )
        );

        return true;
    }

    protected function parseAddresses($addresses)
    {
        if (strlen($addresses) > 0) {
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Started parsing of recipient string: %s",
                $addresses
            ));
        }

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

        if (strlen($addresses) > 0) {
            ilLoggerFactory::getLogger('mail')->debug(sprintf(
                "Parsed addresses: %s",
                implode(',', array_map(function (ilMailAddress $address) {
                    return $address->getMailbox() . '@' . $address->getHost();
                }, $parsedAddresses))
            ));
        }

        return $parsedAddresses;
    }

    protected function getCountRecipient($a_recipients, $a_only_email = true)
    {
        $counter = 0;

        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            if ($a_only_email) {
                // Fixed mantis bug #5875
                if (ilObjUser::_lookupId($recipient->getMailbox() . '@' . $recipient->getHost())) {
                    continue;
                }

                // Addresses which aren't on the self::ILIAS_HOST host, and
                // which have a mailbox which does not start with '#',
                // are external e-mail addresses
                if ($recipient->getHost() != self::ILIAS_HOST && substr($recipient->getMailbox(), 0, 1) != '#') {
                    ++$counter;
                }
            } else {
                ++$counter;
            }
        }

        return $counter;
    }

    protected function getCountRecipients($a_to, $a_cc, $a_bcc, $a_only_email = true)
    {
        return
            $this->getCountRecipient($a_to, $a_only_email) +
            $this->getCountRecipient($a_cc, $a_only_email) +
            $this->getCountRecipient($a_bcc, $a_only_email);
    }

    protected function getEmailRecipients($a_recipients)
    {
        $rcp = array();

        $recipients = $this->parseAddresses($a_recipients);
        foreach ($recipients as $recipient) {
            if (substr($recipient->getMailbox(), 0, 1) != '#' && $recipient->getHost() != self::ILIAS_HOST) {
                // Fixed mantis bug #5875
                if (ilObjUser::_lookupId($recipient->getMailbox() . '@' . $recipient->getHost())) {
                    continue;
                }

                $rcp[] = $recipient->getMailbox() . '@' . $recipient->getHost();
            }
        }

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

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

        if (!($lang instanceof ilLanguage)) {
            require_once 'Services/Language/classes/class.ilLanguageFactory.php';
            $lang = ilLanguageFactory::_getLanguage();
        }

        $lang->loadLanguageModule('mail');

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

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

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

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

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

    public static function _getInstallationSignature()
    {
        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 getSubjectPrefix()
    {
        global $DIC;

        $subjectPrefix = $DIC->settings()->get('mail_subject_prefix');
        if (false === $subjectPrefix) {
            $subjectPrefix = self::MAIL_SUBJECT_PREFIX;
        }

        return $subjectPrefix;
    }

    public static function getSalutation($a_usr_id, ilLanguage $a_language = null)
    {
        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 static function getCachedUserInstance($a_usr_id)
    {
        if (isset(self::$userInstances[$a_usr_id])) {
            return self::$userInstances[$a_usr_id];
        }

        self::$userInstances[$a_usr_id] = new ilObjUser($a_usr_id);
        return self::$userInstances[$a_usr_id];
    }

    public function formatLinebreakMessage($a_message)
    {
        return $a_message;
    }
}