Package Exports

hubot-mail

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hubot-mail) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hubot-mail

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

Install the hubot-mail module as a Hubot dependency by running:
```
npm install --save hubot-mail
```
Enable the module by adding the hubot-mail entry to your external-scripts.json file:
```
[
    "hubot-mail"
]
```
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.