parse-server-email-with-template v0.0.4

Parse Server Generic Email Adapter

This is a parse server email adapter that will route all emails sent by parse server through general email providers, like gmail, yahoo etc. Emails can include password resets, verification emails and custom emails sent through cloud code.

Read more here: https://github.com/parse-community/parse-server.

Compatibility

Tested with Parse Server v2.7.0

Installation

$ npm install --save parse-server-email-with-template

Usage

In the configuration of your parse server you must pass parse-server-email-with-template as your email adapter. You must also set your service name (eg: Gmail) along with the email id and password.

This is an example using parse server as an express module:

Without SMTP

var parse = new ParseServer({
   //...
   emailAdapter: {
      module: "parse-server-email-with-template",
      options: {
         service: "Gmail" // Could be anything like yahoo, hotmail, etc, Full list - see below 
         email: "email@gmail.com",
         password: "Your password"
          templates: {
      passwordResetEmail: {
        subject: 'Reset your password',
        pathPlainText: path.resolve(__dirname, 'mail/templates/password_reset_email.txt'),
        pathHtml: path.resolve(__dirname, 'mail/templates/password_reset_email.html'),
        callback: (user) => { return { firstName: user.get('firstName') }}
        // Now you can use {{firstName}} in your templates
      },
      verificationEmail: {
        subject: 'Confirm your account',
        pathPlainText: path.resolve(__dirname, 'mail/templates/verifyEmail/text'),
        pathHtml: path.resolve(__dirname, 'mail/templates/verifyEmail/html'),
        callback: (user) => { return { firstName: user.get('firstName') }}
        // Now you can use {{firstName}} in your templates
      },
      customEmailAlert: {
        subject: 'Urgent notification!',
        pathPlainText: path.resolve(__dirname, 'mail/templates/custom_alert.txt'),
        pathHtml: path.resolve(__dirname, 'mail/templates/custom_alert.html'),
      }
    }
      }
   }
});

With SMTP

var parse = new ParseServer({
   //...
   emailAdapter: {
      module: "parse-server-email-with-template",
      options: {
        service: "SMTP", // Could be anything like yahoo, hotmail, etc, Full list - see below 
     email: "email@gmail.com",
     password: "Your password",
     host: 'smtp.gmail.com',  //#"required for service SMTP"
     isSSL: true, //True or false if you are using ssl  //#"required for service SMTP"
     port: 465,
          templates: {
      passwordResetEmail: {
        subject: 'Reset your password',
        pathPlainText: path.resolve(__dirname, 'mail/templates/password_reset_email.txt'),
        pathHtml: path.resolve(__dirname, 'mail/templates/password_reset_email.html'),
        callback: (user) => { return { firstName: user.get('firstName') }}
        // Now you can use {{firstName}} in your templates
      },
      verificationEmail: {
        subject: 'Confirm your account',
        pathPlainText: path.resolve(__dirname, 'mail/templates/verifyEmail/text'),
        pathHtml: path.resolve(__dirname, 'mail/templates/verifyEmail/html'),
        callback: (user) => { return { firstName: user.get('firstName') }}
        // Now you can use {{firstName}} in your templates
      },
      customEmailAlert: {
        subject: 'Urgent notification!',
        pathPlainText: path.resolve(__dirname, 'mail/templates/custom_alert.txt'),
        pathHtml: path.resolve(__dirname, 'mail/templates/custom_alert.html'),
      }
    }
      }
   }
});

Complete list of providers supported by this plugin

• Gmail
• Yahoo
• 126
• 163
• 1und1
• AOL
• DebugMail
• DynectEmail
• FastMail
• GandiMail
• Godaddy
• GodaddyAsia
• GodaddyEurope
• hot.ee
• iCloud
• Hotmail
• mail.ee
• Mail.ru
• Maildev
• Mailgun
• Mailjet
• Mailosaur
• Mandrill
• Naver
• OpenMailBox
• Outlook365
• Postmark
• QQ
• QQex
• SendCloud
• SendGrid
• SendinBlue
• SES
• SES-US-EAST-1
• SES-US-WEST-2
• SES-EU-WEST-1
• Sparkpost
• Tipimail
• Yandex
• Zoho
• qiye.aliyun
• SMTP

Credits

https://github.com/collinbrewer/parse-server-amazon-ses-adapter

https://github.com/nodemailer/nodemailer

https://github.com/parse-community/parse-server

License MIT