Class ilAccountRegistrationMail. More...

Inheritance diagram for ilAccountRegistrationMail:

Collaboration diagram for ilAccountRegistrationMail:

Public Member Functions
	__construct (ilRegistrationSettings $settings, ilLanguage $lng, ilLogger $logger)

	getMode ()

	withDirectRegistrationMode ()

	withEmailConfirmationRegistrationMode ()

	send (ilObjUser $user, string $rawPassword='', bool $usedRegistrationCode=false)

Public Member Functions inherited from ilMimeMailNotification
	__construct (bool $a_is_personal_workspace=false)

	sendMimeMail (string $a_rcp)

	setCurrentRecipient (string $current_recipient)

	getCurrentRecipient ()

	setMimeMail (ilMimeMail $mime_mail)

	getMimeMail ()

Public Member Functions inherited from ilMailNotification
	__construct (bool $a_is_personal_workspace=false)

	setType (int $a_type)

	getType ()

	setSender (int $a_usr_id)

	getSender ()

	setRecipients (array $a_rcp)

	getRecipients ()

	setAttachments (array $a_att)

	getAttachments ()

	setLangModules (array $a_modules)

	getUserLanguage (int $a_usr_id)

	setRefId (int $a_id)

	getRefId ()

	getObjId ()

	setObjId (int $a_obj_id)

	getObjType ()

	setAdditionalInformation (array $a_info)

	getAdditionalInformation ()

	sendMail (array $a_rcp, bool $a_parse_recipients=true)

	getBlockBorder ()

Protected Attributes
const	MODE_DIRECT_REGISTRATION = 1

const	MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION = 2

Protected Attributes inherited from ilMimeMailNotification
ilMimeMail	$mime_mail

string	$current_recipient

ilMailMimeSenderFactory	$senderFactory

Protected Attributes inherited from ilMailNotification
int	$type

int	$sender

ilMail	$mail = null

string	$subject = ''

string	$body = ''

array	$attachments = []

ilLanguage	$language

array	$lang_modules = []

array	$recipients = []

int	$ref_id

int	$obj_id = 0

string	$obj_type = ''

array	$additional_info = []

bool	$is_in_wsp

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

Private Member Functions
	isEmptyMailConfigurationData (array $mailData)

	trySendingUserDefinedAccountMail (ilObjUser $user, string $rawPassword)

	sendLanguageVariableBasedAccountMail (ilObjUser $user, string $rawPassword, bool $usedRegistrationCode)

Private Attributes
ilRegistrationSettings	$settings

ilLogger	$logger

int	$mode = self::MODE_DIRECT_REGISTRATION

Additional Inherited Members
Data Fields inherited from ilMailNotification
const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions inherited from ilMimeMailNotification
	setSubject (string $a_subject)

	initMimeMail ()

	initLanguageByIso2Code (string $a_code='')

	initLanguage (int $a_usr_id)

Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)

	getSubject ()

	setBody (string $a_body)

	appendBody (string $a_body)

	getBody ()

	initLanguage (int $a_usr_id)

	initLanguageByIso2Code (string $a_code='')

	setLanguage (ilLanguage $a_language)

	getLanguage ()

	getLanguageText (string $a_keyword)

	getObjectTitle (bool $a_shorten=false)

	initMail ()

	getMail ()

	createPermanentLink (array $a_params=[], string $a_append='')

	userToString (int $a_usr_id)

	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission="read")

Detailed Description

Class ilAccountRegistrationMail.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilAccountRegistrationMail::__construct	(	ilRegistrationSettings	$settings,
		ilLanguage	$lng,
		ilLogger	$logger
	)

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

    {
        $this->settings = $settings;
        $this->logger = $logger;
        parent::__construct(false);
    }

References $logger, $settings, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ getMode()

ilAccountRegistrationMail::getMode ( )

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

                             : int
    {
        return $this->mode;
    }

References $mode.

◆ isEmptyMailConfigurationData()

ilAccountRegistrationMail::isEmptyMailConfigurationData ( array $mailData )

private

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

                                                                  : bool
    {
        return !(
            isset($mailData['body'], $mailData['subject']) &&
            is_string($mailData['body']) &&
            $mailData['body'] !== '' &&
            is_string($mailData['subject']) &&
            $mailData['subject'] !== ''
        );
    }

Referenced by trySendingUserDefinedAccountMail().

Here is the caller graph for this function:

◆ send()

ilAccountRegistrationMail::send	(	ilObjUser	$user,
		string	$rawPassword = `''`,
		bool	$usedRegistrationCode = `false`
	)

Definition at line 213 of file class.ilAccountRegistrationMail.php.

                                                                                                       : void
    {
        if (!$this->trySendingUserDefinedAccountMail($user, $rawPassword)) {
            $this->sendLanguageVariableBasedAccountMail($user, $rawPassword, $usedRegistrationCode);
        }
    }

◆ sendLanguageVariableBasedAccountMail()

ilAccountRegistrationMail::sendLanguageVariableBasedAccountMail	(	ilObjUser	$user,
		string	$rawPassword,
		bool	$usedRegistrationCode
	)

