Availability
This routine is available starting with katl-commons 1.0.
Syntax
userEmailAddress(user)
Description
Returns the email address of the selected user. The email address may be needed to supply it to various external systems.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
user | String | Yes | The user key or name of the user for which the email should be provided. |
Return type
string
Returns the e-mail address associated with the specified userkey/username.
Example
Example 1
userEmailAddress("Admin");
Returns: If exists, returns the email address of the user Admin.
Example 2
userEmailAddress(currentUser());
Returns: If exists, returns the email address of the current user.
Notes
The look-up is first made after the userkey, then after the username.
If the email of the selected user doesn't exist the function returns an empty string.
See also