ilMailLoginOrEmailAddressAddressType Class Reference

Inheritance diagram for ilMailLoginOrEmailAddressAddressType:

Collaboration diagram for ilMailLoginOrEmailAddressAddressType:

Public Member Functions
	__construct (ilMailAddressTypeHelper $type_helper, ilMailAddress $address, ilLogger $logger, protected ilRbacSystem $rbacsystem)
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
Public Member Functions inherited from ilBaseMailAddressType
	__construct (protected ilMailAddressTypeHelper $type_helper, protected ilMailAddress $address, protected ilLogger $logger)
	validate (int $sender_id)
	Validates the parsed recipients and set errors accordingly. More...
	getErrors ()
	Returns a list of errors determined in the validation process. More...
	getAddress ()
	The address instance used for validation and user id lookup. More...
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
	validate (int $sender_id)
	Validates the parsed recipients and set errors accordingly. More...
	getErrors ()
	Returns a list of errors determined in the validation process. More...
	getAddress ()
	The address instance used for validation and user id lookup. More...

Protected Member Functions
	isValid (int $sender_id)
Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $sender_id)
	pushError (string $language_variable, array $place_holder_values=[])

Detailed Description

Definition at line 21 of file class.ilMailLoginOrEmailAddressAddressType.php.

Constructor & Destructor Documentation

__construct()

ilMailLoginOrEmailAddressAddressType::__construct	(	ilMailAddressTypeHelper	$type_helper,
		ilMailAddress	$address,
		ilLogger	$logger,
		protected ilRbacSystem	$rbacsystem
	)

Definition at line 23 of file class.ilMailLoginOrEmailAddressAddressType.php.

      {
        parent::__construct($type_helper, $address, $logger);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

isValid()

ilMailLoginOrEmailAddressAddressType::isValid ( int  $sender_id )

protected

Reimplemented from ilBaseMailAddressType.

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

                                              : bool
    {
        if ($this->address->getHost() === $this->type_helper->getInstallationHost()) {
            $usr_id = $this->type_helper->getUserIdByLogin($this->address->getMailbox());
        } else {
            $usr_id = false;
        }
 
        if (!$usr_id && $this->address->getHost() === $this->type_helper->getInstallationHost()) {
            $this->pushError('mail_recipient_not_found', [$this->address->getMailbox()]);
            return false;
        }
 
        if (
            $usr_id &&
            $this->type_helper->receivesInternalMailsOnly($usr_id) &&
            !$this->rbacsystem->checkAccessOfUser(
                $usr_id,
                'internal_mail',
                $this->type_helper->getGlobalMailSystemId()
            )
        ) {
            $this->logger->debug(sprintf(
                "Address '%s' not valid. Found id %s, " .
                "but user can't use mail system and wants to receive emails only internally.",
                $this->address->getMailbox(),
                $usr_id
            ));
            $this->pushError('user_cant_receive_mail', [$this->address->getMailbox()]);
            return false;
        }
 
        return true;
    }

References ILIAS\Repository\logger(), and ilBaseMailAddressType\pushError().

Here is the call graph for this function:

resolve()

ilMailLoginOrEmailAddressAddressType::resolve

(

)

Returns an array of resolved user ids based on an address instance.

Returns

list<int>

Implements ilMailAddressType.

Definition at line 67 of file class.ilMailLoginOrEmailAddressAddressType.php.

                             : array
    {
        if ($this->address->getHost() === $this->type_helper->getInstallationHost()) {
            $address = $this->address->getMailbox();
        } else {
            $address = (string) $this->address;
        }
 
        $usr_ids = array_filter([
            $this->type_helper->getUserIdByLogin($address),
        ]);
 
        if ($usr_ids !== []) {
            $this->logger->debug(sprintf(
                "Found the following user ids for address (login) '%s': %s",
                $address,
                implode(', ', array_unique($usr_ids))
            ));
        } elseif ($address !== '') {
            $this->logger->debug(sprintf(
                "Did not find any user account for address (login) '%s'",
                $address
            ));
        }
 
        return $usr_ids;
    }

References ILIAS\Repository\logger().

Here is the call graph for this function:

---

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

• components/ILIAS/Mail/classes/Address/Type/class.ilMailLoginOrEmailAddressAddressType.php