emailparser

Documentation

Index

• Variables
• type ParsedEmail
  • func Parse(email string) (ParsedEmail, error)
• type Pattern

Variables

var (
	ErrInvalidEmail = errors.New("invalid email address")
	ErrNoName       = errors.New("could not extract name from email")
)

Types

type ParsedEmail

type ParsedEmail struct {
	Email     string
	FirstName string
	LastName  string
	Pattern   string
}

func Parse

func Parse(email string) (ParsedEmail, error)

type Pattern

type Pattern string

const (
	PatternDelimited      Pattern = "delimited"       // brugnone.fabio
	PatternFirstName      Pattern = "firstname"       // abigail
	PatternCombined       Pattern = "combined"        // adambangh, michaelstewart
	PatternFullName       Pattern = "fullname"        // joshua.j.kim, brownjasmine
	PatternNameInitial    Pattern = "name.initial"    // tyler.g, colinj
	PatternInitialSurname Pattern = "initial.surname" // pslack, nfalletti
	PatternSurnameInitial Pattern = "surname.initial" // chapmann.a
	PatternUnknown        Pattern = "unknown"
)