incendium.user.get_user_email_address

Description

Get the User's Email address(es).

Syntax

incendium.user.get_user_email_address([user_source], [failover])

Args:

• user_source (str): The name of the User Source. If not provided, the default User Source will be consulted. Optional.
• failover (str): The name of the Fallback profile. Optional.

Returns:

• list[str]: The User's Email address(es).

Recommendations

None.

Code Examples

from incendium import user as _user


def get_user_emails():
    """Get a list of email addresses for the current user.

    Returns:
        list[str]: A List of strings that holds all the email
            addresses for the current user.
    """
    return _user.get_user_email_address()