checkmail

README

checkmail

Golang package for email validation.

• Format (simple regexp, see: https://www.w3.org/TR/html5/forms.html#valid-e-mail-address and https://davidcel.is/posts/stop-validating-email-addresses-with-regex/)
• Valid domain
• Valid user: verify if the user and mailbox really exist

Usage

1. Format

    func main() {
		err := checkmail.ValidateFormat("ç$€§/az@gmail.com")
		if err != nil {
			fmt.Println(err)
		}
	}

output: invalid format

2. Domain

    func main() {
		err := checkmail.ValidateHost("email@x-unkown-domain.com")
		if err != nil {
			fmt.Println(err)
		}
	}

output: unresolvable host

3. User

    func main() {
		err := checkmail.ValidateHost("unknown-user-129083726@gmail.com")
		if smtpErr, ok := err.(checkmail.SmtpError); ok && err != nil {
			fmt.Printf("Code: %s, Msg: %s", smtpErr.Code(), smtpErr)
		}
	}

output: Code: 550, Msg: 550 5.1.1 The email account that you tried to reach does not exist.

License

Checkmail is licensed under the MIT License.

Documentation

Index

• Variables
• func DialTimeout(addr string, timeout time.Duration) (*smtp.Client, error)
• func ValidateFormat(email string) error
• func ValidateHost(email string) error
• type SmtpError
  • func NewSmtpError(err error) SmtpError
  • func (e SmtpError) Code() string
  • func (e SmtpError) Error() string

Variables

var (
	ErrBadFormat        = errors.New("invalid format")
	ErrUnresolvableHost = errors.New("unresolvable host")
)

Functions

func DialTimeout

func DialTimeout(addr string, timeout time.Duration) (*smtp.Client, error)

DialTimeout returns a new Client connected to an SMTP server at addr. The addr must include a port, as in "mail.example.com:smtp".

func ValidateFormat

func ValidateFormat(email string) error

func ValidateHost

func ValidateHost(email string) error

Types

type SmtpError

type SmtpError struct {
	Err error
}

func NewSmtpError

func NewSmtpError(err error) SmtpError

func (SmtpError) Code

func (e SmtpError) Code() string

func (SmtpError) Error

func (e SmtpError) Error() string