class.ilMimeMail.php

Go to the documentation of this file.

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

class ilMimeMail
{
    public const MAIL_SUBJECT_PREFIX = '[ILIAS]';

    protected static $defaultTransport = null;

    protected $subject = '';

    protected $body = '';

    protected $finalBody = '';

    protected $finalBodyAlt = '';

    protected $sendto = [];

    protected $acc = [];

    protected $abcc = [];

    protected $images = [];

    protected $aattach = [];

    protected $actype = [];

    protected $adispo = [];

    protected $adisplay = [];

    protected $sender;

    protected $settings;

    protected $subjectBuilder;

    public function __construct()
    {
        global $DIC;

        $this->settings = $DIC->settings();

        if (!(self::getDefaultTransport() instanceof ilMailMimeTransport)) {
            $factory = $DIC["mail.mime.transport.factory"];
            self::setDefaultTransport($factory->getTransport());
        }

        $this->subjectBuilder = new ilMailMimeSubjectBuilder($this->settings, self::MAIL_SUBJECT_PREFIX);
    }

    public static function setDefaultTransport(?ilMailMimeTransport $transport) : void
    {
        if ($transport !== null && !($transport instanceof ilMailMimeTransport)) {
            throw new InvalidArgumentException(sprintf(
                "The passed argument must be null or of type 'ilMailMimeTransport', %s given!",
                gettype($transport)
            ));
        }

        self::$defaultTransport = $transport;
    }

    public static function getDefaultTransport() : ?ilMailMimeTransport
    {
        return self::$defaultTransport;
    }

    public function Subject(string $subject, bool $addPrefix = false, string $contextPrefix = '') : void
    {
        $this->subject = $this->subjectBuilder->subject($subject, $addPrefix, $contextPrefix);
    }

    public function getSubject() : string
    {
        return $this->subject;
    }

    public function From(ilMailMimeSender $sender) : void
    {
        $this->sender = $sender;
    }

    public function To($to) : void
    {
        if (is_array($to)) {
            $this->sendto = $to;
        } else {
            $this->sendto[] = $to;
        }
    }

    public function Cc($cc) : void
    {
        if (is_array($cc)) {
            $this->acc = $cc;
        } else {
            $this->acc[] = $cc;
        }
    }

    public function Bcc($bcc) : void
    {
        if (is_array($bcc)) {
            $this->abcc = $bcc;
        } else {
            $this->abcc[] = $bcc;
        }
    }

    public function getTo() : array
    {
        return $this->sendto;
    }

    public function getCc() : array
    {
        return $this->acc;
    }

    public function getBcc() : array
    {
        return $this->abcc;
    }

    public function Body(string $body) : void
    {
        $this->body = $body;
    }

    public function getFinalBody() : string
    {
        return $this->finalBody;
    }

    public function getFinalBodyAlt() : string
    {
        return $this->finalBodyAlt;
    }

    public function getFrom() : ilMailMimeSender
    {
        return $this->sender;
    }

    public function Attach(
        string $filename,
        string $file_type = '',
        string $disposition = 'inline',
        ?string $display_name = null
    ) : void {
        if ($file_type === '') {
            $file_type = 'application/octet-stream';
        }

        $this->aattach[] = $filename;
        $this->actype[] = $file_type;
        $this->adispo[] = $disposition;
        $this->adisplay[] = $display_name;
    }

    public function getAttachments() : array
    {
        $attachments = [];

        $i = 0;
        foreach ($this->aattach as $attachment) {
            $name = '';
            if (isset($this->adisplay[$i]) && is_string($this->adisplay[$i]) && $this->adisplay[$i] !== '') {
                $name = $this->adisplay[$i];
            }

            $attachments[] = [
                'path' => $attachment,
                'name' => $name
            ];
            ++$i;
        }

        return $attachments;
    }

    public function getImages() : array
    {
        return array_values($this->images);
    }

    protected function build() : void
    {
        global $DIC;

        $this->finalBodyAlt = '';
        $this->finalBody = '';
        $this->images = [];

        if ($DIC->settings()->get('mail_send_html', 0)) {
            $skin = $DIC['ilClientIniFile']->readVariable('layout', 'skin');

            $this->buildBodyMultiParts($skin);
            $this->buildHtmlInlineImages($skin);
        } else {
            $this->finalBody = $this->removeHTMLTags($this->body);
        }
    }

    private function removeHTMLTags(string $maybeHTML) : string
    {
        $maybeHTML = str_ireplace(['<br />', '<br>', '<br/>'], "\n", $maybeHTML);
        $maybeHTML = strip_tags($maybeHTML);

        return $maybeHTML;
    }

    protected function buildBodyMultiParts(string $skin) : void
    {
        if ($this->body === '') {
            $this->body = ' ';
        }

        if (strip_tags($this->body, '<b><u><i><a>') === $this->body) {
            // Let's assume(!) that there is no HTML (except certain tags, e.g. used for object title formatting, where the consumer is not aware of this), so convert "\n" to "<br>"
            $this->finalBodyAlt = strip_tags($this->body);
            $this->body = \ilUtil::makeClickable(nl2br($this->body));
        } else {
            // if there is HTML, convert "<br>" to "\n" and strip tags for plain text alternative
            $this->finalBodyAlt = strip_tags(str_ireplace(["<br />", "<br>", "<br/>"], "\n", $this->body));
        }

        $this->finalBody = str_replace('{PLACEHOLDER}', $this->body, $this->getHtmlEnvelope($skin));
    }

    protected function getHtmlEnvelope(string $skin) : string
    {
        $bracket_path = './Services/Mail/templates/default/tpl.html_mail_template.html';

        if ($skin !== 'default') {
            $tplpath = './Customizing/global/skin/' . $skin . '/Services/Mail/tpl.html_mail_template.html';

            if (file_exists($tplpath)) {
                $bracket_path = './Customizing/global/skin/' . $skin . '/Services/Mail/tpl.html_mail_template.html';
            }
        }

        return file_get_contents($bracket_path);
    }

    protected function buildHtmlInlineImages(string $skin) : void
    {
        $this->gatherImagesFromDirectory('./Services/Mail/templates/default/img');

        if ($skin !== 'default') {
            $skinDirectory = './Customizing/global/skin/' . $skin . '/Services/Mail/img';
            if (is_dir($skinDirectory) && is_readable($skinDirectory)) {
                $this->gatherImagesFromDirectory($skinDirectory, true);
            }
        }
    }

    protected function gatherImagesFromDirectory(string $directory, bool $clearPrevious = false) : void
    {
        if ($clearPrevious) {
            $this->images = [];
        }

        foreach (new RegexIterator(new DirectoryIterator($directory), '/\.(jpg|jpeg|gif|svg|png)$/i') as $file) {
            $cid = 'img/' . $file->getFilename();

            $this->images[$cid] = [
                'path' => $file->getPathname(),
                'cid' => $cid,
                'name' => $file->getFilename()
            ];
        }
    }

    public function Send(ilMailMimeTransport $transport = null) : bool
    {
        if (!($transport instanceof ilMailMimeTransport)) {
            $transport = self::getDefaultTransport();
        }

        $this->build();

        return $transport->send($this);
    }
}