ilAccountMail Class Reference

Class ilAccountMail. More...

Collaboration diagram for ilAccountMail:

Public Member Functions
	__construct ()
	useLangVariablesAsFallback (bool $a_status)
	areLangVariablesUsedAsFallback ()
	shouldAttachConfiguredFiles ()
	setAttachConfiguredFiles (bool $attachConfiguredFiles)
	setUserPassword (string $a_pwd)
	getUserPassword ()
	setUser (ilObjUser $a_user)
	setPermanentLinkTarget (?string $permanent_link_target)
	getUser ()
	reset ()
	send ()
	Sends the mail with its object properties as MimeMail It first tries to read the mail body, subject and sender address from posted named formular fields. More...
	replacePlaceholders (string $a_string, ilObjUser $a_user, array $a_amail, string $a_lang)
	addAttachment (string $a_filename, string $a_display_name)

Data Fields
string	$u_password = ''
ilObjUser	$user = null

Private Member Functions
	ensureValidMailDataShape (array $mailData)
	readAccountMail (string $a_lang)
	addAttachments (array $mailData)

Private Attributes
readonly ilSetting	$settings
readonly ilTree	$repositoryTree
readonly ilMailMimeSenderFactory	$senderFactory
bool	$lang_variables_as_fallback = false
array	$attachments = []
bool	$attachConfiguredFiles = false
array	$amail = []
string	$permanent_link_target = null

Detailed Description

Class ilAccountMail.

Sends e-mail to newly created accounts.

Author

Stefan Schneider stefa.nosp@m.n.sc.nosp@m.hneid.nosp@m.er@h.nosp@m.rz.un.nosp@m.i-gi.nosp@m.essen.nosp@m..de

Alex Killing alex..nosp@m.kill.nosp@m.ing@h.nosp@m.rz.u.nosp@m.ni-gi.nosp@m.esse.nosp@m.n.de

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

Constructor & Destructor Documentation

__construct()

ilAccountMail::__construct

(

)

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

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

    {
        global $DIC;
        $this->settings = $DIC->settings();
        $this->repositoryTree = $DIC->repositoryTree();
        $this->senderFactory = $DIC->mail()->mime()->senderFactory();
    }

Here is the call graph for this function:

Member Function Documentation

addAttachment()

ilAccountMail::addAttachment	(	string	$a_filename,
		string	$a_display_name
	)

Definition at line 319 of file class.ilAccountMail.php.

Referenced by addAttachments().

                                                                             : void
    {
        $this->attachments[$a_filename] = $a_display_name;
    }

Here is the caller graph for this function:

addAttachments()

ilAccountMail::addAttachments ( array  $mailData )

private

Parameters

array{lang?

string, subject?: string, body?: string, sal_f?: string, sal_g?: string, sal_m?: string, type?: string, att_file?: string} $mailData

Exceptions

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

References addAttachment(), shouldAttachConfiguredFiles(), and USER_FOLDER_ID.

