Base class for mime mail notifications. More...

Inheritance diagram for ilMimeMailNotification:

Collaboration diagram for ilMimeMailNotification:

Public Member Functions
	__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 (protected bool $is_in_wsp=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 Member Functions
	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")

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

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

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

Detailed Description

Base class for mime mail notifications.

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

Definition at line 26 of file class.ilMimeMailNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilMimeMailNotification::__construct ( bool $a_is_personal_workspace = false )

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         global $DIC;
         $this->senderFactory = $DIC->mail()->mime()->senderFactory();
         parent::__construct($a_is_personal_workspace);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getCurrentRecipient()

ilMimeMailNotification::getCurrentRecipient ( )

Definition at line 103 of file class.ilMimeMailNotification.php.

References $current_recipient.

Referenced by ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), and ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric().

                                          : string
     {
         return $this->current_recipient;
     }

Here is the caller graph for this function:

◆ getMimeMail()

ilMimeMailNotification::getMimeMail ( )

Definition at line 114 of file class.ilMimeMailNotification.php.

References $mime_mail.

                                  : ilMimeMail
     {
         return $this->mime_mail;
     }

◆ initLanguage()

ilMimeMailNotification::initLanguage ( int $a_usr_id )

protected

Definition at line 66 of file class.ilMimeMailNotification.php.

References ilObjectFactory\getInstanceByObjId(), ilMailNotification\getLanguage(), initLanguageByIso2Code(), ilUtil\is_email(), and setCurrentRecipient().

                                                   : void
     {
         parent::initLanguage($a_usr_id);
         $this->getLanguage()->loadLanguageModule('registration');
     }

Here is the call graph for this function:

◆ initLanguageByIso2Code()

ilMimeMailNotification::initLanguageByIso2Code ( string $a_code = '' )

protected

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

References ilMailNotification\getLanguage().

Referenced by initLanguage(), ILIAS\User\Profile\ChangeMailMail\sendEmailToExistingAddress(), ILIAS\User\Profile\ChangeMailMail\sendEmailToNewEmailAddress(), ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric(), and ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail().

                                                                   : void
     {
         parent::initLanguageByIso2Code($a_code);
         $this->getLanguage()->loadLanguageModule('registration');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMimeMail()

ilMimeMailNotification::initMimeMail ( )

protected

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

References $mime_mail.

Referenced by ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ILIAS\User\Profile\ChangeMailMail\sendEmailToExistingAddress(), ILIAS\User\Profile\ChangeMailMail\sendEmailToNewEmailAddress(), ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric(), and ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail().

                                      : ilMimeMail
     {
         $this->mime_mail = new ilMimeMail();
         $this->mime_mail->From($this->senderFactory->system());
 
         return $this->mime_mail;
     }

Here is the caller graph for this function:

◆ sendMimeMail()

ilMimeMailNotification::sendMimeMail ( string $a_rcp )

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

References ilMailNotification\getBody(), and ilMailNotification\getSubject().

Referenced by ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ILIAS\User\Profile\ChangeMailMail\sendEmailToExistingAddress(), ILIAS\User\Profile\ChangeMailMail\sendEmailToNewEmailAddress(), ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric(), and ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail().

                                                : void
     {
         $this->mime_mail->To($a_rcp);
         $this->mime_mail->Subject($this->getSubject(), true);
         $this->mime_mail->Body($this->getBody());
         $this->mime_mail->Send();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentRecipient()

ilMimeMailNotification::setCurrentRecipient ( string $current_recipient )

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

References $current_recipient.

Referenced by initLanguage().

                                                                   : ilMimeMailNotification
     {
         $this->current_recipient = $current_recipient;
         return $this;
     }

Here is the caller graph for this function:

◆ setMimeMail()

ilMimeMailNotification::setMimeMail ( ilMimeMail $mime_mail )

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

References $mime_mail.

                                                       : ilMimeMailNotification
     {
         $this->mime_mail = $mime_mail;
         return $this;
     }

◆ setSubject()

ilMimeMailNotification::setSubject ( string $a_subject )

protected

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

Referenced by ilCronDeleteInactiveUserReminderMailNotification\initLanguage(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailNotification\send(), ILIAS\User\Profile\ChangeMailMail\sendEmailToExistingAddress(), ILIAS\User\Profile\ChangeMailMail\sendEmailToNewEmailAddress(), ILIAS\LegalDocuments\ConsumerToolbox\Mail\sendGeneric(), and ilAccountRegistrationMail\sendLanguageVariableBasedAccountMail().

                                                     : string
     {
         return $this->subject = $a_subject;
     }

Here is the caller graph for this function:

Field Documentation

◆ $current_recipient

string ilMimeMailNotification::$current_recipient

protected

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

Referenced by getCurrentRecipient(), and setCurrentRecipient().

◆ $mime_mail

ilMimeMail ilMimeMailNotification::$mime_mail

protected

Definition at line 28 of file class.ilMimeMailNotification.php.

Referenced by getMimeMail(), initMimeMail(), and setMimeMail().

◆ $senderFactory

ilMailMimeSenderFactory ilMimeMailNotification::$senderFactory

protected

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

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

components/ILIAS/Mail/classes/class.ilMimeMailNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCurrentRecipient()

◆ getMimeMail()

◆ initLanguage()

◆ initLanguageByIso2Code()

◆ initMimeMail()

◆ sendMimeMail()

◆ setCurrentRecipient()

◆ setMimeMail()

◆ setSubject()

Field Documentation

◆ $current_recipient

◆ $mime_mail

◆ $senderFactory