Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

@atlas.js/nodemailer

2.1.0 • Public • Published

@atlas.js/nodemailer

A nodemailer-based mailing service for @atlas.js.

Installation

npm i @atlas.js/nodemailer

Usage

import { Atlas } from '@atlas.js/atlas'
import * as Nodemailer from '@atlas.js/nodemailer'
 
const atlas = new Atlas({
  config: {
    services: {
      email: {
        // The transport module to be used
        transport: require('nodemailer-ses-transport'),
        // Alternatively, just pass the module's name
        transport: 'nodemailer-ses-transport',
        // These options are passed to the transport module unmodified, so go
        // read the transport's docs as to what you can set here!
        options: {},
        // An array of plugins to add to nodemailer
        plugins: [{
          // Nodemailer's event to which the plugin should be added
          event: 'compile',
          // The plugin module to use
          plugin: require('nodemailer-html-to-text'),
          // Alternatively, just pass the module's name
          plugin: 'nodemailer-html-to-text',
          // These options are passed directly to the plugin function
          options: {},
        }]
      }
    }
  }
})
atlas.service('email', Nodemailer.Service)
await atlas.start()
 
// The email service is now available here:
atlas.services.email

In addition to having the standard, callback-based sendMail() function available, you can use a custom async send() method:

await atlas.services.email.send({ to: 'test@example.com' })

License

See the LICENSE file for information.

Keywords

none

install

npm i @atlas.js/nodemailer

Downloadsweekly downloads

83

version

2.1.0

license

BSD-3-Clause

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability