[v5] How to add a new Mail driver? (PostmarkApp)

[ivan-prats]

Hey guys! First time posting so please forgive me if i'm not following some guideling.

I love PostmarkApp and I also love the Adonis v5 Mailer package. So I wouldn't mind looking into adapting a driver for it.

I did found this docs section on the legacy 3.2 Adonis version on how to extend drivers, even with an example with PostmarkApp! Introducing the nodemailer-postmark-transport package.

But being docs of a legacy release: I did prefer to ask first about it before trying to more or less follow it. Is there any docs with more updated info? Or does that doc section remain more or less true nowadays?

I could also try piecing that doc section togheter with the current Mail Driver syntax (of the Mailgun Driver for example?)

Any helpful hint on where to start looking into it would be great. And if I manage to do it: I will be sure to post about it online and share it. Thanks!

[thetutlage]

Hello 👋

Yup would love to have a driver for postmark. I am sure if they have an endpoint that accepts a mime payload. If they do, then it can be an exact copy of the mailgun driver.

[ivan-prats]

I've been toying with this, but I'm finding it really hard to know where to extend the MailManager with the new PostmarkDriver in Adonis v5.

Looking through the code base I guess I have to do something like:

MailManager.extend('postmark', () => new PostmarkDriver({}, Logger))

But I'm obviously doing something wrong extending the Driver because I get this message:

# This is in the repl. After creating a "Testing" Mailer than only sends a "<p>hello</p>" message
> loadMailers()
> await new mailers.Testing().send()
Uncaught Error: "postmark" driver is not supported by "MailManager"

Where should I run the first code to extend the MailDriver? In the ./start folder? As a command and run it somewhere? Maybe I have to do something else on top of extending it?

[thetutlage]

I created a sample repo here showing how to extend the Mailer to add new drivers https://github.com/thetutlage/postmark-driver-app

[thetutlage]

Regarding the packages to use. I am okay using the official client of PostMark https://github.com/wildbit/postmark.js and build on top of it. Couple of things to make sure

• We are able to attach files
• We are able to embed files using CID
• We are able to define the content for plain text and the Apple watch view

[ivan-prats]

Files attachements and embeding files using CID will be fine!

Plain text content is fine for sure:

But I'm finding it hard to find documentation / requirements about sending emails taking into account that it's an Apple Watch? Does it work like a normal Plain Text email? I can't find anything for apple-watch-specific-formats

[thetutlage]

Yup, looking at their API docs, it looks like there is no support for watch html and that is okay, we can write a note about it in the docs. The main idea was to have 100% support for what can be achieved with other drivers and watch html is not that of a big deal.

Generally it is represented as follows inside a MIME string. https://www.litmus.com/blog/how-to-send-hidden-version-email-apple-watch/