Documentation
¶
Index ¶
- Variables
- func IsEmailAddress(emailAddress string) bool
- func IsVerificationCode(code string) bool
- type Server
- func (s *Server) CheckVerificationCode(ctx context.Context, req *emailpb.CheckVerificationCodeRequest) (*emailpb.CheckVerificationCodeResponse, error)
- func (s *Server) LinkUnverified(ctx context.Context, req *emailpb.LinkUnverifiedRequest) (*emailpb.LinkUnverifiedResponse, error)
- func (s *Server) SendVerificationCode(ctx context.Context, req *emailpb.SendVerificationCodeRequest) (*emailpb.SendVerificationCodeResponse, error)
- func (s *Server) Unlink(ctx context.Context, req *emailpb.UnlinkRequest) (*emailpb.UnlinkResponse, error)
- type Verifier
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrInvalidEmail is returned if the email address is invalid ErrInvalidEmail = errors.New("phone number is invalid") // ErrRateLimited indicates that the call was rate limited ErrRateLimited = errors.New("rate limited") // ErrInvalidVerificationCode is returned when the verification does not // match what's expected in a Confirm call ErrInvalidVerificationCode = errors.New("verification code does not match") // ErrNoVerification indicates that no verification is in progress for // the provided phone number in a Confirm call. Several reasons this // can occur include a verification being expired or having reached a // maximum check threshold. ErrNoVerification = errors.New("verification not in progress") )
Functions ¶
func IsEmailAddress ¶
IsEmailAddress returns whether a string is an email address
func IsVerificationCode ¶
IsVerificationCode returns whether a string is a 4-10 digit numberical verification code.
Types ¶
type Server ¶
type Server struct {
emailpb.UnimplementedEmailVerificationServer
// contains filtered or unexported fields
}
func (*Server) CheckVerificationCode ¶
func (s *Server) CheckVerificationCode(ctx context.Context, req *emailpb.CheckVerificationCodeRequest) (*emailpb.CheckVerificationCodeResponse, error)
func (*Server) LinkUnverified ¶ added in v1.39.0
func (s *Server) LinkUnverified(ctx context.Context, req *emailpb.LinkUnverifiedRequest) (*emailpb.LinkUnverifiedResponse, error)
LinkUnverified links an email address to the user without verifying it, and sends no email. It is open to any registered user. The address is linked as unverified unless it is the one already linked and verified, which stays verified (see profile.Store.LinkEmailAddress).
func (*Server) SendVerificationCode ¶
func (s *Server) SendVerificationCode(ctx context.Context, req *emailpb.SendVerificationCodeRequest) (*emailpb.SendVerificationCodeResponse, error)
func (*Server) Unlink ¶
func (s *Server) Unlink(ctx context.Context, req *emailpb.UnlinkRequest) (*emailpb.UnlinkResponse, error)
type Verifier ¶
type Verifier interface {
// SendCode sends a verification code via email to the provided email address.
// If an active verification is already taking place, the existing code will
// be resent. A unique ID for the verification is returned on success.
SendCode(ctx context.Context, emailAddress, clientData string) (string, error)
// Check verifies a email code sent to an email address.
Check(ctx context.Context, emailAddress, code string) error
// Cancel cancels an active verification. No error is returned if the
// verification doesn't exist, previously canceled or successfully
// completed.
Cancel(ctx context.Context, id string) error
// IsVerificationActive checks whether a verification is active or not
IsVerificationActive(ctx context.Context, id string) (bool, error)
// IsValidEmailAddress validates an email address is real and is able to
// receive a verification code.
IsValidEmailAddress(ctx context.Context, emailAddress string) (bool, error)
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.