Collaboration diagram for ilMimeMail:

Public Member Functions
	__construct (?MailBodyComposer $body_composer=null)

	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)

	AttachResource (ResourceIdentification $resource_identification, string $display_name, string $file_type='', string $disposition='inline')

	getMimeAttachments ()

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

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 = []

InlineImages	$images

array	$mime_attachments = []

Static Protected Attributes
static ilMailMimeTransport	$default_transport = null

Private Member Functions
	bodyComposer ()
	Resolved on demand, so that merely constructing a mail stays free of the services only its delivery format requires. More...

Private Attributes
MailBodyComposer	$body_composer

Closure	$to_html_transformation = null

readonly ILIAS DI Container	$dic

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMimeMail::__construct ( ?MailBodyComposer $body_composer = null )

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

    {
        global $DIC;
 
        $this->dic = $DIC;
 
        $this->settings = $this->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->body_composer = $body_composer;
        $this->images = InlineImages::none();
    }

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

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

     : void {
        $this->mime_attachments[] = MailMimeAttachment::fromPath(
            $filename,
            $file_type,
            $disposition,
            $display_name
        );
    }

◆ AttachResource()

ilMimeMail::AttachResource	(	ResourceIdentification	$resource_identification,
		string	$display_name,
		string	$file_type = `''`,
		string	$disposition = `'inline'`
	)

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

     : void {
        $this->mime_attachments[] = MailMimeAttachment::fromResource(
            $resource_identification,
            $display_name,
            $file_type,
            $disposition
        );
    }

◆ Bcc()

ilMimeMail::Bcc ( $bcc )

Parameters

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

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

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

References $body, and $to_html_transformation.

◆ bodyComposer()

ilMimeMail::bodyComposer ( )

private

Resolved on demand, so that merely constructing a mail stays free of the services only its delivery format requires.

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

                                   : MailBodyComposer
    {
        return $this->body_composer ??= $this->dic->mail()->mime()->bodyComposer();
    }

◆ build()

ilMimeMail::build ( )

protected

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

                              : void
    {
        $composed = $this->bodyComposer()->compose(
            new MailBodySource($this->body, $this->to_html_transformation)
        );
 
        $this->final_body = $composed->body();
        $this->final_body_alt = $composed->alternativeBody() ?? '';
        $this->images = $composed->images();
    }

◆ Cc()

ilMimeMail::Cc ( $cc )

Parameters

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

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

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

References $sender.

◆ getAttachments()

ilMimeMail::getAttachments ( )

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

Deprecated:: Use getMimeAttachments() for path and IRSS attachments.

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

                                    : array
    {
        $attachments = [];
 
        foreach ($this->mime_attachments as $attachment) {
            if ($attachment->isResource() || $attachment->getPath() === null) {
                continue;
            }
 
            $attachments[] = [
                'path' => $attachment->getPath(),
                'name' => $attachment->getDisplayName(),
            ];
        }
 
        return $attachments;
    }

◆ getBcc()

ilMimeMail::getBcc ( )

Returns: string[]

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

                            : array
    {
        return $this->abcc;
    }

References $abcc.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getCc()

ilMimeMail::getCc ( )

Returns: string[]

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

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

References $default_transport.

◆ getFinalBody()

ilMimeMail::getFinalBody ( )

Definition at line 175 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 180 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 185 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 ( )

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

                               : InlineImages
    {
        return $this->images;
    }

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getMimeAttachments()

ilMimeMail::getMimeAttachments ( )

Returns: list<MailMimeAttachment>

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

                                        : array
    {
        return $this->mime_attachments;
    }

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ getSubject()

ilMimeMail::getSubject ( )

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

                           : array
    {
        return $this->sendto;
    }

References $sendto.

Referenced by ilMailMimeTransportBase\send().

Here is the caller graph for this function:

◆ Send()

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

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

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

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

Here is the caller graph for this function:

◆ Subject()

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

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

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

Field Documentation

◆ $abcc

array ilMimeMail::$abcc = []

protected

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

Referenced by getBcc().

◆ $acc

array ilMimeMail::$acc = []

protected

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

Referenced by getCc().

◆ $body

string ilMimeMail::$body = ''

protected

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

Referenced by Body().

◆ $body_composer

MailBodyComposer ilMimeMail::$body_composer

private

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

Referenced by __construct().

◆ $default_transport

ilMailMimeTransport ilMimeMail::$default_transport = null

staticprotected

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

Referenced by getDefaultTransport().

◆ $dic

readonly ILIAS DI Container ilMimeMail::$dic

private

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

◆ $final_body

string ilMimeMail::$final_body = ''

protected

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

Referenced by getFinalBody().

◆ $final_body_alt

string ilMimeMail::$final_body_alt = ''

protected

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

Referenced by getFinalBodyalt().

◆ $images

InlineImages ilMimeMail::$images

protected

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

◆ $mime_attachments

array ilMimeMail::$mime_attachments = []

protected

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

◆ $sender

ilMailMimeSender ilMimeMail::$sender

protected

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

Referenced by From(), and getFrom().

◆ $sendto

array ilMimeMail::$sendto = []

protected

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

Referenced by getTo().

◆ $settings

ilSetting ilMimeMail::$settings

protected

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

◆ $subject

string ilMimeMail::$subject = ''

protected

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

Referenced by getSubject(), and Subject().

◆ $subject_builder

ilMailMimeSubjectBuilder ilMimeMail::$subject_builder

protected

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

◆ $to_html_transformation

Closure ilMimeMail::$to_html_transformation = null

private

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

Referenced by Body().

◆ MAIL_SUBJECT_PREFIX

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

Definition at line 29 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()

◆ AttachResource()

◆ Bcc()

◆ Body()

◆ bodyComposer()

◆ build()

◆ Cc()

◆ From()

◆ getAttachments()

◆ getBcc()

◆ getCc()

◆ getDefaultTransport()

◆ getFinalBody()

◆ getFinalBodyalt()

◆ getFrom()

◆ getImages()

◆ getMimeAttachments()

◆ getSubject()

◆ getTo()

◆ Send()

◆ setDefaultTransport()

◆ Subject()

◆ To()

Field Documentation

◆ $abcc

◆ $acc

◆ $body

◆ $body_composer

◆ $default_transport

◆ $dic

◆ $final_body

◆ $final_body_alt

◆ $images

◆ $mime_attachments

◆ $sender

◆ $sendto

◆ $settings

◆ $subject

◆ $subject_builder

◆ $to_html_transformation

◆ MAIL_SUBJECT_PREFIX