Collaboration diagram for ilMimeMail:

Public Member Functions
	__construct ()

	Subject (string $subject, bool $addPrefix=false, string $contextPrefix='')

	getSubject ()

	From (ilMailMimeSender $sender)

	To ($to)

	Cc ($cc)

	Bcc ($bcc)

	getTo ()

	getCc ()

	getBcc ()

	Body (string $body)

	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	MAIL_SUBJECT_PREFIX = '[ILIAS]'

Protected Member Functions
	build ()

	buildBodyMultiParts (string $skin, string $style)

	getHtmlEnvelope (string $skin, string $style)

	buildHtmlInlineImages (string $skin, string $style)

Protected Attributes
ilMailMimeSender	$sender

ilMailMimeSubjectBuilder	$subjectBuilder

ilSetting	$settings

string	$subject = ''

string	$body = ''

string	$finalBody = ''

string	$finalBodyAlt = ''

array	$sendto = []

array	$acc = []

array	$abcc = []

array	$images = []

array	$aattach = []

array	$actype = []

array	$adispo = []

array	$adisplay = []

Static Protected Attributes
static ilMailMimeTransport	$defaultTransport = null

Private Member Functions
	removeHTMLTags (string $maybeHTML)

	getPathToRootDirectory ()

Private Attributes
readonly Refinery	$refinery

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMimeMail::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ 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 180 of file class.ilMimeMail.php.

References $filename.

      : 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 120 of file class.ilMimeMail.php.

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

◆ Body()

ilMimeMail::Body ( string $body )

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

References $body.

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

◆ build()

ilMimeMail::build ( )

protected

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

References $DIC, buildBodyMultiParts(), buildHtmlInlineImages(), and removeHTMLTags().

