ilAccountMail Class Reference

Collaboration diagram for ilAccountMail:

Public Member Functions
	__construct ()
	useLangVariablesAsFallback (bool $a_status)
	areLangVariablesUsedAsFallback ()
	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, NewAccountMail $a_amail, string $a_lang)

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

Private Member Functions
	readAccountMail (string $a_lang)

Private Attributes
readonly ilSetting	$settings
readonly ilTree	$repository_tree
readonly ilMailMimeSenderFactory	$sender_factory
bool	$lang_variables_as_fallback = false
readonly ResourceStorage	$irss
readonly NewAccountMailRepository	$account_mail_repo
array	$amail = []
string	$permanent_link_target = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAccountMail::__construct

(

)

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

    {
        global $DIC;
        $this->settings = $DIC->settings();
        $this->repository_tree = $DIC->repositoryTree();
        $this->sender_factory = $DIC->mail()->mime()->senderFactory();
        $this->irss = $DIC->resourceStorage();
        $this->account_mail_repo = new NewAccountMailRepository($DIC->database());
    }

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

Here is the call graph for this function:

Member Function Documentation

areLangVariablesUsedAsFallback()

ilAccountMail::areLangVariablesUsedAsFallback

(

)

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

                                                    : bool
    {
        return $this->lang_variables_as_fallback;
    }

References $lang_variables_as_fallback.

getUser()

ilAccountMail::getUser

(

)

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

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

References $user.

Referenced by send().

Here is the caller graph for this function:

getUserPassword()

ilAccountMail::getUserPassword

(

)

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

                                     : string
    {
        return $this->u_password;
    }

References $u_password.

Referenced by replacePlaceholders().

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 101 of file class.ilAccountMail.php.

                                                    : NewAccountMail
    {
        if (!isset($this->amail[$a_lang]) || !($this->amail[$a_lang] instanceof NewAccountMail)) {
            $this->amail[$a_lang] = $this->account_mail_repo->getFor($a_lang);
        }
 
        return $this->amail[$a_lang];
    }

Referenced by send().

Here is the caller graph for this function:

replacePlaceholders()

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

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

                                                                                                                     : string
    {
        global $DIC;
        $settings = $DIC->settings();
        $mustache_factory = $DIC->mail()->mustacheFactory();
 
        $replacements = [];
 
        // determine salutation
        $replacements['MAIL_SALUTATION'] = $mustache_factory->getBasicEngine()->render(
            match ($a_user->getGender()) {
                'f' => trim($a_amail->getSalutationFemale()),
                'm' => trim($a_amail->getSalutationMale()),
                default => trim($a_amail->getSalutationNoneSpecific()),
            },
            [
                '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'] = $settings->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->repository_tree->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);
    }

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

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilAccountMail::reset

(

)

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

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

References ILIAS\Repository\user().

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.

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

                          : 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->getBody() === '' || $amail->getSubject() === '') {
            $fallback_language = 'en';
            $amail = $this->readAccountMail($this->settings->get('language', $fallback_language));
            $lang = $this->settings->get('language', $fallback_language);
        }
 
        $mmail = new ilMimeMail();
 
        // fallback if mail data is still not given
        if (($amail->getBody() === '' || $amail->getSubject() === '') && $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 {
            $attachment = $amail->getAttachment($this->irss);
            if ($attachment !== null) {
                $mmail->Attach($attachment[0], '', 'attachment', $attachment[1]);
            }
 
            // replace placeholders
            $mail_subject = $this->replacePlaceholders($amail->getSubject(), $user, $amail, $lang);
            $mail_body = $this->replacePlaceholders($amail->getBody(), $user, $amail, $lang);
        }
 
        $mmail->From($this->sender_factory->system());
        $mmail->Subject($mail_subject, true);
        $mmail->To($user->getEmail());
        $mmail->Body($mail_body);
 
        $mmail->Send();
 
        return true;
    }

References $amail, $lang, $user, ilObjUser\checkTimeLimit(), CLIENT_ID, ilDatePresentation\formatPeriod(), ilObjUser\getEmail(), ilObjUser\getFullname(), ilObjUser\getLanguage(), ilObjUser\getLogin(), ilObjUser\getProfileAsString(), ilObjUser\getTimeLimitFrom(), ilObjUser\getTimeLimitUntil(), getUser(), IL_CAL_UNIX, readAccountMail(), replacePlaceholders(), and ILIAS\Repository\settings().

Here is the call graph for this function:

setPermanentLinkTarget()

ilAccountMail::setPermanentLinkTarget

(

?string

$permanent_link_target

)

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

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

References $permanent_link_target.

setUser()

ilAccountMail::setUser

(

ilObjUser

$a_user

)

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

                                              : void
    {
        $this->user = $a_user;
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

setUserPassword()

ilAccountMail::setUserPassword

(

string

$a_pwd

)

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

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

useLangVariablesAsFallback()

ilAccountMail::useLangVariablesAsFallback

(

bool

$a_status

)

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

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

Field Documentation

$account_mail_repo

readonly NewAccountMailRepository ilAccountMail::$account_mail_repo

private

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

$amail

array ilAccountMail::$amail = []

private

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

Referenced by send().

$irss

readonly ResourceStorage ilAccountMail::$irss

private

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

$lang_variables_as_fallback

bool ilAccountMail::$lang_variables_as_fallback = false

private

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

Referenced by areLangVariablesUsedAsFallback().

$permanent_link_target

string ilAccountMail::$permanent_link_target = null

private

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

Referenced by replacePlaceholders(), and setPermanentLinkTarget().

$repository_tree

readonly ilTree ilAccountMail::$repository_tree

private

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

$sender_factory

readonly ilMailMimeSenderFactory ilAccountMail::$sender_factory

private

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

$settings

readonly ilSetting ilAccountMail::$settings

private

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

Referenced by replacePlaceholders().

$u_password

string ilAccountMail::$u_password = ''

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

Referenced by getUserPassword().

$user

ilObjUser ilAccountMail::$user = null

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

Referenced by getUser(), and send().

---

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

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