Socket
Socket
Sign inDemoInstall

parse-smtp-adapter

Package Overview
Dependencies
198
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    parse-smtp-adapter

Send custom emails from parse with SMTP access


Version published
Weekly downloads
3
Maintainers
1
Install size
19.7 MB
Created
Weekly downloads
 

Readme

Source

Parse Server SMTP Email Adapter

This fork uses upgraded dependencies with some security fixes

With this adapter you can send email for reset password and email verification in parse with SMTP access and custom templates.

Installation

Install npm module in your parse server project

$ npm install --save parse-smtp-adapter

Use

In the configuration of your parse server you must pass parse-smtp-adapter as email adapter and set your SMTP access for send emails also the path to your jade template and its less file.

This is an example using parse server as express module:

"use strict";

const Express = require('express');
const ParseServer = require('parse-server').ParseServer;

const app = Express();
const APP_PORT = 1337;

let options = {

};

let api = new ParseServer({
	appName: "Parse Test",
	appId: "12345",
	masterKey: "abcde12345",
	serverURL: "http://localhost:1337/parse",
	publicServerURL: "http://localhost:1337/parse",
	databaseURI: "mongodb://user:pass@host:27017/parse",
	port: APP_PORT,
	//This is the config for email adapter
	emailAdapter: {
		module: "parse-smtp-adapter",
		options: {
			fromAddress: 'your@sender.address',
			user: 'email@email.com', //#"required for service SMTP"
			password: 'AwesomePassword',  //#"required for service SMTP"
			host: 'your.smtp.host',  //#"required for service SMTP"
			isSSL: true, //True or false if you are using ssl  //#"required for service SMTP"
			port: 465, //SSL port or another port //#"required for service SMTP"
			name: 'your domain name', //  optional, used for identifying to the server 
			//Somtimes the user email is not in the 'email' field, the email is search first in
			//email field, then in username field, if you have the user email in another field
			//You can specify here
			emailField: 'username', 
			templates: {
				templateRoot: __dirname + '/views/email/template/',
				resetPassword: {
					template: 'reset-password',
				},
				verifyEmail: {
					template: 'verify-email',
				}
			}
		}
	}
});

/**
 * Parse Server endpoint
 */
app.use('/parse', api);

app.listen(APP_PORT, function () {
	console.log(`Parse Server Ready and listening on port ${APP_PORT}`);
});

Template

The path you pass to the email adapter must be a directory and not a file, this path must contain 2 mandatory files html.pug and subject.pug you can do your template as you like with the CSS rules that emails supports in the template you can use 3 variables:

  • appName //This is the name of your parse app
  • link //This is the link for reset the password
  • user //This is a Parse object with the current user, so you can use any field in your User class of parse for example the user name #{user.get('username')}

in templates use link(rel="stylesheet", href="/css/style.css", data-inline) in the of your html and it uses your css from rootTemplateFolder/css/app.css

Example

html.pug
doctype html
html
  head
    block head
      meta(charset="utf-8")
      meta(name="viewport", content="width=device-width")
      meta(http-equiv="X-UA-Compatible", content="IE=edge")
      meta(name="x-apple-disable-message-reformatting")
      title= subject
      link(rel="stylesheet", href="css/reset.css", data-inline)
  body
    p your reset password link is: #{link},
subject.pug
=`${appName}: Reset password`
Folder structure
.
├── app.js
└── templateRoot
    ├── reset-password
        ├── html.pug
        └── subject.pug
	├── verify-email
        ├── html.pug
        └── subject.pug
	└── css
        ├── reset.css
		└── verify.css

License MIT

Keywords

FAQs

Last updated on 09 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc