Email account management functions.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- admin → EmailAccountsAdmin
-
Collection of admin-related functions.
final
- config ↔ EmailAccountConfig
-
The currently active email accounts configuration.
getter/setter pair
Static Methods
-
authenticate(
Session session, {required String email, required String password, Transaction? transaction}) → Future< UuidValue> - Returns the AuthUser's ID upon successful email/password verification.
-
completeAccountCreation(
Session session, {required UuidValue accountRequestId, required UuidValue authUserId, Transaction? transaction}) → Future< ({String email, UuidValue emailAccountId})> - Finalize the email authentication creation.
-
completePasswordReset(
Session session, {required UuidValue passwordResetRequestId, required String verificationCode, required String newPassword, Transaction? transaction}) → Future< UuidValue> - Returns the auth user ID for the successfully changed password
-
startAccountCreation(
Session session, {required String email, required String password, Transaction? transaction}) → Future< ({UuidValue? accountRequestId, EmailAccountRequestResult result})> - Returns the result of the operation and a process ID for the account request.
-
startPasswordReset(
Session session, {required String email, Transaction? transaction}) → Future< PasswordResetResult> - Sends out a password reset email for the given account, if it exists.
-
verifyAccountCreation(
Session session, {required UuidValue accountRequestId, required String verificationCode, Transaction? transaction}) → Future< ({String email, UuidValue emailAccountRequestId})> - Checks whether the verification code matches the pending account creation request.