You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[![Product Name Screen Shot][product-screenshot]](https://example.com)
68
-
69
-
There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.
63
+
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
70
64
71
-
Here's why:
72
-
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
73
-
* You shouldn't be doing the same tasks over and over like creating a README from scratch
74
-
* You should element DRY principles to the rest of your life :smile:
65
+
This is a module maded it for Parse Server and an easy solution to send emails via SMTP with templates in HTML.
75
66
76
-
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue with the tag.
77
-
78
-
A list of commonly used resources that I find helpful are listed in the acknowledgements.
67
+
We recomend to use the [Cerberus](https://github.com/TedGoas/Cerberus) for the email templates.
79
68
80
69
### Built With
81
-
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
82
-
*[Bootstrap](https://getbootstrap.com)
83
-
*[JQuery](https://jquery.com)
84
-
*[Laravel](https://laravel.com)
70
+
71
+
*[Nodemailer](https://nodemailer.com)
85
72
86
73
87
74
@@ -91,45 +78,108 @@ This section should list any major frameworks that you built your project using.
91
78
This is an example of how you may give instructions on setting up your project locally.
92
79
To get a local copy up and running follow these simple example steps.
93
80
94
-
### Prerequisites
95
-
96
-
This is an example of how to list things you need to use the software and how to install them.
97
-
* npm
98
-
```sh
99
-
npm install npm@latest -g
100
-
```
101
-
102
81
### Installation
103
82
104
-
1. Get a free API Key at [https://example.com](https://example.com)
2. In your Parse Server add the configuration of your email account
94
+
112
95
```
113
-
4. Enter your API in `config.js`
114
-
```JS
115
-
constAPI_KEY='ENTER YOUR API';
96
+
var api = new ParseServer({
97
+
...
98
+
emailAdapter: {
99
+
module: 'parse-smtp-template',
100
+
options: {
101
+
port: 587,
102
+
host: "smtp.mail.com",
103
+
user: "name@domain.com",
104
+
password: "SecurePassword",
105
+
fromAddress: 'app@domain.com',
106
+
107
+
// Optional Parameters
108
+
template: true,
109
+
templatePath: "views/templates/main.html",
110
+
passwordSubject: "A custom password recovery Subject",
111
+
confirmSubject: "A custom email confirmation Subject"
112
+
}
113
+
}
114
+
})
116
115
```
116
+
> Now is ready to use it!
117
117
118
+
3. (Optional) Config your email template
118
119
120
+
The templates have access to 4 parameters to send
121
+
* link
122
+
* username
123
+
* appName
124
+
* subject
125
+
126
+
To use it you only need to write ${parameter} to use it on the email
127
+
128
+
**IMPORTANT** -- **All the HTML file need to use only double quotes to avoid problems**
119
129
120
130
<!-- USAGE EXAMPLES -->
121
131
## Usage
122
132
123
-
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
124
-
125
-
_For more examples, please refer to the [Documentation](https://example.com)_
133
+
To use a custome template is necessary to select the correct file.
0 commit comments