Update README

Author: Deadpool2000

README.md

@@ -1,6 +1,91 @@
-# KnowEmail
-An Open Source Email Verifier & Validator
+<div align="center">
 
-### Maintainer - [@Deadpool2000](https://github.com/Deadpool2000)
+<picture>
+  <img alt="knowemaill logo" src="src/logo.png" width="100%">
+</picture>
 
-![Image](https://github.com/user-attachments/assets/41dbb5cc-809e-4b7c-970d-f19a1fa938f1)
+An Open Source Email Verifier &amp; Validator.
+<h3>
+By [OpenInitia](https://github.com/OpenInitia)
+</h3>
+
+Maintainer - [@Deadpool2000](https://github.com/Deadpool2000)
+
+[![GitHub language](https://img.shields.io/github/languages/top/OpenInitia/KnowEmail)](https://github.com/OpenInitia/KnowEmail)
+[![GitHub Repo stars](https://img.shields.io/github/stars/OpenInitia/KnowEmail)](https://img.shields.io/github/stars/OpenInitia/KnowEmail)
+[![GitHub issues](https://img.shields.io/github/issues/OpenInitia/KnowEmail)](https://github.com/OpenInitia/KnowEmail/issues)
+[![GitHub contributors](https://img.shields.io/github/contributors/OpenInitia/KnowEmail)](https://github.com/OpenInitia/KnowEmail/graphs/contributors)
+[![GitHub license](https://img.shields.io/github/license/OpenInitia/KnowEmail)](https://github.com/OpenInitia/KnowEmail/blob/main/LICENSE)
+
+
+<picture>
+  <img alt="knowemaill logo" src="src/knowemail.png" width="100%">
+</picture>
+</div>
+
+KnowEmail is a robust, open-source email verification and validation tool designed to ensure that email addresses in their applications are valid, safe, and properly formatted. Whether you're looking to reduce spam, improve data quality, or simply verify user input, KnowEmail offers a reliable solution for your email verification needs.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Features
+
+- **Email Syntax Validation:** Ensures the email address adheres to proper format.
+- **Domain Verification:** Checks for the existence of the email's domain and associated DNS records.
+- **MX Record Check:** Confirms that the email domain is configured to receive emails.
+- **Real-time Verification:** Provides quick and accurate results.
+- **Extensible Architecture:** Easily integrated and extended to meet custom requirements.
+
+## Installation
+
+### Clone the Repository
+
+Clone the repository to your local machine:
+
+```bash
+git clone https://github.com/OpenInitia/KnowEmail.git
+cd KnowEmail
+```
+
+### Setup Environment
+
+If using Python, install the required dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+*Note:* If you’re integrating KnowEmail into another project or using a different language, please refer to the appropriate setup instructions in the project documentation.
+
+## Usage
+
+You can run KnowEmail either from the command line or integrate it directly into your projects.
+
+
+```bash
+python3 main.py
+```
+
+
+*Tip:* Customize the script or integrate additional checks as needed for your specific application.
+
+## Contributing
+
+Contributions are welcome! If you have any ideas, please contribute!
+
+## License
+
+This project is licensed under the [GNU GPL 3.0 License](LICENSE). See the LICENSE file for details.
+
+## Contact
+
+For any questions, suggestions, or support, please reach out:
+
+- **Maintainer:** [@Deadpool2000](https://github.com/Deadpool2000)
+- **Open an Issue:** [GitHub Issues](https://github.com/OpenInitia/KnowEmail/issues)

main.py

@@ -1,5 +1,4 @@
 import sys
-from PyQt5 import QtWidgets
 from src.gui import EmailValidatorApp
 from PyQt5 import QtWidgets, QtCore
 from PyQt5.QtWidgets import *

src/__pycache__/gui.cpython-311.pyc

@@ -19,6 +19,12 @@ def __init__(self, parent=None):
         self.layout.addWidget(self.table)
         self.setLayout(self.layout)
 
+
+    # Enable the "?" help button
+        self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowContextHelpButtonHint)
+
+        
+
     def add_row(self, email, status):
         row_position = self.table.rowCount()
         self.table.insertRow(row_position)
@@ -35,6 +41,53 @@ def add_row(self, email, status):
 
         self.table.setItem(row_position, 0, email_item)
         self.table.setItem(row_position, 1, status_item)
+    
+    def showEvent(self, event):
+        """Override showEvent to ensure the help button is available."""
+        super().showEvent(event)
+        
+        # Find the help button after the dialog is shown
+        help_button = self.findChild(QtWidgets.QAbstractButton, "qt_help_button")
+        if help_button:
+            help_button.clicked.connect(self.show_status_help)
+
+    def show_status_help(self):
+        help_text = """
+        <b>Verification Status Explanations:</b><br><br>
+        
+        <span style='color:#27ae60; font-weight:bold'>Valid</span>: 
+        - Email address is valid and reachable<br>
+        - Domain has proper MX records<br>
+        - SMTP server confirmed the mailbox exists<br><br>
+        
+        <span style='color:#e74c3c; font-weight:bold'>Invalid (Syntax)</span>: 
+        - Email format is incorrect<br>
+        - Missing @ symbol or invalid domain structure<br>
+        - Example: <i>user@domain</i> (missing .com)<br><br>
+        
+        <span style='color:#e74c3c; font-weight:bold'>Invalid (No MX)</span>: 
+        - Domain does not have mail exchange records<br>
+        - Domain might not exist or is not configured for email<br>
+        - Example: <i>[email protected]</i><br><br>
+        
+        <span style='color:#e74c3c; font-weight:bold'>Invalid (SMTP)</span>: 
+        - Domain exists, but the mailbox does not<br>
+        - SMTP server rejected the recipient address<br>
+        - Example: <i>[email protected]</i><br><br>
+        
+        <span style='color:#f1c40f; font-weight:bold'>Error</span>: 
+        - Temporary network issues<br>
+        - SMTP server timeout or connection error<br>
+        - Unexpected verification errors<br><br>
+        
+        <i>Note: Some email servers may block verification attempts for privacy reasons.</i>
+        """
+        help_dialog = QtWidgets.QMessageBox(self)
+        help_dialog.setWindowTitle("Verification Status Help")
+        help_dialog.setTextFormat(QtCore.Qt.RichText)  # Enable HTML formatting
+        help_dialog.setText(help_text)
+        help_dialog.setStandardButtons(QtWidgets.QMessageBox.Ok)
+        help_dialog.exec_()
 
 class BulkVerificationThread(QtCore.QThread):
     result_signal = QtCore.pyqtSignal(str, str)
@@ -62,7 +115,6 @@ def run(self):
                 status = f"Error: {str(e)}"
 
             self.result_signal.emit(email, status)
-        
         self.all_done.emit()  # Signal completion after all emails
 
 class EmailValidatorApp(QtWidgets.QWidget):
@@ -82,7 +134,7 @@ def init_ui(self):
         # Main layout
         main_layout = QtWidgets.QVBoxLayout()
         main_layout.setContentsMargins(40, 30, 40, 30)
-        main_layout.setSpacing(20)
+        main_layout.setSpacing(15)
 
         # Header Section
         header_layout = QtWidgets.QVBoxLayout()
@@ -96,9 +148,8 @@ def init_ui(self):
         header_layout.addWidget(subtitle, 0, QtCore.Qt.AlignHCenter)
         main_layout.addLayout(header_layout)
 
-        # Description
         description = QtWidgets.QLabel(
-            "Tired of dealing with invalid email addresses? Free Email Verifier tool helps you "
+            "Tired of dealing with invalid email addresses? KnowEmail helps you "
             "clean your email lists by ensuring every address is valid before you send that "
             "important campaign."
         )
@@ -159,7 +210,7 @@ def bulk_verify(self):
             self,
             "Select Email List",
             "",
-            "Text Files (*.txt);;Excel Files (*.xlsx)"
+            "Text File (*.txt);; Excel File (*.xlsx)"
         )
 
         if not file_path:

src/gui.py

@@ -15,31 +15,31 @@ QLabel, QLineEdit, QPushButton, QMessageBox {
     font-size: 28px;
     font-weight: bold;
     color: #2c3e50;
-    margin-bottom: 5px;
+    margin-bottom: 3px;  /* Reduced margin-bottom */
 }
 
 /* Subtitle styling */
 #subtitle {
     font-size: 16px;
     color: #7f8c8d;
-    margin-bottom: 20px;
+    margin-bottom: 15px;  /* Reduced margin-bottom */
 }
 
 /* Description text styling */
 #description {
     font-size: 14px;
     color: #34495e;
     line-height: 1.4;
-    margin-bottom: 30px;
+    margin-bottom: 20px;  /* Reduced margin-bottom */
 }
 
 /* Email input field styling */
 #emailInput {
-    padding: 12px;
+    padding: 8px;  /* Reduced padding */
     border: 2px solid #bdc3c7;
     border-radius: 6px;
     font-size: 14px;
-    min-width: 300px;
+    min-width: 280px;  /* Reduced min-width */
     color: #2c3e50;
     background-color: #f8f9fa;
 }
@@ -59,12 +59,12 @@ QLineEdit {
 #checkButton {
     background-color: #3498db;
     color: white;
-    padding: 12px 30px;
+    padding: 8px 20px;  /* Reduced padding */
     border: none;
     border-radius: 6px;
     font-size: 14px;
     font-weight: bold;
-    min-width: 120px;
+    min-width: 100px;  /* Reduced min-width */
 }
 
 #checkButton:hover {
@@ -75,23 +75,23 @@ QLineEdit {
 #resultLabel {
     color: #e74c3c;
     font-size: 14px;
-    margin-top: 10px;
+    margin-top: 8px;  /* Reduced margin-top */
     text-align: center;
 }
 
 /* Support section styling */
 #supportLabel {
     color: #7f8c8d;
     font-size: 13px;
-    margin: 10px 0 15px 0;
+    margin: 8px 0 10px 0;  /* Reduced margins */
     text-align: center;
 }
 
 /* Donate button styling */
 #donateButton {
     background-color: #27ae60;
     color: white;
-    padding: 10px 25px;
+    padding: 8px 20px;  /* Reduced padding */
     border: none;
     border-radius: 5px;
     font-size: 13px;
@@ -116,11 +116,11 @@ QMessageBox QLabel {
 QMessageBox QPushButton {
     background-color: #3498db;
     color: white !important;
-    padding: 8px 20px;
+    padding: 6px 15px;  /* Reduced padding */
     border: none;
     border-radius: 4px;
     font-size: 13px;
-    min-width: 80px;
+    min-width: 70px;  /* Reduced min-width */
 }
 
 QMessageBox QPushButton:hover {
@@ -144,13 +144,13 @@ QPushButton {
 #bulkButton {
     background-color: #9b59b6;
     color: white;
-    padding: 12px 30px;
+    padding: 8px 20px;  /* Reduced padding */
     border: none;
     border-radius: 6px;
     font-size: 14px;
     font-weight: bold;
-    min-width: 120px;
-    margin-top: 10px;
+    min-width: 100px;  /* Reduced min-width */
+    margin-top: 8px;  /* Reduced margin-top */
 }
 
 #bulkButton:hover {
@@ -167,10 +167,11 @@ QTableWidget {
 QHeaderView::section {
     background-color: #3498db;
     color: white;
-    padding: 8px;
+    padding: 6px;  /* Reduced padding */
     border: none;
 }
 
 QTableWidget::item {
-    padding: 8px;
-}
+    padding: 4px;  /* Reduced padding */
+}
+