hubot-mail

1.2.0 • Public • Published

hubot-mail

Build Status Dependency Status

A Hubot script for preparing messages that will be delivered upon the recipient's next activity (i.e. joins room, enters a message).

See src/mail.coffee for full documentation.

Installation via NPM

  1. Install the hubot-mail module as a Hubot dependency by running:

    npm install --save hubot-mail
    
  2. Enable the module by adding the hubot-mail entry to your external-scripts.json file:

    [
        "hubot-mail"
    ]
  3. Run your bot and see below for available config / commands

Configuration

Variable Default Description
HUBOT_MAIL_KEY _mail The unique key used for persistence (storing/retrieving mails from memory)

Commands

Command Listener ID Description
hubot mail recipient message mail.new Sends a message to recipient when found available
hubot unmail [recipient] mail.cancel Deletes all mail sent by you. Optionally, if recipient is specified, only mail sent to recipient by you will be deleted

Sample Interaction

user1>> hubot mail user1 Hello world!
hubot>> user1: Are you sure you want to send a mail to yourself? Sad.

Package Sidebar

Install

npm i hubot-mail

Weekly Downloads

19

Version

1.2.0

License

MIT

Last publish

Collaborators

  • mrsaints