Collaboration diagram for ilMimeMail:

Public Member Functions
	__construct ()

	Subject (string $subject, bool $add_prefix=false, string $context_prefix='')

	getSubject ()

	From (ilMailMimeSender $sender)

	To ($to)

	Cc ($cc)

	Bcc ($bcc)

	getTo ()

	getCc ()

	getBcc ()

	Body (string $body, ?Closure $to_html_transformation=null)

	getFinalBody ()

	getFinalBodyalt ()

	getFrom ()

	Attach (string $filename, string $file_type='', string $disposition='inline', ?string $display_name=null)

	getAttachments ()

	getImages ()

	Send (?ilMailMimeTransport $transport=null)

Static Public Member Functions
static	setDefaultTransport (?ilMailMimeTransport $transport)

static	getDefaultTransport ()

Data Fields
final const string	MAIL_SUBJECT_PREFIX = '[ILIAS]'

Protected Member Functions
	build ()

	gatherImagesFromDirectory (string $directory, bool $clear_previous=false)

Protected Attributes
ilMailMimeSender	$sender

ilMailMimeSubjectBuilder	$subject_builder

ilSetting	$settings

string	$subject = ''

string	$body = ''

string	$final_body = ''

string	$final_body_alt = ''

array	$sendto = []

array	$acc = []

array	$abcc = []

array	$images = []

array	$aattach = []

array	$actype = []

array	$adispo = []

array	$adisplay = []

Static Protected Attributes
static ilMailMimeTransport	$default_transport = null

Private Member Functions
	removeHtmlTags (string $maybe_html)

	getPathToRootDirectory ()

	prepareHTMLBody ()

	containsHtmlBlockElementsOrLineBreaks (string $email_body)

	getStyleSheetPath (string $skin, string $style)

	getLogoCid (string $skin, string $style)

	addImage (SplFileInfo $file, bool $as_logo=false)

Private Attributes
const string	SKIN_LOGO_PATH = '/public/Customizing/skin/%s/images/logo'

const string	SKIN_CSS_PATH = '/public/Customizing/skin/%s/mail.css'

const string	MAIL_CSS_PATH = 'assets/css/mail.css'

const string	MAIL_LOGO_PATH = '/public/assets/images/logo/HeaderIcon.svg'

const string	ROOT_DIR_IDENTIFICATION_FILE = '/ilias_version.php'

readonly Refinery	$refinery

Closure	$to_html_transformation = null

Detailed Description

Definition at line 24 of file class.ilMimeMail.php.

Constructor & Destructor Documentation

◆ __construct()

ilMimeMail::__construct ( )

Definition at line 62 of file class.ilMimeMail.php.

    {
        global $DIC;
        $this->settings = $DIC->settings();
 
        if (!(self::getDefaultTransport() instanceof ilMailMimeTransport)) {
            $factory = $DIC->mail()->mime()->transportFactory();
            self::setDefaultTransport($factory->getTransport());
        }
 
        $this->subject_builder = new ilMailMimeSubjectBuilder($this->settings, self::MAIL_SUBJECT_PREFIX);
        $this->refinery = $DIC->refinery();
    }

