[Feature] Add preprocessor support

[thetutlage]

From @watzon on November 8, 2017 21:15

Laravel gives us the ability to have blade templates that take blade/markdown and turn it into an HTML email template. This saves some major headache when it comes to making emails beautiful and responsive. It would be awesome if Adonis had the same functionality.

Proposal

Add a markdown method to the Mailer and some built in components that get added to edge templates. Developers should ideally be able to use the markdown method to render an edge template, or send plain markdown which will be parsed into valid email HTML before being sent.

Example Code

<!-- resources/views/emails/shipped.edge -->

@component('mail.message')
# Order Shipped

Your order has been shipped!

@component('mail.button', url = {{ order.viewUrl }})
View Order
@endcomponent

Thanks,<br>
{{ Config('appName') }}
@endcomponent

// app/Controllers/Http/OrdersController.js

await Mail.markdown('emails.shipped', Order.toJSON(), (message) => {
  message.subject('Hello ...')
  message.from('foo@bar.com')
  message.to('baz@bar.com')
})

Reference

https://laravel.com/docs/5.5/mail#markdown-mailables
https://www.npmjs.com/package/markdown
https://www.npmjs.com/package/markdown-it

Copied from original issue: adonisjs/mail#15

[thetutlage]

From @RomainLanz on November 8, 2017 21:33

Hey @watzon! 👋

I don't think adding a built-in Markdown support is a great idea. This would mean we choose to use Markdown over other simple text engine (like Asciidoc - that we heavy use in our documentation).

Why not make the MailSender class Macroable so you could add methods to it and handle this with a community package? This will avoid Adonis to take a strong decision and let the developer choose the tool he wants to use.

Concerning the idea of having built-in components I also think it'd be better to have a community package that handles that.

Then you could simply install it and use it with a syntax like the code below.

@component('@myPackage::mail.button', url = {{ order.viewUrl }})
  View Order
@endcomponent

(A similar syntax was proposed on the 4.0 Roadmap - section adonis-translator (new))

[thetutlage]

From @watzon on November 8, 2017 21:36

@RomainLanz I think making the MailSender class Macroable would be a fine idea. If a community package could handle this then that would work as well.

[thetutlage]

From @RomainLanz on November 8, 2017 21:40

Also, using community package instead of having built-in components will let the community create many packages with many designs (Material, Bootstrap, Foundation, Semantic-UI, etc.).

Same goes for MailSender that will be able to handle other templating like MJML or Foundation Email.

[thetutlage]

From @watzon on November 8, 2017 21:42

I like that idea

[thetutlage]

From @RomainLanz on November 8, 2017 22:13

Cool, let's wait to see the opinion of @thetutlage on this.

[thetutlage]

So Adonis mail doesn't have any idea on how the view engine works, it just uses Edge. My plan is to let users add preprocessors to Edge, so it will be like this

Raw edge

const edge = require('edge.js')
edge.use('mail/*.edge', function (content) {
  // return parsed content
})

In Adonis

const View = use('View')
View.use('mail/*.edge', function (content) {
  // return parsed content
})

[thetutlage]

Idea dropped. Closing