Email Client

An Email Client built using SMTP and IMAP Protocols
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

A Thunderbird like Email Client built using SMTP and IMAP Protocols. GUI created using PyQt5.

view all emails

send email to a recipient

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python Make sure you have Python installed on your system. You can download and install Python from the official Python Website.

Installation

To install and run the program, follow these steps: Windows

1. Open Command Prompt.

2. Clone the repository:

   git clone https://github.com/InfiniteLoopify/email-client.git

3. Navigate to the project directory:

   cd email-client

4. Create a virtual environment and activate it:

   For Windows

   python -m venv venv    # create virtual environment
   venv\Scripts\activate  # activate virtual environment

   For Linux/MacOS

   python3 -m venv venv      # create virtual environment
   source venv/bin/activate  # activate virtual environment

5. Install dependencies:

   pip install -r requirements.txt

(back to top)

Usage

To use the program, follow these steps:

1. Create an environment variable file .env in project directory:

   touch .env

2. Store your Credentials in your environment variable file:

   # inside .env file
   EMAIL_USERNAME=example@gmail.com
   EMAIL_PASSWORD=my password

   If you are using Gmail account, you might want to create a new Gmail App Password. For more details, visit here.
3. Make sure you have activated the virtual environment.
4. Run the program:

   python main.py

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Umair Shahab - LinkedIn - umair.shahab.ahmed@gmail.com

Project Link: https://github.com/InfiniteLoopify/email-client

(back to top)