References $DIC, ILIAS\Repository\refinery(), setDefaultTransport(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ addImage()

ilMimeMail::addImage	(	SplFileInfo	$file,
		bool	$as_logo = `false`
	)

private

Definition at line 414 of file class.ilMimeMail.php.

                                                                       : string
    {
        $cid = 'img/' . $file->getFilename();
 
        $this->images[$cid] = [
            'path' => $file->getPathname(),
            'cid' => $cid,
            'name' => $file->getFilename(),
            'as_logo' => $as_logo
        ];
 
        return $cid;
    }

◆ Attach()

ilMimeMail::Attach	(	string	$filename,
		string	$file_type = `''`,
		string	$disposition = `'inline'`,
		?string	$display_name = `null`
	)

Parameters

string	$filename	Path of the file to attach
string	$file_type	MIME-type of the file. default to 'application/x-unknown-content-type'
string	$disposition	Instruct the Mailclient to display the file if possible ("inline") or always as a link ("attachment") possible values are "inline", "attachment"
string \| null	$display_name	Filename to use in email (if different from source file)

Definition at line 192 of file class.ilMimeMail.php.

     : void {
        if ($file_type === '') {
            $file_type = 'application/octet-stream';
        }
 
        $this->aattach[] = $filename;
        $this->actype[] = $file_type;
        $this->adispo[] = $disposition;
        $this->adisplay[] = $display_name;
    }

◆ Bcc()

ilMimeMail::Bcc ( $bcc )

Parameters

string | string[] $bcc BCC email address, accept both a single address or an array of addresses

Definition at line 128 of file class.ilMimeMail.php.

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

◆ Body()

ilMimeMail::Body	(	string	$body,
		?Closure	$to_html_transformation = `null`
	)

Parameters

Closure(string) string|null $to_html_transformation

Definition at line 164 of file class.ilMimeMail.php.

                                                                               : void
    {
        $this->body = $body;
        $this->to_html_transformation = $to_html_transformation;
    }

References $body, and $to_html_transformation.

◆ build()

ilMimeMail::build ( )

protected

Definition at line 241 of file class.ilMimeMail.php.

                              : void
    {
        global $DIC;
 
        $this->final_body_alt = '';
        $this->final_body = '';
        $this->images = [];
 
        if ($DIC->settings()->get('mail_send_html', '0')) {
            $skin = $DIC['ilClientIniFile']->readVariable('layout', 'skin');
            $style = $DIC['ilClientIniFile']->readVariable('layout', 'style');
 
            $data_factory = new Factory();
            $factory = $DIC->ui()->factory();
            $renderer = $DIC->ui()->renderer();
 
            $this->prepareHTMLBody();
 
            $page = $factory->layout()->page()->mail(
                $this->getStyleSheetPath($skin, $style),
                "cid:{$this->getLogoCid($skin, $style)}",
                ilObjSystemFolder::_getHeaderTitle(),
                $factory->legacy()->content($this->body),
                $data_factory->link(ilUtil::_getHttpPath(), $data_factory->uri(ilUtil::_getHttpPath())),
            );
 
            $this->final_body = $renderer->render($page);
            $this->final_body_alt = $this->removeHtmlTags($this->body);
        } else {
            $this->final_body = $this->removeHtmlTags($this->body);
        }
    }

References $DIC, $renderer, ilObjSystemFolder\_getHeaderTitle(), and ilUtil\_getHttpPath().

Here is the call graph for this function:

◆ Cc()

ilMimeMail::Cc ( $cc )

Parameters

string | string[] $cc CC email address, accept both a single address or an array of addresses

Definition at line 116 of file class.ilMimeMail.php.

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

◆ containsHtmlBlockElementsOrLineBreaks()

ilMimeMail::containsHtmlBlockElementsOrLineBreaks ( string $email_body )

private

Definition at line 316 of file class.ilMimeMail.php.

                                                                              : bool
    {
        if (str_contains($email_body, '<') === false || str_contains($email_body, '>') === false) {
            return false;
        }
 
        // Detect common HTML tags produced by Markdown rendering.
        $pattern = '~</?(p|br|div|ul|ol|li|code|pre|h[1-6])\b~i';
        if (preg_match($pattern, $email_body) === 1) {
            return true;
        }
 
        return strip_tags($email_body, '<b><u><i><a>') !== $email_body;
    }

◆ From()

ilMimeMail::From ( ilMailMimeSender $sender )

Definition at line 96 of file class.ilMimeMail.php.

                                                  : void
    {
        $this->sender = $sender;
    }

References $sender.

◆ gatherImagesFromDirectory()

ilMimeMail::gatherImagesFromDirectory	(	string	$directory,
		bool	$clear_previous = `false`
	)

protected

Definition at line 400 of file class.ilMimeMail.php.

                                                                                                 : void
    {
        if ($clear_previous) {
            $this->images = [];
        }
 
        foreach (new RegexIterator(
            new DirectoryIterator($directory),
            '/\.(jpg|jpeg|gif|svg|png)$/i'
        ) as $file) {
            $this->addImage($file);
        }
    }

◆ getAttachments()

ilMimeMail::getAttachments ( )

Returns: array{path: string, name: string}[]

Definition at line 211 of file class.ilMimeMail.php.

                                    : 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;
    }

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getBcc()

ilMimeMail::getBcc ( )

Returns: string[]

Definition at line 156 of file class.ilMimeMail.php.

                            : array
    {
        return $this->abcc;
    }

References $abcc.

