https://github.com/Blechlawine/medusa-plugin-nodemailer

https://github.com/Blechlawine/medusa-plugin-nodemailer

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Blechlawine/medusa-plugin-nodemailer
• Owner: Blechlawine
• License: mit
• Created: 2021-12-06T10:26:26.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-10T20:37:06.000Z (about 2 years ago)
• Last Synced: 2024-07-17T22:30:30.243Z (6 months ago)
• Language: JavaScript
• Size: 298 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-medusajs - node mailer - square)  (Uncategorized / Uncategorized)

README

        
# Medusa-plugin-nodemailer

A notification service based on nodemailer

## Details

It uses the email-templates npm package and pug for rendering html emails. Documentation for this can be found here: [https://github.com/forwardemail/email-templates](https://github.com/forwardemail/email-templates)

## Available options (default configuration)

```js

{

    fromEmail: "[email protected]",

    // this object is input directly into nodemailer.createtransport(), so anything that works there should work here

    // see: https://nodemailer.com/smtp/#1-single-connection and https://nodemailer.com/transports/

    transport: {

        sendmail: true,

        path: "/usr/sbin/sendmail",

        newline: "unix",

    },

    // an example for an office365 smtp transport:

    // {

    //     host: "smtp.office365.com",

    //     port: 587,

    //     secureConnection: false,

    //     auth: {

    //         user: process.env.EMAIL_SENDER_ADDRESS,

    //         pass: process.env.EMAIL_SENDER_PASS,

    //     },

    //     tls: {

    //         ciphers: "SSLv3",

    //     },

    //     requireTLS: true,

    // },

    // this is the path where your email templates are stored

    emailTemplatePath: "data/emailTemplates",

    // this maps the folder/template name to a medusajs event to use the right template

    // only the events that are registered here are subscribed to

    templateMap: {

        // "eventname": "templatename",

        "order.placed": "orderplaced",

    },

}

```