ilMailAddressTypeHelperImpl Class Reference

Class ilMailAddressTypeHelper. More...

Inheritance diagram for ilMailAddressTypeHelperImpl:

Collaboration diagram for ilMailAddressTypeHelperImpl:

Public Member Functions
	__construct (string $installationHost)
	ilMailAddressTypeHelperImpl constructor. More...
	doesGroupNameExists (string $name)
	Parameters string $name Returns bool More...
	getGroupObjIdByTitle (string $title)
	Parameters string $title Returns int More...
	getInstanceByRefId (int $refId)
	Parameters int $refId Returns More...
	getAllRefIdsForObjId (int $objId)
	Parameters int $objId Returns int[] More...
	getUserIdByLogin (string $login)
	Parameters string $login Returns int More...
	getInstallationHost ()
	Returns string More...
	getGlobalMailSystemId ()
	Returns int More...
	receivesInternalMailsOnly (int $usrId)

Protected Attributes
	$installationHost = ''

Detailed Description

Class ilMailAddressTypeHelper.

Author

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

Definition at line 8 of file class.ilMailAddressTypeHelper.php.

Constructor & Destructor Documentation

__construct()

ilMailAddressTypeHelperImpl::__construct

(

string

$installationHost

)

ilMailAddressTypeHelperImpl constructor.

Parameters

string

$installationHost

Definition at line 17 of file class.ilMailAddressTypeHelper.php.

References $installationHost.

    {
        $this->installationHost = $installationHost;
    }

Member Function Documentation

doesGroupNameExists()

ilMailAddressTypeHelperImpl::doesGroupNameExists

(

string

$name

)

Parameters

string

$name

Returns

bool

Implements ilMailAddressTypeHelper.

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

                                                      : bool
    {
        return \ilUtil::groupNameExists($name);
    }

getAllRefIdsForObjId()

ilMailAddressTypeHelperImpl::getAllRefIdsForObjId

(

int

$objId

)

Parameters

int

$objId

Returns

int[]

Implements ilMailAddressTypeHelper.

Definition at line 49 of file class.ilMailAddressTypeHelper.php.

                                                     : array
    {
        return \ilObject::_getAllReferences($objId);
    }

getGlobalMailSystemId()

ilMailAddressTypeHelperImpl::getGlobalMailSystemId

(

)

Returns

int

Implements ilMailAddressTypeHelper.

Definition at line 73 of file class.ilMailAddressTypeHelper.php.

References ilMailGlobalServices\getMailObjectRefId().

                                            : int
    {
        return (int) \ilMailGlobalServices::getMailObjectRefId();
    }

Here is the call graph for this function:

getGroupObjIdByTitle()

ilMailAddressTypeHelperImpl::getGroupObjIdByTitle

(

string

$title

)

Parameters

string

$title

Returns

int

Implements ilMailAddressTypeHelper.

Definition at line 33 of file class.ilMailAddressTypeHelper.php.

References ilObjGroup\_lookupIdByTitle().

                                                        : int
    {
        return (int) \ilObjGroup::_lookupIdByTitle($title);
    }

Here is the call graph for this function:

getInstallationHost()

ilMailAddressTypeHelperImpl::getInstallationHost

(

)

Returns

string

Implements ilMailAddressTypeHelper.

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

References $installationHost.

                                          : string
    {
        return $this->installationHost;
    }

getInstanceByRefId()

ilMailAddressTypeHelperImpl::getInstanceByRefId

(

int

$refId

)

Parameters

int

$refId

Returns

Implements ilMailAddressTypeHelper.

Definition at line 41 of file class.ilMailAddressTypeHelper.php.

                                                   : \ilObject
    {
        return \ilObjectFactory::getInstanceByRefId($refId);
    }

getUserIdByLogin()

ilMailAddressTypeHelperImpl::getUserIdByLogin

(

string

$login

)

Parameters

string

$login

Returns

int

Implements ilMailAddressTypeHelper.

Definition at line 57 of file class.ilMailAddressTypeHelper.php.

References ilObjUser\getUserIdByLogin().

                                                    : int
    {
        return (int) \ilObjUser::getUserIdByLogin($login);
    }

Here is the call graph for this function:

receivesInternalMailsOnly()

ilMailAddressTypeHelperImpl::receivesInternalMailsOnly

(

int

$usrId

)

Parameters

int

$usrId

Returns

bool

Implements ilMailAddressTypeHelper.

Definition at line 82 of file class.ilMailAddressTypeHelper.php.

References PHPMailer\PHPMailer\$options, and ilMailOptions\INCOMING_LOCAL.

                                                          : bool
    {
        $options = new \ilMailOptions($usrId);

        return (int) $options->getIncomingType() === (int) \ilMailOptions::INCOMING_LOCAL;
    }

Field Documentation

$installationHost

ilMailAddressTypeHelperImpl::$installationHost = ''

protected

Definition at line 11 of file class.ilMailAddressTypeHelper.php.

Referenced by __construct(), and getInstallationHost().

---

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

• Services/Mail/classes/Address/Type/class.ilMailAddressTypeHelper.php