ilMailAddressType Interface Reference

Interface ilMailAddressType. More...

Inheritance diagram for ilMailAddressType:

Collaboration diagram for ilMailAddressType:

Public Member Functions
	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...

Detailed Description

Interface ilMailAddressType.

Author

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

Definition at line 8 of file interface.ilMailAddressType.php.

Member Function Documentation

getAddress()

ilMailAddressType::getAddress

(

)

The address instance used for validation and user id lookup.

Returns

Implemented in ilBaseMailAddressType, and ilMailCachedAddressType.

getErrors()

ilMailAddressType::getErrors

(

)

Returns a list of errors determined in the validation process.

The errors should be reset everytime the validation is triggered.

See also

::validate

Returns

Implemented in ilBaseMailAddressType, and ilMailCachedAddressType.

resolve()

ilMailAddressType::resolve

(

)

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

Returns

int[]

Implemented in ilMailRoleAddressType, ilMailCachedAddressType, ilMailLoginOrEmailAddressAddressType, ilMailMailingListAddressType, and ilMailGroupAddressType.

validate()

ilMailAddressType::validate

(

int

$senderId

)

Validates the parsed recipients and set errors accordingly.

See also

::getErrors

Parameters

$senderId

integer The id of the acting ILIAS user, can be used for permission checks etc.

Returns

bool

Implemented in ilBaseMailAddressType, and ilMailCachedAddressType.

---

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

• Services/Mail/interfaces/interface.ilMailAddressType.php