From ed6fe77a8745afe5f560b954e32155de8f942beb Mon Sep 17 00:00:00 2001 From: dan-nyanko Date: Mon, 29 Aug 2016 11:10:33 -0400 Subject: [PATCH] update README.md --- README.md | 67 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index fe339c7..1aac622 100644 --- a/README.md +++ b/README.md @@ -18,38 +18,47 @@ In addition, you also need to configure the **templates** you want to use. You must provide at least a plain-text version for each template. The html versions are optional. ```js - ...otherOptions, - emailAdapter: { - module: 'parse-server-amazon-ses-email-adapter', - options: { - // The address that your emails come from - fromAddress: 'Your Name '', - accessKeyId: 'Your AWS IAM Access Key ID', - secretAccessKey: 'Your AWS IAM Secret Access Key', - region: 'Your AWS Region', - // The template section - templates: { - passwordResetEmail: { - subject: 'Reset your password', - pathPlainText: resolve(__dirname, 'path/to/templates/password_reset_email.txt'), - pathHtml: resolve(__dirname, 'path/to/templates/password_reset_email.html'), - callback: (user) => { return { firstName: user.get('firstName') }} +//...otherOptions, +emailAdapter: { + module: 'parse-server-amazon-ses-email-adapter', + options: { + // The address that your emails come from + fromAddress: 'Your Name ', + accessKeyId: 'Your AWS IAM Access Key ID', + secretAccessKey: 'Your AWS IAM Secret Access Key', + region: 'Your AWS Region', + // The template section + templates: { + passwordResetEmail: { + subject: 'Reset your password', + pathPlainText: resolve(__dirname, 'path/to/templates/password_reset_email.txt'), + pathHtml: resolve(__dirname, 'path/to/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: resolve(__dirname, 'path/to/templates/verification_email.txt'), - pathHtml: resolve(__dirname, 'path/to/templates/verification_email.html'), - callback: (user) => { return { firstName: user.get('firstName') }} + }, + verificationEmail: { + subject: 'Confirm your account', + pathPlainText: resolve(__dirname, 'path/to/templates/verification_email.txt'), + pathHtml: resolve(__dirname, 'path/to/templates/verification_email.html'), + callback: (user) => { + return { + firstName: user.get('firstName') + } + } // Now you can use {{firstName}} in your templates - }, - customEmailAlert: { - subject: 'Urgent notification!', - pathPlainText: resolve(__dirname, 'path/to/templates/custom_alert.txt'), - pathHtml: resolve(__dirname, 'path/to/templates/custom_alert.html'), - } - } + }, + customEmailAlert: { + subject: 'Urgent notification!', + pathPlainText: resolve(__dirname, 'path/to/templates/custom_alert.txt'), + pathHtml: resolve(__dirname, 'path/to/templates/custom_alert.html'), + } + } } +} ```