wangyuehong / gonormail

A simple and easy-to-extend Go library for normalizing email address

gonormail

gonormail is a Go library to normalize email or build a email normalizer with the default support of gmail.

Usage

Normalization by default normalizer supported gmail. email should be validated before normalization.

gonormail.Normalize("Not A Email")              // Not A Email
gonormail.Normalize("Not@A@Email")              // Not@A@Email
gonormail.Normalize("[e-mail]")          // [e-mail]
gonormail.Normalize("[e-mail]")         // [e-mail]
gonormail.Normalize("[e-mail]")      // [e-mail]
gonormail.Normalize("[e-mail]") // [e-mail]
gonormail.Normalize("[e-mail]")   // [e-mail]

Customized normalization by extending the default EmailNormalizer.

norm := gonormail.DefaultEmailNormalizer().
  AddNormalizer(gonormail.NewDomainAlias(map[string]string{"examplemail.com": "email.com"})).
  AddNormalizer(gonormail.NewRemoveLocalDots("email.com")).
  AddNormalizer(gonormail.NewRemoveSubAddressing(map[string]string{"email.com": "-"}))

norm.Normalize("[e-mail]")       // [e-mail]
norm.Normalize("[e-mail]")  // [e-mail]
norm.Normalize("[e-mail]") // [e-mail]
norm.Normalize("[e-mail]")       // [e-mail]

Create a new EmailNormalizer by fully customization.

norm := gonormail.NewEmailNormalizer().
  AddFunc(gonormail.ToLowerCase).
  AddNormalizer(gonormail.NewDomainAlias(map[string]string{"googlemail.com": "gmail.com", "examplemail.com": "email.com"})).
  AddNormalizer(gonormail.NewRemoveLocalDots("email.com", "gmail.com")).
  AddNormalizer(gonormail.NewRemoveSubAddressing(map[string]string{"email.com": "-", "gmail.com": "+"}))

norm.Normalize("[e-mail]")       // [e-mail]
norm.Normalize("[e-mail]")  // [e-mail]
norm.Normalize("[e-mail]") // [e-mail]
norm.Normalize("[e-mail]")       // [e-mail]

Create your own Normalizer.

norm := gonormail.NewEmailNormalizer().
  AddFunc(func(e *gonormail.EmailAddress) {
    e.Local = strings.ToUpper(e.Local)
    e.Domain = strings.ToUpper(e.Domain)
})
norm.Normalize("[e-mail]") // [e-mail]