README
LSK.js – mailer
@lskjs/mailer – LSK module for send and receive emails.
Table of contents
⌨️ Install
# yarn
yarn i @lskjs/mailer @lskjs/db @lskjs/server-api bluebird lodash
# npm
npm i @lskjs/mailer @lskjs/db @lskjs/server-api bluebird lodash
Пример использования
mailer.send({
to: 'example@gmail.com',
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.
import Template from './template';
export default class Recovery extends Template {
body({ params }) {
return `
<body>
Ваш новый пароль: ${params.password}
</body>`;
}
}
У шаблонов есть дефолтные опции
Поле | Описание --- | --- subject | Тема письма text | Текст письма
📖 License
This project is licensed under the MIT License - see the LICENSE file for details
👥 Contributors
Igor Suvorov 💻 🎨 🤔 |
👏 Contributing
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b features/fooBar
) - Commit your changes (
git commit -am 'feat(image): Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request