Confirm Your Email Component
PropelAuth's Confirm Your Email component is perfect for showing to users after they signup when email confirmations are enabled. It also allows your users to request and additional confirmation email if the first is not delivered. It is designed to be used when your user has a Login State of EMAIL_NOT_CONFIRMED_YET.
Confirm your email
Not sure how to use this component? Check out the Using the Documentation page.
Reference APIs
These are the APIs that are used by the above component. You can use these APIs directly in your own code.
resendEmailConfirmation
Response Functions
The response object has a handle function that you can use to handle the response. These functions can be async, and you can return values from them.
- Name
success- Description
- Successful request.
- Name
rateLimited- Description
- Too many confirmation emails have been sent to this user in a short period of time.
- Name
emailAlreadyConfirmed- Description
- The user has already confirmed their email address.
- Name
unexpectedOrUnhandled- Description
- An unexpected error occurred.
Request
const { resendEmailConfirmation } = useAuthFrontendApis()
const response = await resendEmailConfirmation()
response.handle({
success() {
console.log('Confirmation email resent')
},
rateLimited(error) {
console.error('Rate limited', error.user_facing_error)
},
emailAlreadyConfirmed(error) {
console.error('Email already confirmed', error.user_facing_error)
},
unexpectedOrUnhandled(error) {
console.error('Unexpected or unhandled', error.user_facing_error)
},
})Successful Response
{}