gators

Free and easy texting framework for node using SMS gateways.

import Gators from 'gators'

const emailAuthentication = {
  account: { /* ... */ },
  smtp: { /* ... */ },
  imap: { /* ... */ }
}
const gators = new Gators(emailAuthentication)

gators.on('connected', () => console.log('connected!'))

gators.on('message', (details, sendReply) => {
  const text = details.text.toLowerCase()
  console.log(`> Received message: ${text}`)

  // send reply
  if (text === 'ping') sendReply('pong')
})

gator.on('error', (err: any) => console.log(err))

gator.connect()

Getting Started

DISCLAIMER: This package has not been tested with all SMS gateway providers nor phone operating systems.

For a list of supported providers, see SUPPORT.md.

For instructions on how you can contribute, see CONTRIBUTE.md.

This is a module from npm.

Before installing, download and install node.js and npm.

Install gators

$ npm i -s gators
# or yarn add gators

Create auth file from template

$ touch auth.js

auth.js

module.exports = {
  account: {
    user: '****@****.com',
    pass: '$!J$#LK#K'
  },
  smtp: {
    host: 'smtp.*****.com',
    port: 465,
    secure: true
  },
  imap: {
    host: 'imap.*****.com',
    port: 993,
    secure: true
  }
}

Manually test with one of the included examples

$ ts-node ./examples/ping

Built With

• node-imap - IMAP Client
• Nodemailer - SMTP Client
• Mailparser - Elegantly parse emails
• html-to-text - HTML interpreter

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Coding Style

Authors

• jdtzmn - Initial work - jdtzmn

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• This amazing README template.
• NodeICO for the npm badge.
• gitignore.io for .gitignore