ilGroupNameAsMailValidator Class Reference

Collaboration diagram for ilGroupNameAsMailValidator:

Public Member Functions
	__construct (protected string $host, ?callable $group_name_check_callable=null)
	validate (ilMailAddress $address)
	Validates if the given address contains a valid group name to send an email. More...

Protected Attributes
	$group_name_check_callable

Private Member Functions
	isHostValid (string $host)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilGroupNameAsMailValidator::__construct	(	protected string	$host,
		?callable	$group_name_check_callable = null
	)

Parameters

callable(string)

bool|null $group_name_check_callable

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

References $group_name_check_callable, and ilUtil\groupNameExists().

    {
        $this->group_name_check_callable = $group_name_check_callable ?? static fn(string $group_name): bool => ilUtil::groupNameExists($group_name);
    }

Here is the call graph for this function:

Member Function Documentation

isHostValid()

ilGroupNameAsMailValidator::isHostValid ( string  $host )

private

Definition at line 45 of file class.ilGroupNameAsMailValidator.php.

Referenced by validate().

                                              : bool
    {
        return ($host === $this->host || $host === '');
    }

Here is the caller graph for this function:

validate()

ilGroupNameAsMailValidator::validate

(

ilMailAddress

$address

)

Validates if the given address contains a valid group name to send an email.

Definition at line 37 of file class.ilGroupNameAsMailValidator.php.

References $group_name_check_callable, ilMailAddress\getHost(), ilMailAddress\getMailbox(), and isHostValid().

                                                    : bool
    {
        $group_name = substr($address->getMailbox(), 1);

        $func = $this->group_name_check_callable;
        return $func($group_name) && $this->isHostValid($address->getHost());
    }

Here is the call graph for this function:

Field Documentation

$group_name_check_callable

ilGroupNameAsMailValidator::$group_name_check_callable

protected

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

Referenced by __construct(), and validate().

---

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

• components/ILIAS/Mail/classes/Address/Validator/class.ilGroupNameAsMailValidator.php