UNPKG

voluptasmollitia

Version:
52 lines (35 loc) 1.33 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@firebase/auth](./auth.md) &gt; [sendEmailVerification](./auth.sendemailverification.md) ## sendEmailVerification() function Sends a verification email to a user. <b>Signature:</b> ```typescript export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | user | [User](./auth.user.md) | The user. | | actionCodeSettings | [ActionCodeSettings](./auth.actioncodesettings.md) \| null | The [ActionCodeSettings](./auth.actioncodesettings.md)<!-- -->. | <b>Returns:</b> Promise&lt;void&gt; ## Remarks The verification process is completed by calling [applyActionCode()](./auth.applyactioncode.md)<!-- -->. ## Example ```javascript const actionCodeSettings = { url: 'https://www.example.com/?email=user@example.com', iOS: { bundleId: 'com.example.ios' }, android: { packageName: 'com.example.android', installApp: true, minimumVersion: '12' }, handleCodeInApp: true }; await sendEmailVerification(user, actionCodeSettings); // Obtain code from the user. await applyActionCode(auth, code); ```