Email Sender Script

Made by:

• Mark Achiles G. Flores Jr.
• Rafael Louie V. Miguel
• Xian Hui B. Cheng
• Francine Nastassja P. Jara

Description

This script was used for the sending of dynamic emails to the office applicants of AWS Cloud Club - PUP Manila. The scripts, written by Mark Achiles G. Flores Jr., utilizes AWS SES for the template generation and email sending. The HTML Templates and UI design was made by Rafael Louie V. Miguel and Xian Hui B. Cheng with the use of the club's official graphics made by Francine Nastassja P. Jara.

Running the scripts

Setting up your environment

1. Create a virtual environment

   python -m venv venv
   

2. Activate your virtual environment

• Search online how to activate your virtual environment for your shell

  . venv/Scripts/activate
  

3. Install the necessary python packages

   pip install -r requirements.txt
   

Setting up your local database

1. Setup a local database in MongoDB with awscc as the database and members as the collection
2. Create a few sample documents with the fields fullName and nickname. The fullName field will be used to access the nickname

Setting up environment variables

1. Inside the app folder, you'll see a .sample-env file. Duplicate this file and rename the duplicate to .env.
2. After duplicating the file, supply the necessary details.
   • EMAIL: Email address that you'll be using to send the emails. Must be a verified email in your AWS SES.
   • ACCESS_KEY and SECRET_KEY: You can get these from your AWS account, just search how.

Using the app

1. Choose a CSV file from the data_templates folder and supply the necessary details.
   • Do not edit the template directly, make a copy first before editing. You may put your filled-up CSV files inside any other folder for best practice.
2. View the code for the HTML template that you will be using, commented at the top are the required fields (SUBJECT and EMAIL are always required, regardless of the HTML template). Make sure that these fields are satisfied in your CSV file.
   • If you're using you're own HTML templates, enclose your template variables in double curly brackets like the example below:

   {{ NICKNAME }}
   

3. Run main.py and enjoy!

Update

• Anyone else may now use this app, provided that they have their own AWS account.

For more inquiries...

You can reach out to me (Mark) through my social media accounts if you wanna know more about the script and if you need help creating your own.

• Facebook
• LinkedIn