# auth.email

# AuthEmailModule ⇐ Module

Functions relating to Moodle's email-based self-registration.

This module's function calls may throw errors if self registration is disabled.

Kind: global class
Extends: Module
Since: 0.1.0

# authEmailModule.getSignUpSettings() ⇒ Promise.<SignUpSettingsResponse>

Get the sign-up required settings and profile fields.

Kind: instance method of AuthEmailModule
Returns: Promise.<SignUpSettingsResponse> - The response returned by Moodle.
Since: 0.1.0

# authEmailModule.signUpUser(user) ⇒ Promise.<SignUpUserResponse>

Adds a new user to the site (pending user confirmation).

Kind: instance method of AuthEmailModule
Returns: Promise.<SignUpUserResponse> - The response returned by Moodle.
Since: 0.1.0

Param Type Description
user SignUpUser The user to sign up.