Collaboration diagram for ilMimeMail:

Public Member Functions
	__construct ()
	ilMimeMail constructor. More...

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

	getSubject ()

	From (ilMailMimeSender $sender)

	To ($to)
	Set the mail recipient. More...

	Cc ($cc)
	Set the cc mail recipient. More...

	Bcc ($bcc)
	Set the bcc mail recipient. More...

	getTo ()

	getCc ()

	getBcc ()

	Body (string $body)

	getFinalBody ()

	getFinalBodyAlt ()

	getFrom ()

	Attach (string $filename, string $file_type='', string $disposition='inline', ?string $display_name=null)
	Attach a file to the mail. More...

	getAttachments ()

	getImages ()

	Send (ilMailMimeTransport $transport=null)

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

static	getDefaultTransport ()

Data Fields
const	MAIL_SUBJECT_PREFIX = '[ILIAS]'

Protected Member Functions
	build ()
	Build the relevant email data. More...

	buildBodyMultiParts (string $skin)

	getHtmlEnvelope (string $skin)

	buildHtmlInlineImages (string $skin)

Protected Attributes
	$subject = ''

	$body = ''

	$finalBody = ''

	$finalBodyAlt = ''

	$sendto = []

	$acc = []

	$abcc = []

	$images = []

	$aattach = []

	$actype = []

	$adispo = []

	$adisplay = []

	$sender

	$settings

	$subjectBuilder

Static Protected Attributes
static	$defaultTransport = null

Private Member Functions
	removeHTMLTags (string $maybeHTML)

Detailed Description

Class ilMimeMail.

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

Constructor & Destructor Documentation

◆ __construct()

ilMimeMail::__construct ( )

ilMimeMail constructor.

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

References $DIC, $factory, and settings().

     {
         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);
     }

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`
	)

Attach a file to the mail.

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 202 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 )

Set the bcc mail recipient.

Parameters

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

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

References $body.

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

◆ build()

ilMimeMail::build ( )

protected

Build the relevant email data.

Definition at line 253 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');
 
             $this->buildBodyMultiParts($skin);
             $this->buildHtmlInlineImages($skin);
         } 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 )

protected

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

References getHtmlEnvelope(), and ilUtil\makeClickable().

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 = \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));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHtmlInlineImages()

ilMimeMail::buildHtmlInlineImages ( string $skin )

protected

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

Referenced by build().

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

Here is the caller graph for this function:

◆ Cc()

ilMimeMail::Cc ( $cc )

Set the cc mail recipient.

Parameters

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

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

References $sender.

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

◆ getAttachments()

ilMimeMail::getAttachments ( )

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

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

References $i, and $name.

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 170 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 162 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 92 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 180 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 185 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 190 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 )

protected

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

Referenced by buildBodyMultiParts().

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

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

Referenced by ilMailMimeTransportBase\send().

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

Here is the caller graph for this function:

◆ getSubject()

ilMimeMail::getSubject ( )

Definition at line 102 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 154 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 271 of file class.ilMimeMail.php.

Referenced by build().

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

Here is the caller graph for this function:

◆ Send()

ilMimeMail::Send ( ilMailMimeTransport $transport = null )

Parameters

$transport ilMailMimeTransport|null

Returns: bool A boolean flag whether the transport might be successful

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

Parameters

ilMailMimeTransport | null $transport

Exceptions

InvalidArgumentException

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

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

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

Here is the caller graph for this function:

◆ Subject()

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

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

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

◆ To()

ilMimeMail::To ( $to )

Set the mail recipient.

Parameters

string|string[] To 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($to)) {
             $this->sendto = $to;
         } else {
             $this->sendto[] = $to;
         }
     }

Field Documentation

◆ $aattach

ilMimeMail::$aattach = []

protected

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

◆ $abcc

ilMimeMail::$abcc = []

protected

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

Referenced by getBcc().

◆ $acc

ilMimeMail::$acc = []

protected

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

Referenced by getCc().

◆ $actype

ilMimeMail::$actype = []

protected

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

◆ $adisplay

ilMimeMail::$adisplay = []

protected

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

◆ $adispo

ilMimeMail::$adispo = []

protected

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

◆ $body

ilMimeMail::$body = ''

protected

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

Referenced by Body().

◆ $defaultTransport

ilMimeMail::$defaultTransport = null

staticprotected

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

◆ $finalBody

ilMimeMail::$finalBody = ''

protected

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

Referenced by getFinalBody().

◆ $finalBodyAlt

ilMimeMail::$finalBodyAlt = ''

protected

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

Referenced by getFinalBodyAlt().

◆ $images

ilMimeMail::$images = []

protected

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

◆ $sender

ilMimeMail::$sender

protected

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

Referenced by From(), and getFrom().

◆ $sendto

ilMimeMail::$sendto = []

protected

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

Referenced by getTo().

◆ $settings

ilMimeMail::$settings

protected

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

◆ $subject

ilMimeMail::$subject = ''

protected

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

Referenced by getSubject().

◆ $subjectBuilder

ilMimeMail::$subjectBuilder

protected

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

◆ MAIL_SUBJECT_PREFIX

const ilMimeMail::MAIL_SUBJECT_PREFIX = '[ILIAS]'

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

Referenced by ilObjMailGUI\populateExternalSettingsForm().

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

Services/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

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()

◆ getSubject()

◆ getTo()

◆ removeHTMLTags()

◆ Send()

◆ setDefaultTransport()

◆ Subject()

◆ To()

Field Documentation

◆ $aattach

◆ $abcc

◆ $acc

◆ $actype

◆ $adisplay

◆ $adispo

◆ $body

◆ $defaultTransport

◆ $finalBody

◆ $finalBodyAlt

◆ $images

◆ $sender

◆ $sendto

◆ $settings

◆ $subject

◆ $subjectBuilder

◆ MAIL_SUBJECT_PREFIX