ilMailMimeSenderUser Class Reference

Class ilMailMimeSenderSystem. More...

Inheritance diagram for ilMailMimeSenderUser:

Collaboration diagram for ilMailMimeSenderUser:

Public Member Functions
	__construct (\ilSetting $settings, \ilObjUser $user)
	ilMailMimeSenderSystem constructor. More...
	hasReplyToAddress ()
	Returns bool More...
	getReplyToAddress ()
	Returns string More...
	getReplyToName ()
	Returns string More...
	hasEnvelopFromAddress ()
	Returns bool More...
	getEnvelopFromAddress ()
	Returns string More...
	getFromAddress ()
	Returns string More...
	getFromName ()
	Returns string More...

Static Public Member Functions
static	byUsrId (\ilSetting $settings, $usrId)
static	addUserToCache ($usrId, \ilObjUser $user)
static	byEmailAddress (\ilSetting $settings, $emailAddress)

Protected Attributes
	$settings
	$user

Static Protected Attributes
static	$userInstances = array()

Detailed Description

Class ilMailMimeSenderSystem.

Definition at line 9 of file class.ilMailMimeSenderUser.php.

Constructor & Destructor Documentation

__construct()

ilMailMimeSenderUser::__construct	(	\ilSetting	$settings,
		\ilObjUser	$user
	)

ilMailMimeSenderSystem constructor.

Parameters

\ilSetting	$settings

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

References $settings, $user, settings(), and user().

    {
        $this->settings = $settings;
        $this->user     = $user;
    }

Here is the call graph for this function:

Member Function Documentation

addUserToCache()

static ilMailMimeSenderUser::addUserToCache (   $usrId, \ilObjUser  $user  )

static

Parameters

int	$usrId
\ilObjUser	$user

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

References $user.

Referenced by ilMailMimeTest\setUp().

    {
        self::$userInstances[$usrId] = $user;
    }

Here is the caller graph for this function:

byEmailAddress()

static ilMailMimeSenderUser::byEmailAddress ( \ilSetting  $settings,   $emailAddress  )

static

Parameters

\ilSetting	$settings
string	$emailAddress

Returns

self

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

References $settings, and $user.

Referenced by ilMailMimeSenderFactory\userByEmailAddress().

    {
        $user = new \ilObjUser();
        $user->setEmail($emailAddress);

        return new self($settings, $user);
    }

Here is the caller graph for this function:

byUsrId()

static ilMailMimeSenderUser::byUsrId ( \ilSetting  $settings,   $usrId  )

static

Parameters

\ilSetting	$settings
int	$usrId

Returns

self

Definition at line 42 of file class.ilMailMimeSenderUser.php.

References $settings.

Referenced by ilMailMimeSenderFactory\user().

    {
        if (!array_key_exists($usrId, self::$userInstances)) {
            self::$userInstances[$usrId] = new \ilObjUser($usrId);
        }

        return new self($settings, self::$userInstances[$usrId]);
    }

Here is the caller graph for this function:

getEnvelopFromAddress()

ilMailMimeSenderUser::getEnvelopFromAddress

(

)

Returns

string

Implements ilMailMimeSender.

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

References settings().

    {
        return $this->settings->get('mail_system_usr_env_from_addr');
    }

Here is the call graph for this function:

getFromAddress()

ilMailMimeSenderUser::getFromAddress

(

)

Returns

string

Implements ilMailMimeSender.

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

References settings().

    {
        return $this->settings->get('mail_system_usr_from_addr');
    }

Here is the call graph for this function:

getFromName()

ilMailMimeSenderUser::getFromName

(

)

Returns

string

Implements ilMailMimeSender.

Definition at line 124 of file class.ilMailMimeSenderUser.php.

References $from, $name, settings(), and user().

    {
        $from = $this->settings->get('mail_system_usr_from_name');
        if (0 == strlen($from)) {
            return $this->user->getFullname();
        }

        $name = str_ireplace('[FULLNAME]', $this->user->getFullname(), $from);
        $name = str_ireplace('[FIRSTNAME]', $this->user->getFirstname(), $name);
        $name = str_ireplace('[LASTNAME]', $this->user->getLastname(), $name);
        if ($name != $from) {
            return $name;
        }

        return $from;
    }

Here is the call graph for this function:

getReplyToAddress()

ilMailMimeSenderUser::getReplyToAddress

(

)

Returns

string

Implements ilMailMimeSender.

Definition at line 84 of file class.ilMailMimeSenderUser.php.

References user().

    {
        return $this->user->getEmail();
    }

Here is the call graph for this function:

getReplyToName()

ilMailMimeSenderUser::getReplyToName

(

)

Returns

string

Implements ilMailMimeSender.

Definition at line 92 of file class.ilMailMimeSenderUser.php.

References user().

    {
        return $this->user->getFullname();
    }

Here is the call graph for this function:

hasEnvelopFromAddress()

ilMailMimeSenderUser::hasEnvelopFromAddress

(

)

Returns

bool

Implements ilMailMimeSender.

Definition at line 100 of file class.ilMailMimeSenderUser.php.

References settings().

    {
        return strlen($this->settings->get('mail_system_usr_env_from_addr')) > 0;
    }

Here is the call graph for this function:

hasReplyToAddress()

ilMailMimeSenderUser::hasReplyToAddress

(

)

Returns

bool

Implements ilMailMimeSender.

Definition at line 76 of file class.ilMailMimeSenderUser.php.

    {
        return true;
    }

Field Documentation

$settings

ilMailMimeSenderUser::$settings

protected

Definition at line 19 of file class.ilMailMimeSenderUser.php.

Referenced by __construct(), byEmailAddress(), and byUsrId().

$user

ilMailMimeSenderUser::$user

protected

Definition at line 24 of file class.ilMailMimeSenderUser.php.

Referenced by __construct(), addUserToCache(), and byEmailAddress().

$userInstances

ilMailMimeSenderUser::$userInstances = array()

staticprotected

Definition at line 14 of file class.ilMailMimeSenderUser.php.

---

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

• Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderUser.php