Referenced by ilMailMimeTransportBase\send(), and ilMailTest\testExternalMailDeliveryWorksAsExpected().

Here is the caller graph for this function:

◆ getCc()

ilMimeMail::getCc ( )

Returns: string[]

Definition at line 148 of file class.ilMimeMail.php.

                           : array
    {
        return $this->acc;
    }

References $acc.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getDefaultTransport()

static ilMimeMail::getDefaultTransport ( )

static

Definition at line 81 of file class.ilMimeMail.php.

                                                : ?ilMailMimeTransport
    {
        return self::$default_transport;
    }

References $default_transport.

Referenced by ilMailTest\testExternalMailDeliveryWorksAsExpected().

Here is the caller graph for this function:

◆ getFinalBody()

ilMimeMail::getFinalBody ( )

Definition at line 170 of file class.ilMimeMail.php.

                                  : string
    {
        return $this->final_body;
    }

References $final_body.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getFinalBodyalt()

ilMimeMail::getFinalBodyalt ( )

Definition at line 175 of file class.ilMimeMail.php.

                                     : string
    {
        return $this->final_body_alt;
    }

References $final_body_alt.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getFrom()

ilMimeMail::getFrom ( )

Definition at line 180 of file class.ilMimeMail.php.

                             : ilMailMimeSender
    {
        return $this->sender;
    }

References $sender.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getImages()

ilMimeMail::getImages ( )

Returns: array{path: string, cid: string, name: string}[] An array of images. Each element must container to associative keys, 'path', 'cid' and 'name'

Definition at line 236 of file class.ilMimeMail.php.

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

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getLogoCid()

ilMimeMail::getLogoCid	(	string	$skin,
		string	$style
	)

private

Definition at line 350 of file class.ilMimeMail.php.

                                                            : string
    {
        if ($skin !== 'default') {
            $locations = [
                $skin,
                "$skin/$style"
            ];
 
            foreach ($locations as $location) {
                $custom_directory = $this->getPathToRootDirectory() . sprintf(self::SKIN_LOGO_PATH, $location);
                if (is_dir($custom_directory) && is_readable($custom_directory)) {
                    $this->gatherImagesFromDirectory($custom_directory);
                }
            }
        } else {
            $path = $this->getPathToRootDirectory() . self::MAIL_LOGO_PATH;
            if (is_file($path) && is_readable($path)) {
                return $this->addImage(new SplFileInfo($path), true);
            }
        }
 
        foreach ($this->images as $image) {
            if ($image['as_logo']) {
                return $image['cid'];
            }
        }
 
        $logo_cid = count($this->images) > 1 ? current($this->images)['cid'] : null;
 
        foreach ($this->images as $cid => $image) {
            $file_name = basename($image['path'], '.' . pathinfo($image['path'], PATHINFO_EXTENSION));
            if (in_array(strtolower($file_name), ['logo', 'headericon'], true)) {
                $logo_cid = $cid;
                break;
            }
        }
 
        if (is_string($logo_cid)) {
            $this->images[$logo_cid]['as_logo'] = true;
            return $logo_cid;
        }
 
        $path = $this->getPathToRootDirectory() . self::MAIL_LOGO_PATH;
        if (is_file($path) && is_readable($path)) {
            return $this->addImage(new SplFileInfo($path), true);
        }
 
        return '';
    }

References $location, and $path.

◆ getPathToRootDirectory()

ilMimeMail::getPathToRootDirectory ( )

private

Definition at line 281 of file class.ilMimeMail.php.

                                             : string
    {
        $current_dir = realpath(__DIR__);
 
        while ($current_dir !== '.') {
            if (file_exists($current_dir . self::ROOT_DIR_IDENTIFICATION_FILE)) {
                break;
            }
 
            $current_dir = dirname($current_dir);
        }
 
        return $current_dir;
    }

◆ getStyleSheetPath()

ilMimeMail::getStyleSheetPath	(	string	$skin,
		string	$style
	)

private

Definition at line 331 of file class.ilMimeMail.php.

                                                                   : string
    {
        if ($skin !== 'default') {
            $locations = [
                $skin,
                "$skin/$style"
            ];
 
            foreach ($locations as $location) {
                $custom_path = $this->getPathToRootDirectory() . sprintf(self::SKIN_CSS_PATH, $location);
                if (is_file($custom_path)) {
                    return $custom_path;
                }
            }
        }
 
        return self::MAIL_CSS_PATH;
    }

