email

README

go-emailvalidation

Purpose

Simple email validation package. Package valids email address string to RFC requirements and performs a DNS lookup for the MX records using the local DNS settings.

Usage

package main

import (
	"fmt"

	"github.com/cameronnewman/go-emailvalidation"
)

func main() {

	emailValidate := email.New()

	emailaddress := "john.snow@gmaiiiiiiillllll.com"

	// Run all checks
	err := emailValidate.ValidateEmailAddress(emailaddress)
	if err != nil {
		fmt.Println(err)
	}

	// Just check the format
	err = emailValidate.ValidateFormat(emailaddress)
	if err != nil {
		fmt.Println(err)
	}

	// Just check domain MX records exist
	err = emailValidate.ValidateDomainMailRecords(emailaddress)
	if err != nil {
		fmt.Println(err)
	}
}

Issues

• None

License

MIT Licensed

Documentation

Overview

Package email is a simple email validation package. Package valids email address string to RFC requirements and performs a DNS lookup for the MX records using the local DNS settings.

Index

• Variables
• type Validation
  • func New() *Validation
  • func (e *Validation) SplitEmailAddress(email string) (username, domain string)
  • func (e *Validation) ValidateDomainMailRecords(domain string) error
  • func (e *Validation) ValidateEmailAddress(email string) error
  • func (e *Validation) ValidateFormat(email string) error

Variables

var (
	//ErrEmailInvalidFormat is an error generatd when the format is incorrect
	ErrEmailInvalidFormat = errors.New("Invalid email format")

	//ErrEmailInvalidDomain is an error generatd when the domain is invalid or no MX reocrds can be found
	ErrEmailInvalidDomain = errors.New("Invalid email domain OR MX records don't exist")
)

Types

type Validation

type Validation struct {
}

Validation struct

func New

func New() *Validation

New returns a new Validation struct

func (*Validation) SplitEmailAddress

func (e *Validation) SplitEmailAddress(email string) (username, domain string)

SplitEmailAddress - Splits an email address into a prefix and domain

func (*Validation) ValidateDomainMailRecords

func (e *Validation) ValidateDomainMailRecords(domain string) error

ValidateDomainMailRecords - validates a domain MX records via a DNS lookup

func (*Validation) ValidateEmailAddress

func (e *Validation) ValidateEmailAddress(email string) error

ValidateEmailAddress - validates an email address via all methods

func (*Validation) ValidateFormat

func (e *Validation) ValidateFormat(email string) error

ValidateFormat - validates an email address meets rfc 822 format via a regex