private

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

     : void {
        if (!$user->getEmail()) {
            $this->logger->debug(sprintf(
                "Missing email address, did not send account registration mail for user %s (id: %s) ...",
                $user->getLogin(),
                $user->getId()
            ));
            return;
        }
 
        $this->logger->debug(sprintf(
            "Sending language variable dependent welcome email to user %s (id: %s|language: %s) as fallback ...",
            $user->getLogin(),
            $user->getId(),
            $user->getLanguage()
        ));
 
        $this->initMimeMail();
 
        $this->initLanguageByIso2Code($user->getLanguage());
 
        $this->setSubject($this->language->txt('reg_mail_subject'));
 
        $this->setBody($this->language->txt('reg_mail_body_salutation') . ' ' . $user->getFullname() . ',');
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('reg_mail_body_text1'));
        $this->appendBody("\n\n");
        $this->appendBody($this->language->txt('reg_mail_body_text2'));
        $this->appendBody("\n");
        $this->appendBody(ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID);
        $this->appendBody("\n");
        $this->appendBody($this->language->txt('login') . ': ' . $user->getLogin());
        $this->appendBody("\n");
 
        if ($this->settings->passwordGenerationEnabled()) {
            $this->appendBody($this->language->txt('passwd') . ': ' . $rawPassword);
            $this->appendBody("\n");
        }
 
        if ($this->getMode() === self::MODE_DIRECT_REGISTRATION) {
            if ($this->settings->getRegistrationType() === ilRegistrationSettings::IL_REG_APPROVE && !$usedRegistrationCode) {
                $this->appendBody("\n");
                $this->appendBody($this->language->txt('reg_mail_body_pwd_generation'));
                $this->appendBody("\n\n");
            }
        } elseif ($this->getMode() === self::MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION) {
            $this->appendBody("\n");
            $this->appendBody($this->language->txt('reg_mail_body_forgot_password_info'));
            $this->appendBody("\n\n");
        }
 
        $this->appendBody($this->language->txt('reg_mail_body_text3'));
        $this->appendBody("\n");
        $this->appendBody($user->getProfileAsString($this->language));
        $this->appendBody(ilMail::_getInstallationSignature());
 
        $this->sendMimeMail($user->getEmail());
 
        $this->logger->debug("Welcome email sent");
    }

References ilObject\getId(), ilObjUser\getLogin(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ trySendingUserDefinedAccountMail()

ilAccountRegistrationMail::trySendingUserDefinedAccountMail	(	ilObjUser	$user,
		string	$rawPassword
	)

private

Definition at line 71 of file class.ilAccountRegistrationMail.php.

                                                                                           : bool
    {
        $trimStrings = static function ($value) {
            if (is_string($value)) {
                $value = trim($value);
            }
 
            return $value;
        };
 
        $this->logger->debug(sprintf(
            "Trying to send configurable email dependent welcome email to user %s (id: %s|language: %s) ...",
            $user->getLogin(),
            $user->getId(),
            $user->getLanguage()
        ));
 
        $mailData = array_map($trimStrings, ilObjUserFolder::_lookupNewAccountMail($user->getLanguage()));
 
        if ($this->isEmptyMailConfigurationData($mailData)) {
            $this->logger->debug(sprintf(
                "Either subject or email missing, trying to determine email configuration via default language: %s",
                $this->language->getDefaultLanguage()
            ));
 
            $mailData = ilObjUserFolder::_lookupNewAccountMail($this->language->getDefaultLanguage());
            if (!is_array($mailData)) {
                $this->logger->debug(sprintf(
                    "Did not find any email configuration for language '%s' at all, skipping attempt ...",
                    $this->language->getDefaultLanguage()
                ));
                return false;
            }
 
            $mailData = array_map($trimStrings, $mailData);
            if ($this->isEmptyMailConfigurationData($mailData)) {
                $this->logger->debug("Did not find any valid email configuration, skipping attempt ...");
                return false;
            }
        }
 
        $accountMail = new ilAccountMail();
        $accountMail->setUser($user);
 
        if ($this->settings->passwordGenerationEnabled()) {
            $accountMail->setUserPassword($rawPassword);
        }
 
        if (isset($mailData['att_file'])) {
            $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
            $fs->create();
 
            $pathToFile = '/' . implode('/', array_map(static function (string $pathPart): string {
                return trim($pathPart, '/');
            }, [
                $fs->getAbsolutePath(),
                $mailData['lang'],
            ]));
 
            $accountMail->addAttachment($pathToFile, $mailData['att_file']);
 
            $this->logger->debug(sprintf(
                "Attaching '%s' as '%s' ...",
                $pathToFile,
                $mailData['att_file']
            ));
        } else {
            $this->logger->debug("Not attachments configured for this email configuration ...");
        }
 
        $accountMail->send();
 
        $this->logger->debug("Welcome email sent");
 
        return true;
    }

References ilObjUserFolder\_lookupNewAccountMail(), ilObject\getId(), ilObjUser\getLanguage(), ilObjUser\getLogin(), isEmptyMailConfigurationData(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), and USER_FOLDER_ID.

Here is the call graph for this function:

◆ withDirectRegistrationMode()

ilAccountRegistrationMail::withDirectRegistrationMode ( )

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

                                                : ilAccountRegistrationMail
    {
        $clone = clone $this;
        $clone->mode = self::MODE_DIRECT_REGISTRATION;
        return $clone;
    }

References MODE_DIRECT_REGISTRATION.

◆ withEmailConfirmationRegistrationMode()

ilAccountRegistrationMail::withEmailConfirmationRegistrationMode ( )

Definition at line 53 of file class.ilAccountRegistrationMail.php.

                                                           : ilAccountRegistrationMail
    {
        $clone = clone $this;
        $clone->mode = self::MODE_REGISTRATION_WITH_EMAIL_CONFIRMATION;
        return $clone;
    }