Referenced by send().

                                                    : void
    {
        if (isset($mailData['att_file']) && $this->shouldAttachConfiguredFiles()) {
            $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
            $fs->create();

            $pathToFile = '/' . implode('/', array_map(static function (string $pathPart): string {
                return trim($pathPart, '/');
            }, [
                $fs->getAbsolutePath(),
                $mailData['lang'],
            ]));

            $this->addAttachment($pathToFile, $mailData['att_file']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

areLangVariablesUsedAsFallback()

ilAccountMail::areLangVariablesUsedAsFallback

(

)

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

References $lang_variables_as_fallback.

Referenced by send().

                                                    : bool
    {
        return $this->lang_variables_as_fallback;
    }

Here is the caller graph for this function:

ensureValidMailDataShape()

ilAccountMail::ensureValidMailDataShape ( array  $mailData )

private

Parameters

array{lang?

string, subject?: string, body?: string, sal_f?: string, sal_g?: string, sal_m?: string, type?: string, att_file?: string} $mailData

Returns

array{lang?: string, subject?: string, body?: string, sal_f?: string, sal_g?: string, sal_m?: string, type?: string, att_file?: string}

Definition at line 124 of file class.ilAccountMail.php.

Referenced by readAccountMail().

                                                              : array
    {
        foreach (['lang', 'subject', 'body', 'sal_f', 'sal_g', 'sal_m', 'type'] as $key) {
            if (!isset($mailData[$key])) {
                $mailData[$key] = '';
            }
        }

        $mailData['subject'] = trim($mailData['subject']);
        $mailData['body'] = trim($mailData['body']);

        return $mailData;
    }

Here is the caller graph for this function:

getUser()

ilAccountMail::getUser

(

)

Definition at line 108 of file class.ilAccountMail.php.

References $user.

Referenced by send().

                             : ?ilObjUser
    {
        return $this->user;
    }

Here is the caller graph for this function:

getUserPassword()

ilAccountMail::getUserPassword

(

)

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

References $u_password.

Referenced by replacePlaceholders().

                                     : string
    {
        return $this->u_password;
    }

Here is the caller graph for this function:

readAccountMail()

ilAccountMail::readAccountMail ( string  $a_lang )

private

Returns

array{lang?: string, subject?: string, body?: string, sal_f?: string, sal_g?: string, sal_m?: string, type?: string}

Definition at line 141 of file class.ilAccountMail.php.

References ilObjUserFolder\_lookupNewAccountMail(), and ensureValidMailDataShape().

Referenced by send().

                                                    : array
    {
        if (!isset($this->amail[$a_lang]) || !is_array($this->amail[$a_lang])) {
            $this->amail[$a_lang] = $this->ensureValidMailDataShape(
                ilObjUserFolder::_lookupNewAccountMail($a_lang)
            );
        }

        return $this->amail[$a_lang];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replacePlaceholders()

ilAccountMail::replacePlaceholders	(	string	$a_string,
		ilObjUser	$a_user,
		array	$a_amail,
		string	$a_lang
	)

Definition at line 252 of file class.ilAccountMail.php.

References $DIC, $ilSetting, $permanent_link_target, ilLanguage\_lookupEntry(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), CLIENT_ID, CLIENT_NAME, ilDatePresentation\formatPeriod(), ilObjUser\getEmail(), ilObjUser\getFirstname(), ilObjUser\getGender(), ilObjUser\getLastname(), ilObjUser\getLogin(), ilObjUser\getTimeLimitFrom(), ilObjUser\getTimeLimitUnlimited(), ilObjUser\getTimeLimitUntil(), getUserPassword(), IL_CAL_UNIX, and ILIAS\Repository\repositoryTree().

Referenced by send().

                                                                                                            : string
    {
        global $DIC;
        $tree = $DIC->repositoryTree();
        $ilSetting = $DIC->settings();
        $mustache_factory = $DIC->mail()->mustacheFactory();

        $replacements = [];

        // determine salutation
        $replacements['MAIL_SALUTATION'] = $mustache_factory->getBasicEngine()->render(
            match ($a_user->getGender()) {
                'f' => trim((string) $a_amail['sal_f']),
                'm' => trim((string) $a_amail['sal_m']),
                default => trim((string) $a_amail['sal_g']),
            },
            [
                'FIRST_NAME' => $a_user->getFirstname(),
                'LAST_NAME' => $a_user->getLastname(),
                'LOGIN' => $a_user->getLogin(),
            ]
        );
        $replacements['LOGIN'] = $a_user->getLogin();
        $replacements['FIRST_NAME'] = $a_user->getFirstname();
        $replacements['LAST_NAME'] = $a_user->getLastname();
        // BEGIN Mail Include E-Mail Address in account mail
        $replacements['EMAIL'] = $a_user->getEmail();
        // END Mail Include E-Mail Address in account mail
        $replacements['PASSWORD'] = $this->getUserPassword();
        $replacements['ILIAS_URL'] = ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID;
        $replacements['CLIENT_NAME'] = CLIENT_NAME;
        $replacements['ADMIN_MAIL'] = $ilSetting->get('admin_email');
        $replacements['IF_PASSWORD'] = $this->getUserPassword() != '';
        $replacements['IF_NO_PASSWORD'] = $this->getUserPassword() == '';

        // #13346
        if (!$a_user->getTimeLimitUnlimited()) {
            // #6098
            $replacements['IF_TIMELIMIT'] = !$a_user->getTimeLimitUnlimited();
            $timelimit_from = new ilDateTime($a_user->getTimeLimitFrom(), IL_CAL_UNIX);
            $timelimit_until = new ilDateTime($a_user->getTimeLimitUntil(), IL_CAL_UNIX);
            $timelimit = ilDatePresentation::formatPeriod($timelimit_from, $timelimit_until);
            $replacements['TIMELIMIT'] = $timelimit;
        }

        // target
        $replacements['IF_TARGET'] = false;
        if ($this->permanent_link_target !== null) {
            $tarr = explode('_', $this->permanent_link_target);
            if ($this->repositoryTree->isInTree((int) $tarr[1])) {
                $obj_id = ilObject::_lookupObjId((int) $tarr[1]);
                $type = ilObject::_lookupType($obj_id);
                if ($type === $tarr[0]) {
                    $replacements['TARGET_TITLE'] = ilObject::_lookupTitle($obj_id);
                    $replacements['TARGET'] = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . '&target=' . $this->permanent_link_target;

                    // this looks complicated, but we may have no initilised $lng object here
                    // if mail is send during user creation in authentication
                    $replacements['TARGET_TYPE'] = ilLanguage::_lookupEntry($a_lang, 'common', 'obj_' . $tarr[0]);
                    $replacements['IF_TARGET'] = true;
                }
            }
        }

        return $mustache_factory->getBasicEngine()->render($a_string, $replacements);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilAccountMail::reset

(

)

Definition at line 113 of file class.ilAccountMail.php.

References ILIAS\Repository\user().

                           : void
    {
        $this->user = null;
        $this->u_password = '';
        $this->permanent_link_target = null;
    }

Here is the call graph for this function:

send()

ilAccountMail::send

(

)

Sends the mail with its object properties as MimeMail It first tries to read the mail body, subject and sender address from posted named formular fields.

If no field values found the defaults are used. Placehoders will be replaced by the appropriate data.

Exceptions

RuntimeException

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

References $filename, addAttachments(), areLangVariablesUsedAsFallback(), ilObjUser\checkTimeLimit(), CLIENT_ID, ilDatePresentation\formatPeriod(), ilObjUser\getEmail(), ilObjUser\getFullname(), ilObjUser\getLanguage(), ilObjUser\getLogin(), ilObjUser\getTimeLimitFrom(), ilObjUser\getTimeLimitUntil(), getUser(), IL_CAL_UNIX, readAccountMail(), replacePlaceholders(), and ILIAS\Repository\settings().

                          : bool
    {
        $user = $this->getUser();
        if (!$user instanceof ilObjUser) {
            throw new RuntimeException('A user instance must be passed when sending emails');
        }

        if ($user->getEmail() === '') {
            return false;
        }

        // determine language and get account mail data
        // fall back to default language if acccount mail data is not given for user language.
        $amail = $this->readAccountMail($user->getLanguage());
        $lang = $user->getLanguage();
        if ($amail['body'] === '' || $amail['subject'] === '') {
            $fallback_language = 'en';
            $amail = $this->readAccountMail($this->settings->get('language', $fallback_language));
            $lang = $this->settings->get('language', $fallback_language);
        }

        // fallback if mail data is still not given
        if (($amail['body'] === '' || $amail['subject'] === '') && $this->areLangVariablesUsedAsFallback()) {
            $lang = $user->getLanguage();
            $tmp_lang = new ilLanguage($lang);

            $mail_subject = $tmp_lang->txt('reg_mail_subject');

            $timelimit = '';
            if (!$user->checkTimeLimit()) {
                $tmp_lang->loadLanguageModule('registration');

                // #6098
                $timelimit_from = new ilDateTime($user->getTimeLimitFrom(), IL_CAL_UNIX);
                $timelimit_until = new ilDateTime($user->getTimeLimitUntil(), IL_CAL_UNIX);
                $timelimit = ilDatePresentation::formatPeriod($timelimit_from, $timelimit_until);
                $timelimit = "\n" . sprintf($tmp_lang->txt('reg_mail_body_timelimit'), $timelimit) . "\n\n";
            }

            // mail body
            $mail_body = $tmp_lang->txt('reg_mail_body_salutation') . ' ' . $user->getFullname() . ",\n\n" .
                $tmp_lang->txt('reg_mail_body_text1') . "\n\n" .
                $tmp_lang->txt('reg_mail_body_text2') . "\n" .
                ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID . "\n";
            $mail_body .= $tmp_lang->txt('login') . ': ' . $user->getLogin() . "\n";
            $mail_body .= $tmp_lang->txt('passwd') . ': ' . $this->u_password . "\n";
            $mail_body .= "\n" . $timelimit;
            $mail_body .= $tmp_lang->txt('reg_mail_body_text3') . "\n\r";
            $mail_body .= $user->getProfileAsString($tmp_lang);
        } else {
            $this->addAttachments($amail);

            // replace placeholders
            $mail_subject = $this->replacePlaceholders($amail['subject'], $user, $amail, $lang);
            $mail_body = $this->replacePlaceholders($amail['body'], $user, $amail, $lang);
        }

        $mmail = new ilMimeMail();
        $mmail->From($this->senderFactory->system());
        $mmail->Subject($mail_subject, true);
        $mmail->To($user->getEmail());
        $mmail->Body($mail_body);

        foreach ($this->attachments as $filename => $display_name) {
            $mmail->Attach($filename, '', 'attachment', $display_name);
        }

        $mmail->Send();

        return true;
    }

Here is the call graph for this function:

setAttachConfiguredFiles()

ilAccountMail::setAttachConfiguredFiles

(

bool

$attachConfiguredFiles

)

Definition at line 70 of file class.ilAccountMail.php.

References $attachConfiguredFiles.

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

setPermanentLinkTarget()

ilAccountMail::setPermanentLinkTarget

(

?string

$permanent_link_target

)

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

References $permanent_link_target.

                                                                          : void
    {
        if ($permanent_link_target === '') {
            throw new InvalidArgumentException(
                'Permanent link target must not be empty'
            );
        }

        $this->permanent_link_target = $permanent_link_target;
    }

setUser()

ilAccountMail::setUser

(

ilObjUser

$a_user

)

Definition at line 85 of file class.ilAccountMail.php.

References ilObject\getId(), and ILIAS\Repository\user().

                                              : void
    {
        if (
            $this->user instanceof ilObjUser &&
            $a_user->getId() !== $this->user->getId()
        ) {
            $this->attachments = [];
        }

        $this->user = $a_user;
    }

Here is the call graph for this function:

setUserPassword()

ilAccountMail::setUserPassword

(

string

$a_pwd

)

Definition at line 75 of file class.ilAccountMail.php.

                                                  : void
    {
        $this->u_password = $a_pwd;
    }

shouldAttachConfiguredFiles()

ilAccountMail::shouldAttachConfiguredFiles

(

)

Definition at line 65 of file class.ilAccountMail.php.

References $attachConfiguredFiles.

Referenced by addAttachments().

                                                 : bool
    {
        return $this->attachConfiguredFiles;
    }

Here is the caller graph for this function:

useLangVariablesAsFallback()

ilAccountMail::useLangVariablesAsFallback

(

bool

$a_status

)

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

                                                              : void
    {
        $this->lang_variables_as_fallback = $a_status;
    }

Field Documentation

$amail

array ilAccountMail::$amail = []

private

Definition at line 44 of file class.ilAccountMail.php.

$attachConfiguredFiles

bool ilAccountMail::$attachConfiguredFiles = false

private

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

Referenced by setAttachConfiguredFiles(), and shouldAttachConfiguredFiles().

$attachments

array ilAccountMail::$attachments = []

private

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

$lang_variables_as_fallback

bool ilAccountMail::$lang_variables_as_fallback = false

private

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

Referenced by areLangVariablesUsedAsFallback().

$permanent_link_target

string ilAccountMail::$permanent_link_target = null

private

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

Referenced by replacePlaceholders(), and setPermanentLinkTarget().

$repositoryTree

readonly ilTree ilAccountMail::$repositoryTree

private

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

$senderFactory

readonly ilMailMimeSenderFactory ilAccountMail::$senderFactory

private

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

$settings

readonly ilSetting ilAccountMail::$settings

private

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

$u_password

string ilAccountMail::$u_password = ''

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

Referenced by getUserPassword().

$user

ilObjUser ilAccountMail::$user = null

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

Referenced by getUser().

---

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

• components/ILIAS/Mail/classes/class.ilAccountMail.php