add options

Author: mfbx9da4

README.md

@@ -2,7 +2,7 @@
 
 Validates emails based on regex, common typos, disposable email blacklists, DNS records and SMTP server response.
 
-- Validates email is compliant with RFC standard using regex.
+- Validates email is compliant with [RFC standard](https://tools.ietf.org/html/rfc2822#appendix-A.1.2) using regex.
 - Validates common typos e.g. [email protected].
 - Validates email was not generated by disposable email service.
 - Validates MX records are present on DNS.
@@ -26,6 +26,7 @@ const main = async () => {
   let res = await validate('[email protected]')
   // {
   //   "valid": false,
+  //   "reason": "smtp",
   //   "validators": {
   //       "regex": {
   //         "valid": true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deep-email-validator",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "files": [
     "dist/**/*"
   ],

src/index.ts

@@ -6,25 +6,73 @@ import { checkSMTP } from './smtp/smtp'
 import { checkDisposable } from './disposable/disposable'
 import './types'
 
+const defaultOptions = {
+  email: '[email protected]',
+  sender: '[email protected]',
+  validateRegex: true,
+  validateMx: true,
+  validateTypo: true,
+  validateDisposable: true,
+  validateSMTP: true,
+}
+
+type ValidatorOptions = {
+  email: string
+  sender?: string
+  validateRegex?: boolean
+  validateMx?: boolean
+  validateTypo?: boolean
+  validateDisposable?: boolean
+  validateSMTP?: boolean
+}
+
+type ValidatorOptionsFinal = {
+  email: string
+  sender: string
+  validateRegex: boolean
+  validateMx: boolean
+  validateTypo: boolean
+  validateDisposable: boolean
+  validateSMTP: boolean
+}
+
 export async function validate(
-  recipient: string,
-  sender: string = '[email protected]'
+  emailOrOptions: string | ValidatorOptions
 ): Promise<OutputFormat> {
-  console.log('recipient', recipient)
-  if (!isEmail(recipient)) return createOutput('regex', 'Invalid regex')
+  let email: string
+  let options: ValidatorOptionsFinal = defaultOptions
+  if (typeof emailOrOptions === 'string') {
+    email = emailOrOptions
+  } else {
+    email = emailOrOptions.email
+    options = { ...options, ...emailOrOptions }
+  }
 
-  const typoResponse = await checkTypo(recipient)
-  if (typoResponse) return createOutput('typo', typoResponse)
+  if (options.validateRegex && !isEmail(email))
+    return createOutput('regex', 'Invalid regex')
 
-  const domain = recipient.split('@')[1]
+  if (options.validateTypo) {
+    const typoResponse = await checkTypo(email)
+    if (typoResponse) return createOutput('typo', typoResponse)
+  }
 
-  const disposableResponse = await checkDisposable(domain)
-  if (disposableResponse) return createOutput('disposable', disposableResponse)
+  const domain = email.split('@')[1]
 
-  const mx = await getBestMx(domain)
-  if (!mx) return createOutput('mx', 'MX record not found')
+  if (options.validateDisposable) {
+    const disposableResponse = await checkDisposable(domain)
+    if (disposableResponse)
+      return createOutput('disposable', disposableResponse)
+  }
+
+  if (options.validateMx) {
+    const mx = await getBestMx(domain)
+    if (!mx) return createOutput('mx', 'MX record not found')
+    if (options.validateSMTP) {
+      return checkSMTP(options.sender, email, mx.exchange)
+    }
+  }
 
-  return checkSMTP(sender, recipient, mx.exchange)
+  return createOutput()
 }
 
 async function main() {