Base class for mime mail notifications. More...

Inheritance diagram for ilMimeMailNotification:

Collaboration diagram for ilMimeMailNotification:

Public Member Functions
	sendMimeMail ($a_rcp)

	setCurrentRecipient ($current_recipient)

	getCurrentRecipient ()

	setMimeMail ($mime_mail)

	getMimeMail ()

Public Member Functions inherited from ilMailNotification
	__construct ($a_is_personal_workspace=false)
	Constructor. More...

	setType ($a_type)
	Set notification type. More...

	getType ()
	Get notification type. More...

	setSender ($a_usr_id)
	Set sender of mail. More...

	getSender ()
	get sender of mail More...

	setRecipients ($a_rcp)
	set mail recipients More...

	getRecipients ()
	get array of recipients More...

	setAttachments ($a_att)
	Set attachments. More...

	getAttachments ()
	Get attachments. More...

	setLangModules (array $a_modules)
	Set lang modules. More...

	getUserLanguage ($a_usr_id)
	Get user language. More...

	setRefId ($a_id)
	Set ref id. More...

	getRefId ()
	get reference id More...

	getObjId ()
	get object id More...

	setObjId ($a_obj_id)
	set obj id More...

	getObjType ()
	Get object type. More...

	setAdditionalInformation ($a_info)
	Additional information for creating notification mails. More...

	getAdditionalInformation ()
	Get additional information for generating notification mails. More...

	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail. More...

	getBlockBorder ()
	Get (ascii) block border. More...

Protected Member Functions
	initLanguageByIso2Code ($a_code='')

	initLanguage ($a_usr_id)

Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	Set mail subject. More...

	getSubject ()
	Get mail subject. More...

	setBody ($a_body)
	Set mail body. More...

	appendBody ($a_body)
	Append body text. More...

	getBody ()
	Get body. More...

	initLanguage ($a_usr_id)
	Init language. More...

	initLanguageByIso2Code ($a_code='')
	Init language by ISO2 code. More...

	setLanguage ($a_language)
	A language. More...

	getLanguage ()
	get language object More...

	getLanguageText ($a_keyword)
	Replace new lines. More...

	getObjectTitle ($a_shorten=false)
	Get object title. More...

	initMail ()
	Init mail. More...

	getMail ()
	Get mail object. More...

	createPermanentLink ($a_params=array(), $a_append='')
	Create a permanent link for an object. More...

	userToString ($a_usr_id)
	Utility function. More...

	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user. More...

Protected Attributes
	$mime_mail

	$current_recipient

Protected Attributes inherited from ilMailNotification
	$type = null

	$sender = null

	$mail = null

	$subject = ''

	$body = ''

	$attachments = array()

	$language = null

	$lang_modules = array()

	$recipients = array()

	$ref_id = null

	$obj_id = null

	$obj_type = null

	$additional_info = array()

	$is_in_wsp

	$wsp_tree

	$wsp_access_handler

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

Detailed Description

Base class for mime mail notifications.

Version: $Id$

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

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

Member Function Documentation

◆ getCurrentRecipient()

ilMimeMailNotification::getCurrentRecipient ( )

Returns: string

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

References $current_recipient.

Referenced by ilRegistrationMimeMailNotification\__construct(), and ilCronDeleteInactiveUserReminderMailNotification\send().

         {
                 return $this->current_recipient;
         }

Here is the caller graph for this function:

◆ getMimeMail()

ilMimeMailNotification::getMimeMail ( )

Returns: ilMimeMail

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

References $mime_mail.

         {
                 return $this->mime_mail;
         }

◆ initLanguage()

ilMimeMailNotification::initLanguage ( $a_usr_id )

protected

Parameters

int $a_usr_id

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

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

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

Here is the call graph for this function:

◆ initLanguageByIso2Code()

ilMimeMailNotification::initLanguageByIso2Code ( $a_code = '' )

protected

Parameters

string $a_code

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

References ilMailNotification\getLanguage().

Referenced by initLanguage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMimeMail()

ilMimeMailNotification::sendMimeMail ( $a_rcp )

Parameters

string $a_rcp

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

References $ilSetting, $mime_mail, ilMailNotification\getBody(), and ilMailNotification\getSubject().

Referenced by ilRegistrationMimeMailNotification\__construct(), and ilCronDeleteInactiveUserReminderMailNotification\send().

         {
                 $this->mime_mail->To($a_rcp);
                 $this->mime_mail->Subject($this->getSubject());
                 $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 ( $current_recipient )

Parameters

string $current_recipient

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

References $current_recipient.

Referenced by initLanguage().

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

Here is the caller graph for this function:

◆ setMimeMail()

ilMimeMailNotification::setMimeMail ( $mime_mail )

Parameters

ilMimeMail $mime_mail

Returns: ilMimeMailNotification

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

References $mime_mail.

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

Field Documentation

◆ $current_recipient

ilMimeMailNotification::$current_recipient

protected

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

Referenced by getCurrentRecipient(), and setCurrentRecipient().

◆ $mime_mail

ilMimeMailNotification::$mime_mail

protected

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

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

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

Services/Mail/classes/class.ilMimeMailNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCurrentRecipient()

◆ getMimeMail()

◆ initLanguage()

◆ initLanguageByIso2Code()

◆ sendMimeMail()

◆ setCurrentRecipient()

◆ setMimeMail()

Field Documentation

◆ $current_recipient

◆ $mime_mail