Skip to content

Latest commit

 

History

History
151 lines (116 loc) · 5.82 KB

README.md

File metadata and controls

151 lines (116 loc) · 5.82 KB

MailScoutVerify - Email Finding & Verification

Find and verify email addresses accurately, ensuring authenticity and reliability for seamless communication

License: MIT Info Generic badge GitHub stars

Features 🎯

  • 📨 Email Finding: Helps in finding email addresses.
    • 🧭 Locate emails across various domains.
  • ✅ Email Verification: Ensures the authenticity and reliability of email addresses.
    • 🗂️ Categorize emails (personal, business, educational, disposable, others)
    • 🔒 Check against blacklisted domains
  • ⚡ Efficiency: Improves communication by ensuring valid contact details.
  • 🔒 Security: Verifies emails to prevent fake addresses.

Installation 🛠️

Install the package using npm:

npm install mailscoutverify

Usage 🖥️

Usage

  1. For Email Verification
import { EmailVerification } from "mailscoutverify";

const testEmail = "[email protected]";
EmailVerification(testEmail);
  1. For Email Finder - FullName
import { findEmailByFullNameHandle } from "mailscoutverify";

const domain = 'microsoft.com';
const fullName = 'Satya Nadella';
findEmailByFullNameHandle(domain, fullName);
  1. For Email Finder - First/Last Name
import { findEmailByNameHandle } from "mailscoutverify";

const domain = 'google.com';
const firstName = 'Sundar';
const lastName = 'Pichai';
findEmailByNameHandle(domain, firstName, lastName);

Examples 📝

Verifying a valid email

import { EmailVerification } from "mailscoutverify";

const testEmail = "[email protected]";
EmailVerification(testEmail);
// Output: Passed: Verification Result for user1@gmail.com: { isValid: true, category: 'personal' }

Verifying an invalid email

import { EmailVerification } from "mailscoutverify";

const testEmail = "[email protected]";
EmailVerification(testEmail);
// Output: Failed: Verification Result for fake@tempmail.com: { isValid: false, category: 'unknown', reason: 'Blacklisted domain' }

Finding Email By FullName

import { findEmailByFullNameHandle } from "mailscoutverify";

const domain = 'microsoft.com';
const fullName = 'Satya Nadella';
findEmailByFullNameHandle(domain, fullName);
/* Output:
{
  "input": {
    "company_name": null,
    "country_code": null,
    "domain": "microsoft.com",
    "first_name": null,
    "full_name": "Satya Nadella",
    "last_name": null
  },
  "results": {
    "alternatives": [
      "satyanad@microsoft.com"
    ],
    "email": "[email protected]",
    "validation": "valid"
  },
  "success": true
}*/

Finding Email By First/Last Name

import { findEmailByNameHandle } from "mailscoutverify";

const domain = 'google.com';
const firstName = 'Sundar';
const lastName = 'Pichai';
findEmailByNameHandle(domain, firstName, lastName);
/* Output:
{
  "input": {
    "company_name": null,
    "country_code": null,
    "domain": "google.com",
    "first_name": Sundar,
    "full_name": "null",
    "last_name": Pichai
  },
  "results": {
    "alternatives": [
      ""
    ],
    "email": "sundarpichai@google.com",
    "validation": "valid"
  },
  "success": true
}*/

Contributing 🤝

Contributions are always welcome! Please feel free to submit a Pull Request.

License 📜

This project is licensed under the MIT LICENSE.

Feedback 💬

If you have any feedback, please reach out to us at Mail.