Nanobot: Polygonal Mascot

    @lskjs/mailer

    2.84.11 • Public • Published

    LSK.js – mailer

    @lskjs/mailer – LSK module for send and receive emails.

    LSK logo NPM version NPM downloads NPM Dependency count Have TypeScript types Have tree shaking NPM Package size Package size Ask us in Telegram


    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

    1. Fork it (https://github.com/yourname/yourproject/fork)
    2. Create your feature branch (git checkout -b features/fooBar)
    3. Commit your changes (git commit -am 'feat(image): Add some fooBar')
    4. Push to the branch (git push origin feature/fooBar)
    5. Create a new Pull Request

    📮 Any questions? Always welcome :)

    Install

    npm i @lskjs/mailer

    DownloadsWeekly Downloads

    48

    Version

    2.84.11

    License

    MIT

    Unpacked Size

    109 kB

    Total Files

    33

    Last publish

    Collaborators

    • isuvorov
    • yukioru
    • andru_xa
    • natavts
    • blacklightburn
    • ga2mer
    • iburey
    • kafkae
    • sophiyabezruk
    • vladik_deniska
    • finalgetname