ilMimeMailNotification Class Reference

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.
	setType ($a_type)
	Set notification type.
	getType ()
	Get notification type.
	setSender ($a_usr_id)
	Set sender of mail.
	getSender ()
	get sender of mail
	setRecipients ($a_rcp)
	set mail recipients
	getRecipients ()
	get array of recipients
	setAttachments ($a_att)
	Set attachments.
	getAttachments ()
	Get attachments.
	setLangModules (array $a_modules)
	Set lang modules.
	getUserLanguage ($a_usr_id)
	Get user language.
	setRefId ($a_id)
	Set ref id.
	getRefId ()
	get reference id
	getObjId ()
	get object id
	setObjId ($a_obj_id)
	set obj id
	getObjType ()
	Get object type.
	setAdditionalInformation ($a_info)
	Additional information for creating notification mails.
	getAdditionalInformation ()
	Get additional information for generating notification mails.
	sendMail ($a_rcp, $a_type, $a_parse_recipients=true)
	Send Mail.
	getBlockBorder ()
	Get (ascii) block border.

Protected Member Functions
	initLanguageByIso2Code ($a_code= '')
	initLanguage ($a_usr_id)
Protected Member Functions inherited from ilMailNotification
	setSubject ($a_subject)
	Set mail subject.
	getSubject ()
	Get mail subject.
	setBody ($a_body)
	Set mail body.
	appendBody ($a_body)
	Append body text.
	getBody ()
	Get body.
	setLanguage ($a_language)
	A language.
	getLanguage ()
	get language object
	getLanguageText ($a_keyword)
	Replace new lines.
	getObjectTitle ($a_shorten=false)
	Get object title.
	initMail ()
	Init mail.
	getMail ()
	Get mail object.
	createPermanentLink ($a_params=array(), $a_append= '')
	Create a permanent link for an object.
	userToString ($a_usr_id)
	Utility function.
	isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
	Check if ref id is accessible for user.

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

ilMimeMailNotification::getCurrentRecipient

(

)

Returns

string

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

References $current_recipient.

        {
                return $this->current_recipient;
        }

ilMimeMailNotification::getMimeMail

(

)

Returns

ilMimeMail

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

References $mime_mail.

        {
                return $this->mime_mail;
        }

ilMimeMailNotification::initLanguage (   $a_usr_id )

protected

Parameters

int

$a_usr_id

Reimplemented from ilMailNotification.

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

References ilMailNotification\getLanguage().

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

Here is the call graph for this function:

ilMimeMailNotification::initLanguageByIso2Code (   $a_code = '' )

protected

Parameters

string

$a_code

Reimplemented from ilMailNotification.

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

References ilMailNotification\getLanguage().

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

Here is the call graph for this function:

ilMimeMailNotification::sendMimeMail

(

$a_rcp

)

Parameters

string

$a_rcp

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

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

        {
                $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:

ilMimeMailNotification::setCurrentRecipient

(

$current_recipient

)

Parameters

string

$current_recipient

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

References $current_recipient.

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

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

ilMimeMailNotification::$current_recipient

protected

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

Referenced by getCurrentRecipient(), and setCurrentRecipient().

ilMimeMailNotification::$mime_mail

protected

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

Referenced by getMimeMail(), and setMimeMail().

---

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

• Services/Mail/classes/class.ilMimeMailNotification.php