Struct VerifyEmail

pub struct VerifyEmail;

Verify a user’s email.

Register Flow

1. POST /v1/user
   • This will send the email for verification
2. POST this route with the Verify request.
   • recieve one of:
     1. a 200 (NewSessionResponse)
     2. a 401 response (<token> is invalid)

Change email Flow (NOT CURRENTLY IMPLEMENTED)

1. PUT /v1/user/me/email
   • this will send an email to verify the old address
2. POST this route with the token from the email
   • this will send an email to verify the new address
3. POST this route again with the token from the new address
   • The new email will get set at this point, recieve one of:
     1. a 204 (success!)
     2. a 401 response (token is invalid)

Resend verification email

1. POST this route with no auth and Resend
   • this resend will the verification email
   • this will always return a 204 on success.
2. Continue the flow you were in.

If no verification is in progress, no email will be sent.

Trait Implementations

impl ApiEndpoint for VerifyEmail

const METHOD: Method = Method::Post

The method used to make a request to the endpoint.

type Req = VerifyEmailRequest

The request type for this endpoint.

type Res = Option<NewSessionResponse>

The response type for this endpoint.

type Path = VerifyEmailPath

The path type for this endpoint.

type Err = EmptyError

The (inner) error type for this endpoint.