Skip to content

basillal/Mailer-Service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Mailer Service

A powerful and efficient bulk email sending service leveraging AWS services. The Mailer Service allows users to upload email templates, manage recipients, and send bulk emails with ease. This service is suitable for newsletters, marketing campaigns, and notifications, providing a user-friendly interface for creating and managing emails in a few simple steps.


Key Features

  • AWS Integration: Utilize Amazon Web Services (AWS) for reliable and scalable email delivery.
  • Email Templates: Upload custom HTML email templates for branding and personalization.
  • Bulk Emailing: Send emails to thousands of recipients efficiently.
  • Multi-technology Stack: Built with a combination of JavaScript, Python, HTML, and CSS for robust functionality and clean design.

Technology Stack

Language Purpose
JavaScript Backend logic and API handling.
Python Additional integrations or utilities.
CSS Styling the user interface.
HTML Defining email templates.

Repository Structure

Mailer-Service/
├── Backend/           # Contains server-side code (Node.js, AWS integrations, API handlers)
├── frontend/          # Contains the frontend for managing templates and sending emails
├── README.md          # Documentation for the project

How to Use

1. Clone the Repository

Start by cloning this repository:

git clone https://github.com/basillal/Mailer-Service.git
cd Mailer-Service

2. Backend Setup

  1. Navigate to the Backend folder:

    cd Backend
  2. Install dependencies:

    npm install
  3. Configure AWS:

    • Add your AWS credentials in the configuration file (config.js) or environment variables:
      module.exports = {
        region: 'us-east-1',
        accessKeyId: 'your-access-key-id',
        secretAccessKey: 'your-secret-access-key',
        emailSource: 'your-email@example.com'
      };
  4. Start the backend server:

    node server.js

    The backend will handle API calls to AWS for sending email.


3. Frontend Setup

  1. Navigate to the frontend folder:

    cd ../frontend
  2. Install dependencies:

    npm install
  3. Start the frontend server:

    npm start

    The frontend will run on http://localhost:3000.


4. Sending Emails

  • Upload your custom email template via the frontend interface.
  • Add your recipient list as a CSV or input manually.
  • Send emails in bulk with just a few clicks.

Use Cases

  • Newsletters: Keep your subscribers updated with regular emails.
  • Marketing Campaigns: Promote your products and services to a broad audience.
  • Transactional Emails: Send automated emails like password resets, order confirmations, etc.

The Mailer Service simplifies email delivery, making it ideal for businesses of any size!

About

A bulk email service using AWS to send emails, manage templates, and recipients easily with backend and frontend integration.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors