Exam mark mailer

Exam Mark Mailer is a simple and user-friendly web interface for sending exam marks to students via email. It allows teachers to enter marks manually or import them from CSV, and send personalized emails to each student.

Table Of Contents

• Features
• Installation
  • Configuration
• Usage
  • Steps to send marks
  • Available Variables
  • Available Shortcuts
• License

Features

• Add or remove students dynamically.
• Load students and marks from a CSV file.
• Customize the email message with many variables.
• Reset message to default template.
• Send personalized emails to multiple students at once.
• Supports Markdown formatting.
• Many shortcuts for fast editing.
• search bar from 5 students.

Installation

Clone the git directory

git clone https://github.com/ISC-HEI/exam_mark_webmailer.git
cd exam_mark_webmailer

Copy .env.example to .env and configure your environment variables:

cp .env.example .env
# php artisan key:generate

You can run php artisan key:generate if you want to add some functions. If you just want to use the program as is, a key is provided in the .env.example file.

Create the docker image and start

docker build -t exam-mark-webmailer:1 .
docker run -p 8000:8000 exam-mark-webmailer:1

Configuration

You need to configure your mail settings in the .env file to enable sending emails. Example configuration using Gmail SMTP:

MAIL_MAILER=smtp
MAIL_HOST=smtp.gmail.com
MAIL_PORT=587
MAIL_USERNAME=[email protected]
MAIL_PASSWORD="aaaa bbbb cccc dddd"
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=[email protected]
MAIL_FROM_NAME="${APP_NAME}"

Note: For Gmail, you may need to create an App Password or enable “Less secure app access”.

Usage

You can start the web page

php artisan serve
# Or via docker
docker run -p 8000:8000 exam-mark-webmailer:1

Steps to send marks:

1. Fill in the Course Name and Exam Name.
2. Add student details manually or load from a CSV file.
3. Customize the email message using the available variables

Tip : You can type [ to get the variables

4. Click Send Emails.

Optional: use Reset Message to restore the default template.

Available Variables

Here is a list of available variables

Variable	Description
[STUDENT_NAME]	The name of the student
[STUDENT_MARK]	The mark of the student
[COURSE_NAME]	The name of the course
[EXAM_NAME]	The name of the exam
[CLASS_AVERAGE]	The class average
[MY_EMAIL]	Your email (teacher)

Available Shortcuts

Here is a list of available shortcuts

Shortcut	Action
ALT + ENTER	Send the marks
ALT + A	Add a student
ALT + M	Focus the message area
ALT + R	Reset the message

License

The current License is Apache version 2.0, you can see it in the LICENSE file.