https://github.com/lskjs/lsk-mailer
LSK Email sender and Email templates module
https://github.com/lskjs/lsk-mailer
isomorphic javascript lsk mailer module nodejs react universal
Last synced: about 2 months ago
JSON representation
LSK Email sender and Email templates module
- Host: GitHub
- URL: https://github.com/lskjs/lsk-mailer
- Owner: lskjs
- License: mit
- Created: 2017-05-05T13:45:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-07T14:50:39.000Z (about 6 years ago)
- Last Synced: 2025-01-17T23:30:24.539Z (4 months ago)
- Topics: isomorphic, javascript, lsk, mailer, module, nodejs, react, universal
- Language: JavaScript
- Homepage: https://lsk.mgbeta.ru/demo/mailer
- Size: 239 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# LSK Mailer
## Mailer
Пример использования
```javascript
mailer.send({
to: '[email protected]',
template: 'recovery',
params: {
user: {
profile: {
firstName: 'Igor',
lastName: 'Suvorov',
},
},
password: '123456',
},
options: {
subject: 'Восстановление пароля',
},
});
```
Поле | Описание | Required
--- | --- | --- |
to | email | true
template | Название шаблона | true
params | Параметры для шаблона | false
options | Опции для письма | false
Опции для отправки письма можно указать в шаблонах.
Шаблоны писем находятся в папке templates.
## Templates
Пример использования
template.js - Основной шаблон
Для создания нового шаблона нужно создать класс и отнаследоваться
от tempalte.js.
```javascript
import Template from './template';
export default class Recovery extends Template {
body({ params }) {
return `
Ваш новый пароль: ${params.password}
`;
}
}
```
У шаблонов есть дефолтные опции
Поле | Описание
--- | ---
subject | Тема письма
text | Текст письма