Class ilMailLoginOrEmailAddressAddressType. More...

Inheritance diagram for ilMailLoginOrEmailAddressAddressType:

Collaboration diagram for ilMailLoginOrEmailAddressAddressType:

Public Member Functions
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilLogger $logger, ilRbacSystem $rbacsystem)

	resolve ()
	Returns an array of resolved user ids based on an address instance. More...

Public Member Functions inherited from ilBaseMailAddressType
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilLogger $logger)

	validate (int $senderId)
	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 $senderId)
	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 $senderId)

Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $senderId)

	pushError (string $languageVariable, array $placeHolderValues=[])

Protected Attributes
ilRbacSystem	$rbacsystem

Protected Attributes inherited from ilBaseMailAddressType
ilMailAddressTypeHelper	$typeHelper

ilMailAddress	$address

ilLogger	$logger

Detailed Description

Class ilMailLoginOrEmailAddressAddressType.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        parent::__construct($typeHelper, $address, $logger);
        $this->rbacsystem = $rbacsystem;
    }

References ilBaseMailAddressType\$address, ilBaseMailAddressType\$logger, $rbacsystem, ilBaseMailAddressType\$typeHelper, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ isValid()

ilMailLoginOrEmailAddressAddressType::isValid ( int $senderId )

protected

Reimplemented from ilBaseMailAddressType.

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

                                             : bool
    {
        if ($this->address->getHost() === $this->typeHelper->getInstallationHost()) {
            $usrId = $this->typeHelper->getUserIdByLogin($this->address->getMailbox());
        } else {
            $usrId = false;
        }
 
        if (!$usrId && $this->address->getHost() === $this->typeHelper->getInstallationHost()) {
            $this->pushError('mail_recipient_not_found', [$this->address->getMailbox()]);
            return false;
        }
 
        if (
            $usrId &&
            $this->typeHelper->receivesInternalMailsOnly($usrId) &&
            !$this->rbacsystem->checkAccessOfUser(
                $usrId,
                'internal_mail',
                $this->typeHelper->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(),
                $usrId
            ));
            $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: int[]

Implements ilMailAddressType.

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

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