Referenced by Send().

                               : void
     {
         global $DIC;
 
         $this->finalBodyAlt = '';
         $this->finalBody = '';
         $this->images = [];
 
         if ($DIC->settings()->get('mail_send_html', '0')) {
             $skin = $DIC['ilClientIniFile']->readVariable('layout', 'skin');
             $style = $DIC['ilClientIniFile']->readVariable('layout', 'style');
 
             $this->buildBodyMultiParts($skin, $style);
             $this->buildHtmlInlineImages($skin, $style);
         } else {
             $this->finalBody = $this->removeHTMLTags($this->body);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildBodyMultiParts()

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

protected

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

References getHtmlEnvelope(), and ILIAS\Repository\refinery().

Referenced by build().

                                                                        : 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 = $this->refinery->string()->makeClickable()->transform(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, $style));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHtmlInlineImages()

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

protected

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

References $location, and getPathToRootDirectory().

Referenced by build().

                                                                          : void
     {
         $this->gatherImagesFromDirectory(
             $this->getPathToRootDirectory() . '/components/ILIAS/Mail/templates/default/img'
         );
 
         if ($skin !== 'default') {
             $locations = [
                 $skin,
                 $skin . '/' . $style
             ];
 
             foreach ($locations as $location) {
                 $custom_directory = $this->getPathToRootDirectory(
                 ) . '/public/Customizing/skin/' . $location . '/components/ILIAS/Mail/img';
                 if (is_dir($custom_directory) && is_readable($custom_directory)) {
                     $this->gatherImagesFromDirectory($custom_directory, true);
                     break;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller 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 108 of file class.ilMimeMail.php.

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

◆ From()

ilMimeMail::From ( ilMailMimeSender $sender )

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

References $sender.

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

◆ getAttachments()

ilMimeMail::getAttachments ( )

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

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

Referenced by ilMailMimeTransportBase\send().

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

Here is the caller graph for this function:

◆ getBcc()

ilMimeMail::getBcc ( )

Returns: string[]

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

References $abcc.

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

                             : array
     {
         return $this->abcc;
     }

Here is the caller graph for this function:

◆ getCc()

ilMimeMail::getCc ( )

Returns: string[]

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

References $acc.

Referenced by ilMailMimeTransportBase\send().

                            : array
     {
         return $this->acc;
     }

Here is the caller graph for this function:

◆ getDefaultTransport()

static ilMimeMail::getDefaultTransport ( )

static

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

Referenced by ilMailTest\testExternalMailDeliveryToLocalRecipientsWorksAsExpected().

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

Here is the caller graph for this function:

◆ getFinalBody()

ilMimeMail::getFinalBody ( )

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

References $finalBody.

Referenced by ilMailMimeTransportBase\send().

                                   : string
     {
         return $this->finalBody;
     }

Here is the caller graph for this function:

◆ getFinalBodyAlt()

ilMimeMail::getFinalBodyAlt ( )

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

References $finalBodyAlt.

Referenced by ilMailMimeTransportBase\send().

                                      : string
     {
         return $this->finalBodyAlt;
     }

Here is the caller graph for this function:

◆ getFrom()

ilMimeMail::getFrom ( )

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

References $sender.

Referenced by ilMailMimeTransportBase\send().

                              : ilMailMimeSender
     {
         return $this->sender;
     }

Here is the caller graph for this function:

◆ getHtmlEnvelope()

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

protected

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

References $location, and getPathToRootDirectory().

Referenced by buildBodyMultiParts().

                                                                    : string
     {
         $bracket_path = $this->getPathToRootDirectory() . '/components/ILIAS/Mail/templates/default/tpl.html_mail_template.html';
         if ($skin !== 'default') {
             $locations = [
                 $skin,
                 $skin . '/' . $style
             ];
 
             foreach ($locations as $location) {
                 $custom_path = $this->getPathToRootDirectory(
                 ) . '/public/Customizing/skin/' . $location . '/components/ILIAS/Mail/tpl.html_mail_template.html';
                 if (is_file($custom_path)) {
                     $bracket_path = $custom_path;
                     break;
                 }
             }
         }
 
         return file_get_contents($bracket_path);
     }

Here is the call graph for this function:

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 224 of file class.ilMimeMail.php.

Referenced by ilMailMimeTransportBase\send().

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

Here is the caller graph for this function:

◆ getPathToRootDirectory()

ilMimeMail::getPathToRootDirectory ( )

private

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

Referenced by buildHtmlInlineImages(), and getHtmlEnvelope().

                                              : string
     {
         return realpath(dirname(__DIR__, 4) . '/');
     }

Here is the caller graph for this function:

◆ getSubject()

ilMimeMail::getSubject ( )

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

References $subject.

Referenced by ilMailMimeTransportBase\send().

                                 : string
     {
         return $this->subject;
     }

Here is the caller graph for this function:

◆ getTo()

ilMimeMail::getTo ( )

Returns: string[]

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

References $sendto.

Referenced by ilMailMimeTransportBase\send().

                            : array
     {
         return $this->sendto;
     }

Here is the caller graph for this function:

◆ removeHTMLTags()

ilMimeMail::removeHTMLTags ( string $maybeHTML )

private

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

Referenced by build().

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

Here is the caller graph for this function:

◆ Send()

ilMimeMail::Send ( ilMailMimeTransport $transport = null )

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

References build().

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

Here is the call graph for this function:

◆ setDefaultTransport()

static ilMimeMail::setDefaultTransport ( ?ilMailMimeTransport $transport )

static

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

Referenced by ilMailMimeTest\setUp(), and ilMailTest\testExternalMailDeliveryToLocalRecipientsWorksAsExpected().

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

Here is the caller graph for this function:

◆ Subject()

ilMimeMail::Subject	(	string	$subject,
		bool	$addPrefix = `false`,
		string	$contextPrefix = `''`
	)

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

                                                                                                  : void
     {
         $this->subject = $this->subjectBuilder->subject($subject, $addPrefix, $contextPrefix);
     }

◆ To()

ilMimeMail::To ( $to )

Parameters

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

Definition at line 96 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 45 of file class.ilMimeMail.php.

◆ $abcc

array ilMimeMail::$abcc = []

protected

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

Referenced by getBcc().

◆ $acc

array ilMimeMail::$acc = []

protected

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

Referenced by getCc().

◆ $actype

array ilMimeMail::$actype = []

protected

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

◆ $adisplay

array ilMimeMail::$adisplay = []

protected

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

◆ $adispo

array ilMimeMail::$adispo = []

protected

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

◆ $body

string ilMimeMail::$body = ''

protected

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

Referenced by Body().

◆ $defaultTransport

ilMailMimeTransport ilMimeMail::$defaultTransport = null

staticprotected

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

◆ $finalBody

string ilMimeMail::$finalBody = ''

protected

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

Referenced by getFinalBody().

◆ $finalBodyAlt

string ilMimeMail::$finalBodyAlt = ''

protected

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

Referenced by getFinalBodyAlt().

◆ $images

array ilMimeMail::$images = []

protected

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

◆ $refinery

readonly Refinery ilMimeMail::$refinery

private

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

◆ $sender

ilMailMimeSender ilMimeMail::$sender

protected

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

Referenced by From(), and getFrom().

◆ $sendto

array ilMimeMail::$sendto = []

protected

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

Referenced by getTo().

◆ $settings

ilSetting ilMimeMail::$settings

protected

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

◆ $subject

string ilMimeMail::$subject = ''

protected

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

Referenced by getSubject().

◆ $subjectBuilder

ilMailMimeSubjectBuilder ilMimeMail::$subjectBuilder

protected

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

◆ MAIL_SUBJECT_PREFIX

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

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

Referenced by ilObjMailGUI\populateExternalSettingsForm().

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

◆ Attach()

◆ Bcc()

◆ Body()

◆ build()

◆ buildBodyMultiParts()

◆ buildHtmlInlineImages()

◆ Cc()

◆ From()

◆ getAttachments()

◆ getBcc()

◆ getCc()

◆ getDefaultTransport()

◆ getFinalBody()

◆ getFinalBodyAlt()

◆ getFrom()

◆ getHtmlEnvelope()

◆ getImages()

◆ getPathToRootDirectory()

◆ getSubject()

◆ getTo()

◆ removeHTMLTags()

◆ Send()

◆ setDefaultTransport()

◆ Subject()

◆ To()

Field Documentation

◆ $aattach

◆ $abcc

◆ $acc

◆ $actype

◆ $adisplay

◆ $adispo

◆ $body

◆ $defaultTransport

◆ $finalBody

◆ $finalBodyAlt

◆ $images

◆ $refinery

◆ $sender

◆ $sendto

◆ $settings

◆ $subject

◆ $subjectBuilder

◆ MAIL_SUBJECT_PREFIX