Skip to content
This repository has been archived by the owner on Dec 17, 2022. It is now read-only.
/ mailmagic Public archive

Convert plain text Joomla emails into beautiful, HTML emails

License

Notifications You must be signed in to change notification settings

nikosdion/mailmagic

Repository files navigation

MailMagic

Convert plain text Joomla emails into beautiful, HTML emails

What does it do?

Converts your Joomla plain text emails in rich, HTML emails using your custom templates.

Additionally, it can create a plain text representation of your HTML-only emails for clients who prefer to receive plain-text email only.

Features

  • Convert plain old text emails into HTML.
  • Custom templates using HTML files. No more fooling around with the WYSIWYG editor.
  • Image inlining.
  • Tag substitution.

Download

I primarily wrote this for my own, personal use. I do publish occasional pre-built Joomla installation packages and make them available through my GitHub repository's Releases page.

How to use

In its simplest, install and enable the plugin. All your plain text emails are now converted to HTML.

For further information please check the documentation.

Remember that e-mails are NOT web pages

Each mail client may render your e-mail slightly different and may disable entire features you're used to using with regular HTML and CSS in web pages. Forget about CSS grid, absolute / relative positioning, flexbox and so on. You'll have to use tables like it's 1998 all over again. Images, especially background ones, may display in a weird way or not at all. Dark mode support will be wonky, if it even works, depending on the mail client. Generally speaking, if something you do in HTML and CSS doesn't work it's not MailMagic's fault, it's how the mail client parses and displays the email. You have been warned.

Support and contributions

This is a project I maintain on my spare time. Having a family and business doesn't leave me with much spare time. Please try to be concise and considerate when filing a GitHub issue.

If you are making a feature request please keep in mind not just that my time is limited but also that your unique use case may not be as universal as you think. What is an obvious omission for you may not be something most people want, or it might require changes to an extent that it makes the software hard to use for everyone else.

If you want to contribute code feel free to make a Pull Request (PR) on this repository. Kindly note that making a PR does not guarantee acceptance without changes or even at all. Please file a GitHub issue beforehand to let me know that you want to contribute code and give me a short explanation of what and why you want to implement. I'd rather spend five more minutes replying to you than you wasting half a day to implement a feature I am not willing to merge.

Finally, be advised that I am rather direct in my communication. I am neither angry nor aggressive towards you. I do make an effort not to come across as an a-hole but after a certain point it's just the way my brain is wired. Thank you for your understanding!

Building the package

If you want to go through the build process you will need to have the following tools:

  • A command line environment. Using Bash under Linux / Mac OS X works best.
  • A PHP CLI binary in your path
  • Phing installed account-wide on your machine
  • Command line Git executables

You will also need the following path structure inside a folder on your system

You will need to use the exact folder names specified here.

Go into the build directory of this repository.

Create a dev release installation package with

	phing git

The installable ZIP file is stored in the release directory which will be created inside the repository's root.

About

Convert plain text Joomla emails into beautiful, HTML emails

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published