GDGVIT/mailer-gui - Githubissues

MailerGui

A pip package with a GUI interface for managing bulk mailing of organization events

Functionalities

[X] Send Bulk Mail at once
[X] Send test mail to any email
[X] View and edit HTML template
[X] Set Placeholder values for the template
[X] Recipients extraction from .csv file with view support
[X] Send mail with/without attachments
[X] Send plainText/HTML mails
[ ] View and Download Logs of the bulk mail tasks

Application Overview

Landing Screen

This is the main page of the application. This is the landing screen where you will operate all the operations like sending mails and selecting the data to be send.

This is the landing page of the application for logging into the application. Use your username and password which you will set at the intial installation.

Recipients View Screen

Here the user will be able to see all the recipients details imported in to the application. You can view all the imported recipients at once.

Previewing HTML Screen

This window will help you view the html template you are sending. You can verify the placeholder text by taking a look at how mail will look in reciever's mailbox.

Summary Screen

This window will help the user to confirm all the selected items before starting the bulk mail process. This window will user to validate all the details are correct or not and confirm by ticking the check box before starting the bulk process. This will reduce the chances of error.

Progress Screen

This window will show real time logs of the bulk process. This will help the user monitor the process and validate whether the mails are not sending and keep a check on all the bounce rate of mails.

Instructions to run

Setup up Python env
```
pip install virtualenv
virtualenv env
```

Activate Environment

Windows
```
cd env/Scripts && activate
```
Linux
```
source ./env/Scripts/activate
```

Install from pip package(WIP)
```
pip install MailerGui
```

Add the following variables to your PATH:

# your login credentials to MailerGui
LOGIN_NAME

# your password
PASSKEY

# mailgun API key
API_KEY

# mailgun domain name
DOMAIN_MAIL

# sender mail address
FROM_MAIL

Find a sample of the environment variables here. Windows user can make .env file based on the sample env file.

You can also Build from source (Current Scenario)
- clone the repo
```
git clone repo_name 
```
- Change the working directory
```
cd MailerGui
```
- Create a virtual env based on the instructions given above.
- Install all the requirements in the active environment
```
pip install -r requirements.txt
```
- Run the program by executing
```
python main_gui.py
```

Contributors

Geek-Ubaid

Made with :heart: by DSC VIT