Transactional Emails about vendure HOT 3 CLOSED

Implementation proposal

1. Various events are generated by the Vendure Server and published via the EventBus (#40).
2. EmailEventHandlers listen for a specific event and convert these events into EmailContext instances, which contain the information required to generate and send an email.
3. The EmailGenerator takes an EmailContext object and uses the data to generate the body of the email based on a template. There will be standard, built-in templates but there must be a very simple way to provide custom templates since this will be needed by most shops.
4. The output of the EmailGenerator is a GeneratedEmail instance, which is just the EmailContext with the addition of a body string.
5. The GeneratedEmail is passed to the EmailTransport which actually sends the email to the recipient.

from vendure.

Templating

Templates should use a templating language to allow the actual data (customer name, order contents etc) to be interpolated when generating the HTML.

The specific quirks of designing emails (needs tables for layout, inline styles etc) suggest the use of a email framework. The main contenders are:

• MJML
• Foundation for Emails
• Comparison of MMJL and Foundation

I like the look of MJML. However, it does not support templating features itself (interpolating variables, for loops) so we would need an additional templating layer which generates the MJML, which is then compiled into HTML. Handlebars is an obvious choice for the templating part.

from vendure.

Current status: The infrastructure is all there for transactional emails now. The only thing missing is the definition of all the email types (right now there is only "order confirmation" and "email verification".

The plan is to create config and templates for the other types as development of the rest of the UI / shopfront progresses. So I'll close this issue now since the foundation is complete.

from vendure.