Tchurymail

This is a Work In Progress!

Introduction

Tchurymail is an open-source software to manage your business emails. Within the admin panel, you can create emails template, and through APIs, you can send these emails, written in MJML.

Installation

1. Set mail variables in .env
2. Run composer install and npm install
3. Run php artisan migrate --seed
4. Run php artisan storage:link
5. Start the server
6. Do a POST request to /api/login with admin@admin.com / password in order to get the API token

Usage

1. Go to /admin to open the admin panel
2. Create your template
3. Send via /api/sendEmail/{secret_api}

Writing mails

It is possible to write email through the admin panel.

Variables

To add a variable, insert {{$nameOfTheVariable}} in the template. When the API is called, pass an object variables containing the name of the variable as the key.

Roadmap to v1.0

• User management
• Template management
• Variables integration
• Send email
• Head tags
• Duplicate template
• Recover password
• Category of template
• Attachments
• Email with a click
• Automated tests
• Images management

Next major releases

• Multiple email accounts
• Visual builder
• Token permissions
• Generate token from admin panel
• Calendars invitation
• Preview in real time

Supported tags

Head

• mj-attributes
• mj-breakpoint
• mj-font
• mj-html-attributes
• mj-preview
• mj-style
• mj-title

Body

• Accordion
• Button
• Carousel
• Column
• Divider
• Group
• Hero
• Image
• Navbar
• Raw
• Section
• Social
• Spacer
• Table
• Text
• Wrapper