ilMailAddressType Interface Reference
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 $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... | |
Detailed Description
Definition at line 21 of file interface.ilMailAddressType.php.
Member Function Documentation
◆ getAddress()
| ilMailAddressType::getAddress | ( | ) |
The address instance used for validation and user id lookup.
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.
- Returns
- list<ilMailError>
- See also
- ilMailAddressType::validate
Implemented in ilBaseMailAddressType, and ilMailCachedAddressType.
◆ resolve()
| ilMailAddressType::resolve | ( | ) |
Returns an array of resolved user ids based on an address instance.
- Returns
- list<int>
Implemented in ilMailCachedAddressType, ilMailGroupAddressType, ilMailLoginOrEmailAddressAddressType, ilMailMailingListAddressType, and ilMailRoleAddressType.
◆ validate()
| ilMailAddressType::validate | ( | int | $sender_id | ) |
Validates the parsed recipients and set errors accordingly.
- Parameters
-
int $sender_id The id of the acting ILIAS user, can be used for permission checks etc.
- See also
- ilMailAddressType::getErrors
Implemented in ilBaseMailAddressType, and ilMailCachedAddressType.
The documentation for this interface was generated from the following file:
- components/ILIAS/Mail/interfaces/interface.ilMailAddressType.php
