ILIAS\Mail\Recipient Class Reference

Collaboration diagram for ILIAS\Mail\Recipient:

Public Member Functions
	__construct (private int $user_id, private ?ilObjUser $user, private ilMailOptions $mail_options, private Conductor $legal_documents)
	getUserId ()
	getMailOptions ()
	isUser ()
	isUserActive ()
	isUserExpired ()
	evaluateInternalMailReadability ()
	userWantsToReceiveExternalMails ()
	onlyToExternalMailAddress ()
	getExternalMailAddress ()

Detailed Description

Definition at line 30 of file Recipient.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Recipient::__construct	(	private int	$user_id,
		private ?ilObjUser	$user,
		private ilMailOptions	$mail_options,
		private Conductor	$legal_documents
	)

Definition at line 32 of file Recipient.php.

      {
    }

Member Function Documentation

evaluateInternalMailReadability()

ILIAS\Mail\Recipient::evaluateInternalMailReadability

(

)

Definition at line 65 of file Recipient.php.

References ILIAS\Mail\Recipient\isUserExpired(), and ILIAS\Repository\user().

                                                     : Result
    {
        if ($this->isUserExpired()) {
            return new Error('Account expired.');
        }

        return $this->legal_documents->userCanReadInternalMail()->applyTo(new Ok($this->user));
    }

Here is the call graph for this function:

getExternalMailAddress()

ILIAS\Mail\Recipient::getExternalMailAddress

(

)

Returns

string[]

Definition at line 88 of file Recipient.php.

                                            : array
    {
        return $this->mail_options->getExternalEmailAddresses();
    }

getMailOptions()

ILIAS\Mail\Recipient::getMailOptions

(

)

Definition at line 45 of file Recipient.php.

                                    : ilMailOptions
    {
        return $this->mail_options;
    }

getUserId()

ILIAS\Mail\Recipient::getUserId

(

)

Definition at line 40 of file Recipient.php.

References $user_id.

                               : int
    {
        return $this->user_id;
    }

isUser()

ILIAS\Mail\Recipient::isUser

(

)

Definition at line 50 of file Recipient.php.

References ILIAS\Repository\user().

                            : bool
    {
        return !is_null($this->user);
    }

Here is the call graph for this function:

isUserActive()

ILIAS\Mail\Recipient::isUserActive

(

)

Definition at line 55 of file Recipient.php.

References ILIAS\Repository\user().

                                  : bool
    {
        return $this->user->getActive();
    }

Here is the call graph for this function:

isUserExpired()

ILIAS\Mail\Recipient::isUserExpired

(

)

Definition at line 60 of file Recipient.php.

References ILIAS\Repository\user().

Referenced by ILIAS\Mail\Recipient\evaluateInternalMailReadability().

                                   : bool
    {
        return !$this->user->checkTimeLimit();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

onlyToExternalMailAddress()

ILIAS\Mail\Recipient::onlyToExternalMailAddress

(

)

Definition at line 80 of file Recipient.php.

References ilMailOptions\INCOMING_EMAIL.

                                               : bool
    {
        return $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_EMAIL;
    }

userWantsToReceiveExternalMails()

ILIAS\Mail\Recipient::userWantsToReceiveExternalMails

(

)

Definition at line 74 of file Recipient.php.

References ilMailOptions\INCOMING_BOTH, and ilMailOptions\INCOMING_EMAIL.

                                                     : bool
    {
        return $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_EMAIL ||
            $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_BOTH;
    }

---

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

• components/ILIAS/Mail/classes/Recipient.php