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
{
    protected static $defaultTransport;

    protected $subject = '';

    protected $body = '';

    protected $finalBody = '';

    protected $finalBodyAlt = '';

    protected $sendto = array();

    protected $acc = array();

    protected $abcc = array();

    protected $images = array();

    protected $aattach = array();

    protected $actype = array();

    protected $adispo = array();

    protected $adisplay = array();

    protected $sender;

    public function __construct()
    {
        global $DIC;

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

    public static function setDefaultTransport($transport)
    {
        if (!is_null($transport) && !($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()
    {
        return self::$defaultTransport;
    }

    public function Subject($subject, $a_add_prefix = false)
    {
        if ($a_add_prefix) {
            // #9096
            require_once 'Services/Mail/classes/class.ilMail.php';
            $prefix = ilMail::getSubjectPrefix();
            if (trim($prefix)) {
                $subject = trim($prefix) . ' ' . $subject;
            }
        }

        $this->subject = $subject;
    }

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

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

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

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

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

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

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

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

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

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

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

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

    public function Attach($filename, $file_type = '', $disposition = 'inline', $display_name = null)
    {
        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()
    {
        $attachments = array();

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

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

        return $attachments;
    }

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

    protected function build()
    {
        global $DIC;

        $this->finalBodyAlt = '';
        $this->finalBody    = '';
        $this->images       = array();

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

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

    protected function buildBodyParts($skin)
    {
        if (0 == strlen($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 = $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(array("<br />", "<br>", "<br/>"), "\n", $this->body));
        }

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

    protected function getHtmlEnvelope($skin)
    {
        $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($skin)
    {
        $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($directory, $clearPrevious = false)
    {
        if ($clearPrevious) {
            $this->images = array();
        }

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

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

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

        $this->build();

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