ProjectsSeptember 29, 2024

Building a Transactional Mass Mailer with Rails

Overview

RubyMassMailer is a Rails API-only application designed to provide a flexible platform for sending mass transactional emails. Whether you're sending order confirmations, password resets, or any other type of email, RubyMassMailer makes it easy to manage and send your emails.

Features

API-Only: Lightweight and efficient API-only Rails application.
Mass Email Sending: Easily send transactional emails to multiple recipients.
Customizable Templates: Use customizable email templates to fit your branding and message.
Queue Processing: Background job processing for handling email queues.

Getting Started

Prerequisites

Ruby 3.0
Rails 6.0 or higher

Installation

Clone the repository:

git clone https://github.com/greeenboi/RubyMassMailer.git
cd RubyMassMailer

Install the dependencies:

bundle install

Create and Fill the Enviroment file .env.example -> .env
Start the server:

rails s

Configuration

Within ./config/initializers/mailjet adjust the api v3.1 or v3.0 depending on whether you want to send batch mails or not (check your mailjet config)

Mailer Config

Configure the mailer settings in config/environments/production.rb:

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
address: ENV['SMTP_ADDRESS'],
port: ENV['SMTP_PORT'],
user_name: ENV['SMTP_USER_NAME'],
password: ENV['SMTP_PASSWORD'],
authentication: 'plain',
enable_starttls_auto: true
}

Usage

Sending Emails To send an email, make a POST request to the /api/v1/emails endpoint.

Sample JS script

const fs = require('fs');
const path = require('path');
const axios = require('axios');
const FormData = require('form-data');

const API_URL = 'http://localhost:3000/api/v1/emails'; 
const RECIPIENT_EMAIL = 'coolman@email.com';
const ATTACHMENT_PATH = './yummy.jpg';

async function sendTestEmail() {
try {
  const formData = new FormData();
  formData.append('email[to]', RECIPIENT_EMAIL);
  formData.append('email[to_name]', 'Test Recipient');
  formData.append('email[subject]', 'Test Email from Demo Server');
  formData.append('email[text_content]', 'This is a test email sent from our demo server.');
  formData.append('email[html_content]', '<h1>Test Email</h1><p>This is a <strong>test email</strong> sent from our demo server.</p>');

  // Add attachment if the file exists
  if (fs.existsSync(ATTACHMENT_PATH)) {
    const attachment = fs.createReadStream(ATTACHMENT_PATH);
    formData.append('email[attachments][]', attachment, path.basename(ATTACHMENT_PATH));
  }
  // ...existing code...
  } catch (error) {
    console.error(error);
  }
}

Recent projects

The Eden Project

What if music wasn't so inaccessible..

Read case study

Run over a Deer

A Silly little game based on the hit movie Over The Hedge

Read case study

Just a Walkthrough

Framework-agnostic onboarding walkthrough / product tour library with optional React provider & Tailwind/shadcn support.

Read case study

Suvan GSgreeenboiGreenArcadeSuvan GSgreeenboiGreenArcadeSuvan GSgreeenboi