README
¶
mailck - SMTP mail validation
golang library for email validation
This library allows you to check if an email address is realy valid:
- Syntax check
- Blacklist of disposable mailservers (e.g. mailinator.com)
- SMTP mailbox check
Preconditions
Make sure, that the ip address you are calling from is not black listed. This is e.g. the case if the ip is a dynamic IP. Also make sure, that you have a correct reverse dns lookup for your ip address, matching the hostname of your from adress. Alternatively use a SPF DNS record entry matching the host part of the from address.
In case of a blacklisting, the target mailserver may respond with an SMTP 554
or just let you run into a timout.
Usage
Do all checks at once:
result, _ := mailck.Check("noreply@mancke.net", "foo@example.com")
switch {
case result.IsValid():
// valid!
// the mailserver accepts mails for this mailbox.
case result.IsError():
// something went wrong in the smtp communication
// we can't say for sure if the address is valid or not
case result.IsInvalid():
// invalid for some reason
// the reason is contained in result.ResultDetail
// or we can check for different reasons:
switch (result) {
case mailck.InvalidDomain:
// domain is invalid
case mailck.InvalidSyntax:
// e-mail address syntax is invalid
}
}
License
MIT Licensed
Documentation
¶
Index ¶
- Constants
- Variables
- func CheckDisposable(checkEmail string) bool
- func CheckSyntax(checkEmail string) bool
- type Result
- func Check(fromEmail, checkEmail string) (result Result, err error)
- func CheckMailbox(fromEmail, checkEmail string) (result Result, err error)
- func CheckMailboxWithContext(ctx context.Context, fromEmail, checkEmail string) (result Result, err error)
- func CheckWithContext(ctx context.Context, fromEmail, checkEmail string) (result Result, err error)
- func CheckWithoutConnect(checkEmail string) (result Result, err error)
- type ResultState
Constants ¶
const ( ValidState ResultState = "valid" InvalidState = "invalid" ErrorState = "error" )
Variables ¶
var ( Valid = Result{ValidState, "mailboxChecked", "The email address is valid."} ValidWithoutTestConnect = Result{ValidState, "withoutConnect", "The email address is valid."} InvalidSyntax = Result{InvalidState, "invalidSyntax", "The email format is invalid."} InvalidDomain = Result{InvalidState, "invalidDomain", "The email domain does not exist."} Disposable = Result{InvalidState, "disposable", "The email is a throw-away address."} MailserverError = Result{ErrorState, "mailserverError", "The target mailserver responded with an error."} TimeoutError = Result{ErrorState, "timeoutError", "The connection with the mailserver timed out."} NetworkError = Result{ErrorState, "networkError", "The connection to the mailserver could not be made."} ServiceError = Result{ErrorState, "serviceError", "An internal error occured while checking."} ClientError = Result{ErrorState, "clientError", "The request was was invalid."} )
var DisposableDomains = map[string]bool{}/* 17257 elements not displayed */
DisposableDomains is a list of fake mail providers. The list was taken from https://github.com/andreis/disposable License: MIT Last updated: Mon Apr 8 16:05:32 CST 2019
Functions ¶
func CheckDisposable ¶
CheckDisposable returns true if the mail is a disposal mail, false otherwise
func CheckSyntax ¶
CheckSyntax returns true for a valid email, false otherwise
Types ¶
type Result ¶
type Result struct {
Result ResultState `json:"result"`
ResultDetail string `json:"resultDetail"`
Message string `json:"message"`
}
Result contains the information about an email check.
func Check ¶
Check checks the syntax and if valid, it checks the mailbox by connecting to the target mailserver The fromEmail is used as from address in the communication to the foreign mailserver.
func CheckMailbox ¶
CheckMailbox checks the checkEmail by connecting to the target mailbox and returns the result. The fromEmail is used as from address in the communication to the foreign mailserver.
func CheckMailboxWithContext ¶
func CheckWithContext ¶
func CheckWithoutConnect ¶
type ResultState ¶
type ResultState string
func (ResultState) String ¶
func (rs ResultState) String() string
Source Files
Directories