H7 Verify Email

H7 Verify Email is a TypeScript library designed to validate email addresses. It ensures the email follows a standard format, checks for common mistakes (e.g., dots at the beginning or end of the local-part), and allows custom domain validation for popular providers like Gmail and Hotmail.

💖 Support This Project / Apoie Este Projeto

If this project has been helpful to you, please consider making a donation to support its ongoing development. Maintaining and improving this package takes time and effort, and your contribution helps ensure we can keep delivering quality solutions to the community.

Se este projeto foi útil para você, considere fazer uma doação para apoiar seu desenvolvimento contínuo. Manter este pacote atualizado e funcional exige tempo e esforço. Sua contribuição ajuda a garantir que possamos continuar fornecendo soluções de qualidade para a comunidade.

👉 Donate Here / Doe Aqui

Even a small contribution makes a big difference. Thank you for helping make this project possible!

Mesmo uma pequena contribuição faz uma grande diferença. Obrigado por ajudar a tornar este projeto possível! 🙏

Why donate? / Por que doar?

• ✅ To help develop new features.

  Para ajudar no desenvolvimento de novos recursos.

• ✅ To maintain compatibility with the latest versions of libraries and tools.

  Para manter a compatibilidade com as últimas versões de bibliotecas e ferramentas.

• ✅ To support a developer who values community contributions.

  Para apoiar um desenvolvedor que acredita na contribuição com a comunidade.

📦 Installation

To install the library, use the following command:

npm install h7-validate-email

🚀 Usage

Here's how to use the validateEmail and validatePopularEmails functions to validate an email:

import { validateEmail, validatePopularEmails } from "h7-validate-email";

// Regular validation
console.log(validateEmail("[email protected]"));  // true or false

// Custom domain validation for popular domains
console.log(validatePopularEmails("[email protected]"));  // true or false
console.log(validatePopularEmails("[email protected]"));  // false

📖 Features

• Validates Email Format: Uses advanced regular expressions to check if the email follows the standard format.
• Custom Domain Validation: Validates if the email domain belongs to a list of common providers like Gmail, Hotmail, Yahoo, and others.
• Rejects Invalid Local Part: Ensures the local part (before @) does not have invalid characters, like a dot at the beginning or end.
• TypeScript support: Fully typed and compatible with TypeScript projects.
• Lightweight: A simple and efficient library with no dependencies.

🛠️ How it Works

This library validates email addresses by:

• Using an advanced regex pattern based on RFC 5322 to check the format.
• Rejecting email addresses where the local part starts or ends with a dot.
• Allowing custom domain validation for popular email providers (e.g., Gmail, Yahoo, etc.).

📜 Example Use Case

Imagine a web application where users are required to provide a valid email for registration or login. Using this library, you can ensure that only correctly formatted emails, from known providers, are accepted:

import { validatePopularEmails } from "h7-validate-email";

const email = "[email protected]";

if (validatePopularEmails(email)) {
  console.log("The email is valid.");
} else {
  console.log("Invalid email. Please check and try again.");
}

🤝 Contributing

Feel free to contribute to this project by opening issues or submitting pull requests. All contributions are welcome!

👨‍💻 Author

Developed by Herlandio. If you find this library helpful, consider starring the repository on GitHub!

📝 License

This project is licensed under the MIT License. You are free to use, modify, and distribute it as long as you provide proper attribution.