References $location.

◆ getSubject()

ilMimeMail::getSubject ( )

Definition at line 91 of file class.ilMimeMail.php.

                                : string
    {
        return $this->subject;
    }

References $subject.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getTo()

ilMimeMail::getTo ( )

Returns: string[]

Definition at line 140 of file class.ilMimeMail.php.

                           : array
    {
        return $this->sendto;
    }

References $sendto.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ prepareHTMLBody()

ilMimeMail::prepareHTMLBody ( )

private

Definition at line 296 of file class.ilMimeMail.php.

                                      : void
    {
        if ($this->body === '') {
            $this->body = ' ';
        }
 
        $transformed_body = $this->to_html_transformation ? ($this->to_html_transformation)($this->body) : $this->body;
 
        $contains_html = $this->containsHtmlBlockElementsOrLineBreaks($transformed_body);
        if ($contains_html) {
            $this->final_body_alt = strip_tags(str_ireplace(['<br />', '<br>', '<br/>'], "\n", $this->body));
            $this->body = $transformed_body;
        } else {
            $this->final_body_alt = strip_tags($this->body);
            $this->body = nl2br($transformed_body);
        }
 
        $this->body = $this->refinery->string()->makeClickable()->transform($this->body);
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ removeHtmlTags()

ilMimeMail::removeHtmlTags ( string $maybe_html )

private

Definition at line 274 of file class.ilMimeMail.php.

                                                       : string
    {
        $maybe_html = str_ireplace(['<br />', '<br>', '<br/>'], "\n", $maybe_html);
 
        return html_entity_decode(strip_tags($maybe_html), ENT_QUOTES);
    }

◆ Send()

ilMimeMail::Send ( ?ilMailMimeTransport $transport = null )

Definition at line 428 of file class.ilMimeMail.php.

                                                                : bool
    {
        if (!($transport instanceof ilMailMimeTransport)) {
            $transport = self::getDefaultTransport();
        }
 
        $this->build();
 
        return $transport->send($this);
    }

◆ setDefaultTransport()

static ilMimeMail::setDefaultTransport ( ?ilMailMimeTransport $transport )

static

Definition at line 76 of file class.ilMimeMail.php.

                                                                               : void
    {
        self::$default_transport = $transport;
    }

Referenced by __construct(), ilMailMimeTest\setUp(), and ilMailTest\testExternalMailDeliveryWorksAsExpected().

Here is the caller graph for this function:

◆ Subject()

ilMimeMail::Subject	(	string	$subject,
		bool	$add_prefix = `false`,
		string	$context_prefix = `''`
	)

Definition at line 86 of file class.ilMimeMail.php.

                                                                                                   : void
    {
        $this->subject = $this->subject_builder->subject($subject, $add_prefix, $context_prefix);
    }

References $subject.

◆ To()

ilMimeMail::To ( $to )

Parameters

string | string[] $to To email address, accept both a single address or an array of addresses

Definition at line 104 of file class.ilMimeMail.php.

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

Field Documentation

◆ $aattach

array ilMimeMail::$aattach = []

protected

Definition at line 51 of file class.ilMimeMail.php.

◆ $abcc

array ilMimeMail::$abcc = []

protected

Definition at line 47 of file class.ilMimeMail.php.

Referenced by getBcc().

◆ $acc

array ilMimeMail::$acc = []

protected

Definition at line 45 of file class.ilMimeMail.php.

Referenced by getCc().

◆ $actype

array ilMimeMail::$actype = []

protected

Definition at line 53 of file class.ilMimeMail.php.

◆ $adisplay

array ilMimeMail::$adisplay = []

protected

Definition at line 57 of file class.ilMimeMail.php.

◆ $adispo

array ilMimeMail::$adispo = []

protected

Definition at line 55 of file class.ilMimeMail.php.

◆ $body

string ilMimeMail::$body = ''

protected

Definition at line 39 of file class.ilMimeMail.php.

Referenced by Body().

◆ $default_transport

ilMailMimeTransport ilMimeMail::$default_transport = null

staticprotected

Definition at line 33 of file class.ilMimeMail.php.

Referenced by getDefaultTransport().

◆ $final_body

string ilMimeMail::$final_body = ''

protected

Definition at line 40 of file class.ilMimeMail.php.

Referenced by getFinalBody().

◆ $final_body_alt

string ilMimeMail::$final_body_alt = ''

protected

Definition at line 41 of file class.ilMimeMail.php.

Referenced by getFinalBodyalt().

◆ $images

array ilMimeMail::$images = []

protected

Definition at line 49 of file class.ilMimeMail.php.

◆ $refinery

readonly Refinery ilMimeMail::$refinery

private

Definition at line 58 of file class.ilMimeMail.php.

◆ $sender

ilMailMimeSender ilMimeMail::$sender

protected

Definition at line 35 of file class.ilMimeMail.php.

Referenced by From(), and getFrom().

◆ $sendto

array ilMimeMail::$sendto = []

protected

Definition at line 43 of file class.ilMimeMail.php.

Referenced by getTo().

◆ $settings

ilSetting ilMimeMail::$settings

protected

Definition at line 37 of file class.ilMimeMail.php.

◆ $subject

string ilMimeMail::$subject = ''

protected

Definition at line 38 of file class.ilMimeMail.php.

Referenced by getSubject(), and Subject().

◆ $subject_builder

ilMailMimeSubjectBuilder ilMimeMail::$subject_builder

protected

Definition at line 36 of file class.ilMimeMail.php.

◆ $to_html_transformation

Closure ilMimeMail::$to_html_transformation = null

private

Definition at line 60 of file class.ilMimeMail.php.

Referenced by Body().

◆ MAIL_CSS_PATH

const string ilMimeMail::MAIL_CSS_PATH = 'assets/css/mail.css'

private

Definition at line 29 of file class.ilMimeMail.php.

◆ MAIL_LOGO_PATH

const string ilMimeMail::MAIL_LOGO_PATH = '/public/assets/images/logo/HeaderIcon.svg'

private

Definition at line 30 of file class.ilMimeMail.php.

◆ MAIL_SUBJECT_PREFIX

final const string ilMimeMail::MAIL_SUBJECT_PREFIX = '[ILIAS]'

Definition at line 26 of file class.ilMimeMail.php.

Referenced by ilObjMailGUI\populateExternalSettingsForm().

◆ ROOT_DIR_IDENTIFICATION_FILE

const string ilMimeMail::ROOT_DIR_IDENTIFICATION_FILE = '/ilias_version.php'

private

Definition at line 31 of file class.ilMimeMail.php.

◆ SKIN_CSS_PATH

const string ilMimeMail::SKIN_CSS_PATH = '/public/Customizing/skin/%s/mail.css'

private

Definition at line 28 of file class.ilMimeMail.php.

◆ SKIN_LOGO_PATH

const string ilMimeMail::SKIN_LOGO_PATH = '/public/Customizing/skin/%s/images/logo'

private

Definition at line 27 of file class.ilMimeMail.php.

The documentation for this class was generated from the following file:

components/ILIAS/Mail/classes/class.ilMimeMail.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addImage()

◆ Attach()

◆ Bcc()

◆ Body()

◆ build()

◆ Cc()

◆ containsHtmlBlockElementsOrLineBreaks()

◆ From()

◆ gatherImagesFromDirectory()

◆ getAttachments()

◆ getBcc()

◆ getCc()

◆ getDefaultTransport()

◆ getFinalBody()

◆ getFinalBodyalt()

◆ getFrom()

◆ getImages()

◆ getLogoCid()

◆ getPathToRootDirectory()

◆ getStyleSheetPath()

◆ getSubject()

◆ getTo()

◆ prepareHTMLBody()

◆ removeHtmlTags()

◆ Send()

◆ setDefaultTransport()

◆ Subject()

◆ To()

Field Documentation

◆ $aattach

◆ $abcc

◆ $acc

◆ $actype

◆ $adisplay

◆ $adispo

◆ $body

◆ $default_transport

◆ $final_body

◆ $final_body_alt

◆ $images

◆ $refinery

◆ $sender

◆ $sendto

◆ $settings

◆ $subject

◆ $subject_builder

◆ $to_html_transformation

◆ MAIL_CSS_PATH

◆ MAIL_LOGO_PATH

◆ MAIL_SUBJECT_PREFIX

◆ ROOT_DIR_IDENTIFICATION_FILE

◆ SKIN_CSS_PATH

◆ SKIN_LOGO_PATH