Emailer

An awesome bot to send beautiful Cookie Academy templates!
Explore the docs »
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

The script is developed for the purpose of sending mass custom html emails. However, we only provide templates for this specific Academy at the moment. Even though we do not support the custom-emailing version yet, it's possible to send your own custom template with some tweaks. The code still needs some contributions to make a GUI program and automatically fetch data from Google Sheet.

Built With

• Python 3.8
• yagmail
• keyring
• termcolor

Getting Started

Prerequisites

• Python 3.8

  sudo apt-get update

  sudo apt-get install python 3.8

  sudo apt-get install python3-pip

Installation

1. Clone the repo

   git clone https://github.com/waihankan/emailer.git

2. Install pip packages

   pip install -r requirements.txt

Usage

Here is how to use the code as of latest source code.

1. Go to the folder hr_html if you are from Human Resource Department, pr_html if you are from Public Relations Department, and academic_html if you are from Academic Department.

2. For Human Resource Department

   • Firstly, you'll have to fill in the applicants' names and emails using Excel in hr_applicants.csv file.
   • Run send_email.py file using the command python3 send_email.py and follow the insturctions provided in the program.
   • The program will show the progress while you're sending custom email to specific recipient. If everything runs smoothly it will show SUCCESS , and you are good to leave the program.
   • Do NOT forget to run the command python3 clear_csv.py as soon as you finish your emailing process as it will delete all the names and emails in hr_applicants.csv file.

3. For Public Relations Department

   • Firstly, you'll have to fill in the recipients' emails using Excel in pr_applicants.csv file.
   • Run send_pr.py file using the command python3 send_pr.py and follow the insturctions provided in the program.
   • The program will show the progress while you're sending custom email to all the recipients. If everything runs smoothly it will show Sent Invitation Successfully, and you are good to leave the program.
   • Do NOT forget to run the command python3 clear_csv.py as soon as you finish your emailing process as it will delete all the emails in pr_applicants.csv file.

4. For Academic Deparment

   • Firstly, you'll have to fill in the applicants' names using Excel in academic_applicants.csv file.
   • Add additional attachments in the folder named attachments.
   • Run send_academic.py file using the command python3 send_academic.py and follow the insturctions provided in the program.
   • Last but not least do NOT forget to run the command python3 clear_csv.py as soon as you finish your emailing process as it will delete all the emails in academic_applicants.csv file.

Demo Images

 

 

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

• @aungbobo04

License

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

Contact

@Wai Han - [email protected]

Donate Me -> @Wai Han

Acknowledgements

• GitHub Emoji Cheat Sheet
• Best Readme