package
0.0.0-20240810175236-332ce6e1e724
Repository: https://github.com/simpleauthlink/authapi.git
Documentation: pkg.go.dev

# Functions

CheckEmail checks if the email address is valid.
LoadRemoteDisposableDomains loads a list of disposable domains from a remote source url.
NewAppEmailData creates a new AppEmailData with the provided data.
NewEmailQueue creates a new EmailQueue with the provided configuration.
NewUserEmailData creates a new UserEmailData with the provided data.
ParseTemplate parses the template file provided with the data provided.

# Variables

ErrDisallowedDomain is the error returned when the domain is disallowed.
ErrInitQueue is the error returned when the queue cannot be initialized.
ErrInvalidConfig is the error returned when the configuration is invalid.
ErrInvalidDomain is the error returned when the domain is invalid.
ErrInvalidEmail is the error returned when the email is invalid.
ErrLoadingDisposableDomains is the error returned when the disposable domains cannot be loaded.

# Structs

AppEmailData struct includes the data required to fill the app email template.
Email struct represents the email that is going to be sent.
EmailConfig struct represents the email configuration that is needed to send an email using and SMTP server.
EmailQueue struct represents the email queue.
UserEmailData struct includes the data required to fill the user email template.